railo-context.Componentcontentbox.model.exporters.FileExporter
ContentBox - A Modular Content Platform Copyright 2012 by Luis Majano and Ortus Solutions, Corp 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 | default | serializable | required |
string
|
directory
|
true
|
false
|
|
string
|
displayName
|
true
|
false
|
|
string
|
extension
|
true
|
false
|
|
string
|
fileName
|
true
|
false
|
|
string
|
format
|
true
|
false
|
|
string
|
includeFiles
|
true
|
false
|
|
any
|
log
|
true
|
false
|
|
numeric
|
priority
|
true
|
false
|
|
string
|
type
|
true
|
false
|
Constructor Summary | |
---|---|
init()
Constructor. |
Method Summary | |
---|---|
string
|
getDirectory()
|
string
|
getDisplayName()
|
string
|
getExtension()
|
string
|
getFileList()
Gets list of files (absolute paths) when not "all" options are chosen for export. |
string
|
getFileName()
|
string
|
getFormat()
|
string
|
getIncludeFiles()
|
string
|
getLog()
|
string
|
getName()
Gets the name of the exporter. |
string
|
getPriority()
|
numeric
|
getTotal()
Gets "total" based on content type. |
string
|
getType()
|
boolean
|
isValid()
Determines if exporter is valid based on validation criteria. |
any
|
setDirectory(string directory)
|
any
|
setDisplayName(string displayName)
|
any
|
setExtension(string extension)
|
any
|
setFileName(string fileName)
|
any
|
setFormat(string format)
|
any
|
setIncludeFiles(string includeFiles)
|
any
|
setLog(any log)
|
any
|
setPriority(numeric priority)
|
any
|
setType(string type)
|
array
|
validate()
Custom validator for this exporter. |
Methods inherited from class railo-context.Component |
---|
None |
Constructor Detail |
---|
Constructor
Property Detail |
---|
required
- falseserializable
- truerequired
- falseserializable
- truerequired
- falseserializable
- truerequired
- falseserializable
- truerequired
- falseserializable
- truerequired
- falseserializable
- truerequired
- falseinject
- logbox:logger:{this}serializable
- truerequired
- falseserializable
- truerequired
- falseserializable
- trueMethod Detail |
---|
Gets list of files (absolute paths) when not "all" options are chosen for export
Gets the name of the exporter
getName
in interface
ICBExporter
Gets "total" based on content type
getTotal
in interface
ICBExporter
Determines if exporter is valid based on validation criteria
isValid
in interface
ICBExporter
directory
displayName
extension
fileName
format
includeFiles
log
priority
type
Custom validator for this exporter...any rules can be applied
validate
in interface
ICBExporter