contentbox.models.exporters

Class BaseExporter

lucee.Component
    extended by contentbox.models.exporters.BaseExporter
Direct Known Subclasses:
DataExporter , FileExporter

ContentBox - A Modular Content Platform Copyright since 2012 by Ortus Solutions, Corp www.ortussolutions.com/products/contentbox --- Base exporter class

Class Attributes:
  • synchronized : false
  •  
  • accessors : true
  •  
  • persistent : false
  •  
    Property Summary
    type property default serializable required
    any allowedFormats
          The allowed export formats the exporter defines.

    • access = public
    • returntype = any
    true false
    string displayName
          Human readable name used in the UI.

    • access = public
    • returntype = any
    true false
    string fileName
          Export filename.

    • access = public
    • returntype = any
    true false
    string format
          The format of the file to export.

    • access = public
    • returntype = any
    true false
    any log


    • access = public
    • returntype = any
    • inject = logbox:logger:{this}
    true false
    string name
          The name of the exporter.

    • access = public
    • returntype = any
    true false
    numeric priority
          The priority level of the export.

    • access = public
    • returntype = any
    true false
    Constructor Summary
    init()
          Constructor.
    Method Summary
    string getAllowedFormats()
    string getDisplayName()
    string getFileName()
    string getFormat()
    string getLog()
    string getName()
    string getPriority()
    boolean isValid()
         Determines if exporter is valid based on validation criteria.
    any setAllowedFormats(any allowedFormats)
    any setDisplayName(string displayName)
    any setFileName(string fileName)
    any setFormat(string format)
    any setLog(any log)
    any setName(string name)
    any setPriority(numeric priority)
     
    Methods inherited from class lucee.Component
    None

    Constructor Detail

    init

    public init()

    Constructor


    Property Detail

    allowedFormats

    property any allowedFormats

    The allowed export formats the exporter defines

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    displayName

    property string displayName

    Human readable name used in the UI

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    fileName

    property string fileName

    Export filename

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    format

    property string format

    The format of the file to export

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    log

    property any log

    Attributes:
    access - public
    required - false
    returntype - any
    inject - logbox:logger:{this}
    serializable - true

    name

    property string name

    The name of the exporter

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    priority

    property numeric priority

    The priority level of the export

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    Method Detail

    getAllowedFormats

    public string getAllowedFormats()


    getDisplayName

    public string getDisplayName()


    getFileName

    public string getFileName()


    getFormat

    public string getFormat()


    getLog

    public string getLog()


    getName

    public string getName()


    getPriority

    public string getPriority()


    isValid

    public boolean isValid()

    Determines if exporter is valid based on validation criteria


    setAllowedFormats

    public any setAllowedFormats(any allowedFormats)

    Parameters:
    allowedFormats

    setDisplayName

    public any setDisplayName(string displayName)

    Parameters:
    displayName

    setFileName

    public any setFileName(string fileName)

    Parameters:
    fileName

    setFormat

    public any setFormat(string format)

    Parameters:
    format

    setLog

    public any setLog(any log)

    Parameters:
    log

    setName

    public any setName(string name)

    Parameters:
    name

    setPriority

    public any setPriority(numeric priority)

    Parameters:
    priority