|
ContentBox Core API 1.6.0 | ||||
FRAMES |
WEB-INF.cftags.componentcontentbox.model.exporters.DataExporter
public class DataExporter
******************************************************************************* ContentBox - A Modular Content Platform Copyright 2012 by Luis Majano and Ortus Solutions, Corp www.gocontentbox.org | www.luismajano.com | www.ortussolutions.com ******************************************************************************* Apache License, Version 2.0 Copyright Since [2012] [Luis Majano and Ortus Solutions,Corp] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ******************************************************************************* Exporter for Data-based content
Property Summary | ||||
---|---|---|---|---|
Type | Property & Description | Default | Serializable | Required |
any
|
content
Attributes: |
|
true
|
false
|
string
|
displayName
Attributes: |
|
true
|
false
|
string
|
fileName
Attributes: |
|
true
|
false
|
string
|
format
Attributes: |
|
true
|
false
|
any
|
log
Attributes:
|
|
true
|
false
|
numeric
|
priority
Attributes: |
|
true
|
false
|
Constructor Summary | |
---|---|
init()
Constructor |
Method Summary | |
---|---|
any |
GETCONTENT()
|
string |
GETDISPLAYNAME()
|
string |
GETFILENAME()
|
string |
GETFORMAT()
|
any |
GETLOG()
|
numeric |
GETPRIORITY()
|
DataExporter |
SETCONTENT(any content)
|
DataExporter |
SETDISPLAYNAME(string displayName)
|
DataExporter |
SETFILENAME(string fileName)
|
DataExporter |
SETFORMAT(string format)
|
DataExporter |
SETLOG(any log)
|
DataExporter |
SETPRIORITY(numeric priority)
|
string |
getName()
Gets the name of the exporter |
numeric |
getTotal()
Gets "total" based on content type |
boolean |
isValid()
Determines if exporter is valid based on validation criteria |
array |
validate()
Custom validator for this exporter |
Methods inherited from class WEB-INF.cftags.component |
---|
None
|
Constructor Detail |
---|
public init()
Property Detail |
---|
any content
default
- serializable
- truerequired
- falsestring displayName
default
- serializable
- truerequired
- falsestring fileName
default
- serializable
- truerequired
- falsestring format
default
- serializable
- truerequired
- falseany log
inject
- logbox:logger:{this}required
- falseserializable
- truedefault
- numeric priority
default
- serializable
- truerequired
- falseMethod Detail |
---|
public any GETCONTENT()
public string GETDISPLAYNAME()
public string GETFILENAME()
public string GETFORMAT()
public any GETLOG()
public numeric GETPRIORITY()
public DataExporter SETCONTENT(any content)
content
public DataExporter SETDISPLAYNAME(string displayName)
displayName
public DataExporter SETFILENAME(string fileName)
fileName
public DataExporter SETFORMAT(string format)
format
public DataExporter SETLOG(any log)
log
public DataExporter SETPRIORITY(numeric priority)
priority
public string getName()
getName
in interface
ICBExporter
public numeric getTotal()
getTotal
in interface
ICBExporter
public boolean isValid()
isValid
in interface
ICBExporter
public array validate()
validate
in interface
ICBExporter
|
ContentBox Core API 1.6.0 | ||||
FRAMES |