contentbox.models.content

Class CustomField

lucee.Component
    extended by contentbox.models.BaseEntityMethods
      extended by contentbox.models.BaseEntity
        extended by contentbox.models.content.CustomField

ContentBox - A Modular Content Platform Copyright since 2012 by Ortus Solutions, Corp www.ortussolutions.com/products/contentbox --- I am a custom field metadata that can be attached to base content in contentbox

Class Attributes:
  • entityname : cbCustomField
  •  
  • cacheuse : read-write
  •  
  • table : cb_customfield
  •  
  • synchronized : false
  •  
  • cachename : cbCustomField
  •  
  • accessors : false
  •  
  • persistent : true
  •  
    Property Summary
    type property default serializable required
    date createdDate


    • access = public
    • returntype = any
    • notnull = true
    • ormtype = timestamp
    • update = false
    • index = idx_createDate
    true false
    any customFieldID


    • access = public
    • fieldtype = id
    • returntype = any
    • params = { allocationSize = 1, sequence = 'customFieldID_seq' }
    • generator = native
    • setter = no
    true false
    any isDeleted


    • access = public
    • dbdefault = 0
    • returntype = any
    • notnull = true
    • ormtype = boolean
    • index = idx_deleted
    • sqltype = bit
    false true false
    any key


    • access = public
    • returntype = any
    • notnull = true
    • ormtype = string
    • length = 255
    true false
    date modifiedDate


    • access = public
    • returntype = any
    • notnull = true
    • ormtype = timestamp
    • index = idx_modifiedDate
    true false
    any relatedContent


    • access = public
    • fieldtype = many-to-one
    • returntype = any
    • notnull = false
    • index = idx_contentCustomFields
    • fkcolumn = FK_contentID
    • cfc = contentbox.models.content.BaseContent
    • lazy = true
    true false
    any value


    • access = public
    • returntype = any
    • notnull = true
    • ormtype = text
    • length = 8000
    true false
    Method Summary
    string getCustomFieldID()
    string getKey()
    any getMemento([any excludes=''])
         Get memento representation.
    string getRelatedContent()
    string getValue()
    boolean hasRelatedContent([any relatedContent])
    any setKey(any key)
    any setRelatedContent(any relatedContent)
    any setValue(any value)
     
    Methods inherited from class contentbox.models.BaseEntity
    getCreatedDate, getIsDeleted, getModifiedDate, setCreatedDate, setIsDeleted, setModifiedDate
     
    Methods inherited from class contentbox.models.BaseEntityMethods
    getBaseMemento, getDisplayCreatedDate, getDisplayModifiedDate, init, isLoaded, preInsert, preUpdate
     
    Methods inherited from class lucee.Component
    None

    Property Detail

    createdDate

    property date createdDate

    Attributes:
    access - public
    required - false
    returntype - any
    notnull - true
    ormtype - timestamp
    update - false
    index - idx_createDate
    serializable - true

    customFieldID

    property any customFieldID

    Attributes:
    access - public
    required - false
    fieldtype - id
    returntype - any
    params - { allocationSize = 1, sequence = 'customFieldID_seq' }
    generator - native
    serializable - true
    setter - no

    isDeleted

    property any isDeleted = [false]

    Attributes:
    access - public
    required - false
    dbdefault - 0
    returntype - any
    notnull - true
    ormtype - boolean
    index - idx_deleted
    serializable - true
    sqltype - bit

    key

    property any key

    Attributes:
    access - public
    required - false
    returntype - any
    notnull - true
    ormtype - string
    length - 255
    serializable - true

    modifiedDate

    property date modifiedDate

    Attributes:
    access - public
    required - false
    returntype - any
    notnull - true
    ormtype - timestamp
    index - idx_modifiedDate
    serializable - true

    relatedContent

    property any relatedContent

    Attributes:
    access - public
    required - false
    fieldtype - many-to-one
    returntype - any
    notnull - false
    index - idx_contentCustomFields
    fkcolumn - FK_contentID
    serializable - true
    cfc - contentbox.models.content.BaseContent
    lazy - true

    value

    property any value

    Attributes:
    access - public
    required - false
    returntype - any
    notnull - true
    ormtype - text
    length - 8000
    serializable - true

    Method Detail

    getCustomFieldID

    public string getCustomFieldID()


    getKey

    public string getKey()


    getMemento

    public any getMemento([any excludes=''])

    Get memento representation

    Parameters:
    excludes

    getRelatedContent

    public string getRelatedContent()


    getValue

    public string getValue()


    hasRelatedContent

    public boolean hasRelatedContent([any relatedContent])

    Parameters:
    relatedContent

    setKey

    public any setKey(any key)

    Parameters:
    key

    setRelatedContent

    public any setRelatedContent(any relatedContent)

    Parameters:
    relatedContent

    setValue

    public any setValue(any value)

    Parameters:
    value