ContentBox Core API 1.6.0

contentbox.model.exporters
Class DataExporter

WEB-INF.cftags.component
        extended by contentbox.model.exporters.DataExporter
All Implemented Interfaces:
ICBExporter

public class DataExporter
extends WEB-INF.cftags.component

******************************************************************************* 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:
  • inject = logbox:logger:{this}
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

init

public init()
Constructor

Property Detail

content

any content

Attributes:
default -
serializable - true
required - false

displayName

string displayName

Attributes:
default -
serializable - true
required - false

fileName

string fileName

Attributes:
default -
serializable - true
required - false

format

string format

Attributes:
default -
serializable - true
required - false

log

any log

Attributes:
inject - logbox:logger:{this}
required - false
serializable - true
default -

priority

numeric priority

Attributes:
default -
serializable - true
required - false

Method Detail

GETCONTENT

public any GETCONTENT()


GETDISPLAYNAME

public string GETDISPLAYNAME()


GETFILENAME

public string GETFILENAME()


GETFORMAT

public string GETFORMAT()


GETLOG

public any GETLOG()


GETPRIORITY

public numeric GETPRIORITY()


SETCONTENT

public DataExporter SETCONTENT(any content)

Parameters:
content

SETDISPLAYNAME

public DataExporter SETDISPLAYNAME(string displayName)

Parameters:
displayName

SETFILENAME

public DataExporter SETFILENAME(string fileName)

Parameters:
fileName

SETFORMAT

public DataExporter SETFORMAT(string format)

Parameters:
format

SETLOG

public DataExporter SETLOG(any log)

Parameters:
log

SETPRIORITY

public DataExporter SETPRIORITY(numeric priority)

Parameters:
priority

getName

public string getName()
Gets the name of the exporter

Specified by:
getName in interface ICBExporter

getTotal

public numeric getTotal()
Gets "total" based on content type

Specified by:
getTotal in interface ICBExporter

isValid

public boolean isValid()
Determines if exporter is valid based on validation criteria

Specified by:
isValid in interface ICBExporter

validate

public array validate()
Custom validator for this exporter...any rules can be applied

Specified by:
validate in interface ICBExporter

ContentBox Core API 1.6.0