contentbox.models.modules

Class Module

lucee.Component
    extended by contentbox.models.BaseEntityMethods
      extended by contentbox.models.BaseEntity
        extended by contentbox.models.modules.Module

ContentBox - A Modular Content Platform Copyright since 2012 by Ortus Solutions, Corp www.ortussolutions.com/products/contentbox --- I am a ContentBox Module

Class Attributes:
  • entityname : cbModule
  •  
  • cacheuse : read-write
  •  
  • table : cb_module
  •  
  • synchronized : false
  •  
  • cachename : cbModule
  •  
  • accessors : false
  •  
  • persistent : true
  •  
    Property Summary
    type property default serializable required
    any author


    • access = public
    • returntype = any
    • column = author
    • notnull = false
    • length = 255
    true false
    date createdDate


    • access = public
    • returntype = any
    • column = createdDate
    • notnull = true
    • ormtype = timestamp
    • update = false
    • persistent = true
    true false
    any description


    • access = public
    • returntype = any
    • column = description
    • notnull = false
    • ormtype = text
    • length = 8000
    true false
    any entryPoint


    • access = public
    • returntype = any
    • column = entryPoint
    • notnull = false
    • index = idx_entryPoint
    • length = 255
    true false
    any forgeBoxSlug


    • access = public
    • returntype = any
    • column = forgeBoxSlug
    • notnull = false
    • length = 255
    true false
    any isActive


    • access = public
    • returntype = any
    • column = isActive
    • notnull = true
    • ormtype = boolean
    • index = idx_activeModule
    false true false
    any isDeleted


    • access = public
    • returntype = any
    • column = isDeleted
    • notnull = true
    • ormtype = boolean
    • persistent = true
    false true false
    date modifiedDate


    • access = public
    • returntype = any
    • column = modifiedDate
    • notnull = true
    • ormtype = timestamp
    • persistent = true
    true false
    any moduleID


    • access = public
    • fieldtype = id
    • returntype = any
    • column = moduleID
    • ormtype = string
    • update = false
    • generator = uuid
    • length = 36
    true false
    any moduleType


    • access = public
    • dbdefault = 'unknown'
    • returntype = any
    • column = moduleType
    • index = idx_moduleType
    core true false
    any name


    • access = public
    • returntype = any
    • column = name
    • notnull = true
    • index = idx_moduleName
    • length = 255
    true false
    any title


    • access = public
    • returntype = any
    • column = title
    • notnull = false
    • length = 255
    true false
    any version


    • access = public
    • returntype = any
    • column = version
    • notnull = false
    • length = 255
    0 true false
    any webURL


    • access = public
    • returntype = any
    • column = webURL
    • notnull = false
    • length = 500
    true false
    Constructor Summary
    init()
    Method Summary
    string getAuthor()
    string getDescription()
    string getEntryPoint()
    string getForgeBoxSlug()
    string getIsActive()
    string getModuleID()
    string getModuleType()
    string getName()
    string getTitle()
    string getVersion()
    string getWebURL()
    any setAuthor(any author)
    any setDescription(any description)
    any setEntryPoint(any entryPoint)
    any setForgeBoxSlug(any forgeBoxSlug)
    any setIsActive(any isActive)
    any setModuleID(any moduleID)
    any setModuleType(any moduleType)
    any setName(any name)
    any setTitle(any title)
    any setVersion(any version)
    any setWebURL(any webURL)
     
    Methods inherited from class contentbox.models.BaseEntity
    getCreatedDate, getIsDeleted, getModifiedDate, setCreatedDate, setIsDeleted, setModifiedDate
     
    Methods inherited from class contentbox.models.BaseEntityMethods
    appendToMemento, appendToMementoProfile, arrayWrap, getDisplayCreatedDate, getDisplayModifiedDate, getEntityName, getId, includeMixin, isLoaded, preInsert, preUpdate
     
    Methods inherited from class lucee.Component
    None

    Constructor Detail

    init

    public init()


    Property Detail

    author

    property any author

    Attributes:
    access - public
    required - false
    returntype - any
    column - author
    notnull - false
    length - 255
    serializable - true

    createdDate

    property date createdDate

    Attributes:
    access - public
    required - false
    returntype - any
    column - createdDate
    notnull - true
    ormtype - timestamp
    update - false
    persistent - true
    serializable - true

    description

    property any description

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

    entryPoint

    property any entryPoint

    Attributes:
    access - public
    required - false
    returntype - any
    column - entryPoint
    notnull - false
    index - idx_entryPoint
    length - 255
    serializable - true

    forgeBoxSlug

    property any forgeBoxSlug

    Attributes:
    access - public
    required - false
    returntype - any
    column - forgeBoxSlug
    notnull - false
    length - 255
    serializable - true

    isActive

    property any isActive = [false]

    Attributes:
    access - public
    required - false
    returntype - any
    column - isActive
    notnull - true
    ormtype - boolean
    index - idx_activeModule
    serializable - true

    isDeleted

    property any isDeleted = [false]

    Attributes:
    access - public
    required - false
    returntype - any
    column - isDeleted
    notnull - true
    ormtype - boolean
    persistent - true
    serializable - true

    modifiedDate

    property date modifiedDate

    Attributes:
    access - public
    required - false
    returntype - any
    column - modifiedDate
    notnull - true
    ormtype - timestamp
    persistent - true
    serializable - true

    moduleID

    property any moduleID

    Attributes:
    access - public
    required - false
    fieldtype - id
    returntype - any
    column - moduleID
    ormtype - string
    update - false
    generator - uuid
    length - 36
    serializable - true

    moduleType

    property any moduleType = [core]

    Attributes:
    access - public
    required - false
    dbdefault - 'unknown'
    returntype - any
    column - moduleType
    index - idx_moduleType
    serializable - true

    name

    property any name

    Attributes:
    access - public
    required - false
    returntype - any
    column - name
    notnull - true
    index - idx_moduleName
    length - 255
    serializable - true

    title

    property any title

    Attributes:
    access - public
    required - false
    returntype - any
    column - title
    notnull - false
    length - 255
    serializable - true

    version

    property any version = [0]

    Attributes:
    access - public
    required - false
    returntype - any
    column - version
    notnull - false
    length - 255
    serializable - true

    webURL

    property any webURL

    Attributes:
    access - public
    required - false
    returntype - any
    column - webURL
    notnull - false
    length - 500
    serializable - true

    Method Detail

    getAuthor

    public string getAuthor()


    getDescription

    public string getDescription()


    getEntryPoint

    public string getEntryPoint()


    getForgeBoxSlug

    public string getForgeBoxSlug()


    getIsActive

    public string getIsActive()


    getModuleID

    public string getModuleID()


    getModuleType

    public string getModuleType()


    getName

    public string getName()


    getTitle

    public string getTitle()


    getVersion

    public string getVersion()


    getWebURL

    public string getWebURL()


    setAuthor

    public any setAuthor(any author)

    Parameters:
    author

    setDescription

    public any setDescription(any description)

    Parameters:
    description

    setEntryPoint

    public any setEntryPoint(any entryPoint)

    Parameters:
    entryPoint

    setForgeBoxSlug

    public any setForgeBoxSlug(any forgeBoxSlug)

    Parameters:
    forgeBoxSlug

    setIsActive

    public any setIsActive(any isActive)

    Parameters:
    isActive

    setModuleID

    public any setModuleID(any moduleID)

    Parameters:
    moduleID

    setModuleType

    public any setModuleType(any moduleType)

    Parameters:
    moduleType

    setName

    public any setName(any name)

    Parameters:
    name

    setTitle

    public any setTitle(any title)

    Parameters:
    title

    setVersion

    public any setVersion(any version)

    Parameters:
    version

    setWebURL

    public any setWebURL(any webURL)

    Parameters:
    webURL