contentbox.models.subscriptions

Class BaseSubscription

lucee.Component
    extended by contentbox.models.BaseEntityMethods
      extended by contentbox.models.subscriptions.BaseSubscription
Direct Known Subclasses:
CommentSubscription

ContentBox - A Modular Content Platform Copyright since 2012 by Ortus Solutions, Corp www.ortussolutions.com/products/contentbox --- I am an Abstract Subscription Entity

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


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


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


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


    • access = public
    • inverse = true
    • fieldtype = many-to-one
    • returntype = any
    • notnull = true
    • orderby = subscriberEmail
    • fkcolumn = FK_subscriberID
    • cfc = contentbox.models.subscriptions.Subscriber
    • lazy = true
    true false
    any subscriptionID


    • access = public
    • fieldtype = id
    • returntype = any
    • column = subscriptionID
    • ormtype = string
    • update = false
    • generator = uuid
    • length = 36
    true false
    any subscriptionToken
          This token identifies subscribers (emails) to appropriate subscriptions.

    • access = public
    • returntype = any
    • column = subscriptionToken
    • notnull = true
    • ormtype = string
    • length = 255
    true false
    any type
          The type of subscriptions.

    • access = public
    • returntype = any
    • column = type
    • notnull = true
    • ormtype = string
    true false
    Constructor Summary
    init()
    Method Summary
    string getCreatedDate()
    string getIsDeleted()
    string getModifiedDate()
    string getSubscriber()
    struct getSubscriberSnapshot()
         Build a snapshot of the subscriber.
    string getSubscriptionID()
    string getSubscriptionToken()
    string getType()
    boolean hasSubscriber([any subscriber])
    any setCreatedDate(date createdDate)
    any setIsDeleted(any isDeleted)
    any setModifiedDate(date modifiedDate)
    any setSubscriber(any subscriber)
    any setSubscriptionID(any subscriptionID)
    any setSubscriptionToken(any subscriptionToken)
    any setType(any type)
     
    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

    createdDate

    property date createdDate

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

    isDeleted

    property any isDeleted = [false]

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

    modifiedDate

    property date modifiedDate

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

    subscriber

    property any subscriber

    Attributes:
    access - public
    required - false
    inverse - true
    fieldtype - many-to-one
    returntype - any
    notnull - true
    orderby - subscriberEmail
    fkcolumn - FK_subscriberID
    serializable - true
    cfc - contentbox.models.subscriptions.Subscriber
    lazy - true

    subscriptionID

    property any subscriptionID

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

    subscriptionToken

    property any subscriptionToken

    This token identifies subscribers (emails) to appropriate subscriptions

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

    type

    property any type

    The type of subscriptions. Available subscriptions are : comment

    Attributes:
    access - public
    required - false
    returntype - any
    column - type
    notnull - true
    ormtype - string
    serializable - true

    Method Detail

    getCreatedDate

    public string getCreatedDate()


    getIsDeleted

    public string getIsDeleted()


    getModifiedDate

    public string getModifiedDate()


    getSubscriber

    public string getSubscriber()


    getSubscriberSnapshot

    public struct getSubscriberSnapshot()

    Build a snapshot of the subscriber


    getSubscriptionID

    public string getSubscriptionID()


    getSubscriptionToken

    public string getSubscriptionToken()


    getType

    public string getType()


    hasSubscriber

    public boolean hasSubscriber([any subscriber])

    Parameters:
    subscriber

    setCreatedDate

    public any setCreatedDate(date createdDate)

    Parameters:
    createdDate

    setIsDeleted

    public any setIsDeleted(any isDeleted)

    Parameters:
    isDeleted

    setModifiedDate

    public any setModifiedDate(date modifiedDate)

    Parameters:
    modifiedDate

    setSubscriber

    public any setSubscriber(any subscriber)

    Parameters:
    subscriber

    setSubscriptionID

    public any setSubscriptionID(any subscriptionID)

    Parameters:
    subscriptionID

    setSubscriptionToken

    public any setSubscriptionToken(any subscriptionToken)

    Parameters:
    subscriptionToken

    setType

    public any setType(any type)

    Parameters:
    type