contentbox.models.security

Class PermissionGroup

lucee.Component
    extended by contentbox.models.BaseEntityMethods
      extended by contentbox.models.BaseEntity
        extended by contentbox.models.security.PermissionGroup

ContentBox - A Modular Content Platform Copyright since 2012 by Ortus Solutions, Corp www.ortussolutions.com/products/contentbox --- This entity groups permissions for logical groupings

Class Attributes:
  • entityname : cbPermissionGroup
  •  
  • cacheuse : read-write
  •  
  • table : cb_permissionGroup
  •  
  • synchronized : false
  •  
  • cachename : cbPermissionGroup
  •  
  • accessors : false
  •  
  • persistent : true
  •  
    Property Summary
    type property default serializable required
    array authors


    • linktable = cb_authorPermissionGroups
    • access = public
    • fieldtype = many-to-many
    • returntype = any
    • cacheuse = read-write
    • singularname = author
    • fkcolumn = FK_permissionGroupID
    • inversejoincolumn = FK_authorID
    • cfc = contentbox.models.security.Author
    • lazy = true
    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 = string
    • length = 500
    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 name


    • access = public
    • unique = true
    • returntype = any
    • column = name
    • notnull = true
    • ormtype = string
    • index = idx_permissionGroupName
    • length = 255
    true false
    any numberOfAuthors


    • access = public
    • returntype = any
    • formula = select count(*) from cb_authorPermissionGroups as pg where pg.FK_permissionGroupID = permissionGroupID
    true false
    any numberOfPermissions


    • access = public
    • returntype = any
    • formula = select count(*) from cb_groupPermissions as groupPermissions where groupPermissions.FK_permissionGroupID = permissionGroupID
    true false
    any permissionGroupID


    • access = public
    • fieldtype = id
    • returntype = any
    • column = permissionGroupID
    • update = false
    • generator = uuid
    • length = 36
    true false
    any permissionList


    • access = public
    • returntype = any
    • persistent = false
    true false
    array permissions


    • linktable = cb_groupPermissions
    • access = public
    • fieldtype = many-to-many
    • returntype = any
    • cascade = save-update
    • cacheuse = read-write
    • orderby = permission
    • fkcolumn = FK_permissionGroupID
    • inversejoincolumn = FK_permissionID
    • cfc = contentbox.models.security.Permission
    • lazy = true
    true false
    Constructor Summary
    init()
          Constructor.
    Method Summary
    any addAuthor(any author)
    any addPermissions(any permissions)
    PermissionGroup clearAuthors()
         Clear all authors.
    PermissionGroup clearPermissions()
         Clear all permissions.
    string getAuthors()
    string getDescription()
    string getName()
    string getNumberOfAuthors()
    string getNumberOfPermissions()
    string getPermissionGroupID()
    string getPermissionList()
    string getPermissions()
    boolean hasAuthor([any author])
    boolean hasPermission(any permission)
         Verify if the permission group has one or more of the passed in permissions.
    boolean hasPermissions([any permissions])
    boolean removeAuthor(any author)
    boolean removePermissions(any permissions)
    PermissionGroup setAuthors(array authors)
         Override the setAuthors.
    any setDescription(any description)
    any setName(any name)
    any setNumberOfAuthors(any numberOfAuthors)
    any setNumberOfPermissions(any numberOfPermissions)
    any setPermissionGroupID(any permissionGroupID)
    any setPermissionList(any permissionList)
    PermissionGroup setPermissions(array permissions)
         Override the setPermissions.
     
    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()

    Constructor


    Property Detail

    authors

    property array authors

    Attributes:
    linktable - cb_authorPermissionGroups
    access - public
    required - false
    fieldtype - many-to-many
    returntype - any
    cacheuse - read-write
    singularname - author
    fkcolumn - FK_permissionGroupID
    serializable - true
    inversejoincolumn - FK_authorID
    cfc - contentbox.models.security.Author
    lazy - 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 - string
    length - 500
    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

    name

    property any name

    Attributes:
    access - public
    unique - true
    required - false
    returntype - any
    column - name
    notnull - true
    ormtype - string
    index - idx_permissionGroupName
    length - 255
    serializable - true

    numberOfAuthors

    property any numberOfAuthors

    Attributes:
    access - public
    required - false
    returntype - any
    formula - select count(*) from cb_authorPermissionGroups as pg where pg.FK_permissionGroupID = permissionGroupID
    serializable - true

    numberOfPermissions

    property any numberOfPermissions

    Attributes:
    access - public
    required - false
    returntype - any
    formula - select count(*) from cb_groupPermissions as groupPermissions where groupPermissions.FK_permissionGroupID = permissionGroupID
    serializable - true

    permissionGroupID

    property any permissionGroupID

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

    permissionList

    property any permissionList

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

    permissions

    property array permissions

    Attributes:
    linktable - cb_groupPermissions
    access - public
    required - false
    fieldtype - many-to-many
    returntype - any
    cascade - save-update
    cacheuse - read-write
    orderby - permission
    fkcolumn - FK_permissionGroupID
    serializable - true
    inversejoincolumn - FK_permissionID
    cfc - contentbox.models.security.Permission
    lazy - true

    Method Detail

    addAuthor

    public any addAuthor(any author)

    Parameters:
    author

    addPermissions

    public any addPermissions(any permissions)

    Parameters:
    permissions

    clearAuthors

    public PermissionGroup clearAuthors()

    Clear all authors


    clearPermissions

    public PermissionGroup clearPermissions()

    Clear all permissions


    getAuthors

    public string getAuthors()


    getDescription

    public string getDescription()


    getName

    public string getName()


    getNumberOfAuthors

    public string getNumberOfAuthors()


    getNumberOfPermissions

    public string getNumberOfPermissions()


    getPermissionGroupID

    public string getPermissionGroupID()


    getPermissionList

    public string getPermissionList()


    getPermissions

    public string getPermissions()


    hasAuthor

    public boolean hasAuthor([any author])

    Parameters:
    author

    hasPermission

    public boolean hasPermission(any permission)

    Verify if the permission group has one or more of the passed in permissions

    Parameters:
    permission - One or a list of permissions to verify

    hasPermissions

    public boolean hasPermissions([any permissions])

    Parameters:
    permissions

    removeAuthor

    public boolean removeAuthor(any author)

    Parameters:
    author

    removePermissions

    public boolean removePermissions(any permissions)

    Parameters:
    permissions

    setAuthors

    public PermissionGroup setAuthors(array authors)

    Override the setAuthors

    Parameters:
    authors - The permissions array

    setDescription

    public any setDescription(any description)

    Parameters:
    description

    setName

    public any setName(any name)

    Parameters:
    name

    setNumberOfAuthors

    public any setNumberOfAuthors(any numberOfAuthors)

    Parameters:
    numberOfAuthors

    setNumberOfPermissions

    public any setNumberOfPermissions(any numberOfPermissions)

    Parameters:
    numberOfPermissions

    setPermissionGroupID

    public any setPermissionGroupID(any permissionGroupID)

    Parameters:
    permissionGroupID

    setPermissionList

    public any setPermissionList(any permissionList)

    Parameters:
    permissionList

    setPermissions

    public PermissionGroup setPermissions(array permissions)

    Override the setPermissions

    Parameters:
    permissions - The permissions array