|
ContentBox Core API 1.6.0 | ||||
FRAMES |
WEB-INF.cftags.componentcontentbox.model.exporters.FileExporter
public class FileExporter
******************************************************************************* 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 file-based content
Property Summary | ||||
---|---|---|---|---|
Type | Property & Description | Default | Serializable | Required |
string
|
directory
Attributes: |
|
true
|
false
|
string
|
displayName
Attributes: |
|
true
|
false
|
string
|
extension
Attributes: |
|
true
|
false
|
string
|
fileName
Attributes: |
|
true
|
false
|
string
|
format
Attributes: |
|
true
|
false
|
string
|
includeFiles
Attributes: |
|
true
|
false
|
any
|
log
Attributes:
|
|
true
|
false
|
numeric
|
priority
Attributes: |
|
true
|
false
|
string
|
type
Attributes: |
|
true
|
false
|
Constructor Summary | |
---|---|
init()
Constructor |
Method Summary | |
---|---|
string |
GETDIRECTORY()
|
string |
GETDISPLAYNAME()
|
string |
GETEXTENSION()
|
string |
GETFILENAME()
|
string |
GETFORMAT()
|
string |
GETINCLUDEFILES()
|
any |
GETLOG()
|
numeric |
GETPRIORITY()
|
string |
GETTYPE()
|
FileExporter |
SETDIRECTORY(string directory)
|
FileExporter |
SETDISPLAYNAME(string displayName)
|
FileExporter |
SETEXTENSION(string extension)
|
FileExporter |
SETFILENAME(string fileName)
|
FileExporter |
SETFORMAT(string format)
|
FileExporter |
SETINCLUDEFILES(string includeFiles)
|
FileExporter |
SETLOG(any log)
|
FileExporter |
SETPRIORITY(numeric priority)
|
FileExporter |
SETTYPE(string type)
|
string |
getFileList()
Gets list of files (absolute paths) when not "all" options are chosen for export |
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 |
---|
string directory
default
- serializable
- truerequired
- falsestring displayName
default
- serializable
- truerequired
- falsestring extension
default
- serializable
- truerequired
- falsestring fileName
default
- serializable
- truerequired
- falsestring format
default
- serializable
- truerequired
- falsestring includeFiles
default
- serializable
- truerequired
- falseany log
inject
- logbox:logger:{this}required
- falseserializable
- truedefault
- numeric priority
default
- serializable
- truerequired
- falsestring type
default
- serializable
- truerequired
- falseMethod Detail |
---|
public string GETDIRECTORY()
public string GETDISPLAYNAME()
public string GETEXTENSION()
public string GETFILENAME()
public string GETFORMAT()
public string GETINCLUDEFILES()
public any GETLOG()
public numeric GETPRIORITY()
public string GETTYPE()
public FileExporter SETDIRECTORY(string directory)
directory
public FileExporter SETDISPLAYNAME(string displayName)
displayName
public FileExporter SETEXTENSION(string extension)
extension
public FileExporter SETFILENAME(string fileName)
fileName
public FileExporter SETFORMAT(string format)
format
public FileExporter SETINCLUDEFILES(string includeFiles)
includeFiles
public FileExporter SETLOG(any log)
log
public FileExporter SETPRIORITY(numeric priority)
priority
public FileExporter SETTYPE(string type)
type
public string getFileList()
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 |