contentbox.models.exporters

Class DataExporter

lucee.Component
    extended by contentbox.models.exporters.DataExporter
All Implemented Interfaces:
ICBExporter

ContentBox - A Modular Content Platform Copyright since 2012 by Ortus Solutions, Corp www.ortussolutions.com/products/contentbox --- Exporter for Data-based content

Class Attributes:
  • synchronized : false
  •  
  • accessors : true
  •  
  • persistent : false
  •  
    Property Summary
    type property default serializable required
    any content


    • access = public
    • returntype = any
    true false
    string displayName


    • access = public
    • returntype = any
    true false
    string fileName


    • access = public
    • returntype = any
    true false
    string format


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


    • access = public
    • returntype = any
    • inject = logbox:logger:{this}
    true false
    numeric priority


    • access = public
    • returntype = any
    true false
    Constructor Summary
    init()
          Constructor.
    Method Summary
    string getContent()
    string getDisplayName()
    string getFileName()
    string getFormat()
    string getLog()
    string getName()
         Gets the name of the exporter.
    string getPriority()
    numeric getTotal()
         Gets "total" based on content type.
    boolean isValid()
         Determines if exporter is valid based on validation criteria.
    any setContent(any content)
    any setDisplayName(string displayName)
    any setFileName(string fileName)
    any setFormat(string format)
    any setLog(any log)
    any setPriority(numeric priority)
    array validate()
         Custom validator for this exporter.
     
    Methods inherited from class lucee.Component
    None

    Constructor Detail

    init

    public init()

    Constructor


    Property Detail

    content

    property any content

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

    displayName

    property string displayName

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

    fileName

    property string fileName

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

    format

    property string format

    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

    priority

    property numeric priority

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

    Method Detail

    getContent

    public string getContent()


    getDisplayName

    public string getDisplayName()


    getFileName

    public string getFileName()


    getFormat

    public string getFormat()


    getLog

    public string getLog()


    getName

    public string getName()

    Gets the name of the exporter

    Specified by:
    getName in interface ICBExporter

    getPriority

    public string getPriority()


    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

    setContent

    public any setContent(any content)

    Parameters:
    content

    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

    setPriority

    public any setPriority(numeric priority)

    Parameters:
    priority

    validate

    public array validate()

    Custom validator for this exporter...any rules can be applied

    Specified by:
    validate in interface ICBExporter