|
ContentBox Core API 1.6.0 | ||||
FRAMES |
WEB-INF.cftags.componentcontentbox.model.security.Role
public class Role
******************************************************************************* ContentBox - A Modular Content Platform Copyright 2012 by Luis Majano and Ortus Solutions, Corp www.gocontentbox.org | www.luismajano.com | www.ortussolutions.com ******************************************************************************* Apache License, Version 2.0 Copyright Since [2012] [Luis Majano and Ortus Solutions,Corp] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ******************************************************************************* A cool Role entity
Property Summary | ||||
---|---|---|---|---|
Type | Property & Description | Default | Serializable | Required |
any
|
description
Attributes:
|
|
true
|
false
|
any
|
numberOfAuthors
Attributes:
|
|
true
|
false
|
any
|
numberOfPermissions
Attributes:
|
|
true
|
false
|
any
|
permissionList
Attributes:
|
|
true
|
false
|
any
|
permissionService
Attributes:
|
|
true
|
false
|
array
|
permissions
Attributes:
|
|
true
|
false
|
any
|
role
Attributes:
|
|
true
|
false
|
any
|
roleID
Attributes:
|
|
true
|
false
|
Constructor Summary | |
---|---|
init()
|
Method Summary | |
---|---|
void |
ADDPERMISSION(Permission permission)
|
any |
GETDESCRIPTION()
get: |
any |
GETNUMBEROFAUTHORS()
get: |
any |
GETNUMBEROFPERMISSIONS()
get: |
any |
GETPERMISSIONLIST()
get: |
array |
GETPERMISSIONS()
get: |
any |
GETPERMISSIONSERVICE()
get: |
any |
GETROLE()
get: |
any |
GETROLEID()
get: |
boolean |
HASPERMISSION([Permission permissions])
|
boolean |
REMOVEPERMISSION(Permission permission)
|
Role |
SETDESCRIPTION(any description)
set: |
Role |
SETNUMBEROFAUTHORS(any numberOfAuthors)
set: |
Role |
SETNUMBEROFPERMISSIONS(any numberOfPermissions)
set: |
Role |
SETPERMISSIONLIST(any permissionList)
set: |
Role |
SETPERMISSIONSERVICE(any permissionService)
set: |
Role |
SETROLE(any role)
set: |
boolean |
checkPermission(any slug)
Check for permission |
Role |
clearPermissions()
Clear all permissions |
any |
getMemento()
Get memento representation |
boolean |
isLoaded()
is loaded? |
Role |
setPermissions(array permissions)
Override the setPermissions |
Methods inherited from class WEB-INF.cftags.component |
---|
None
|
Constructor Detail |
---|
public init()
Property Detail |
---|
any description
ormtype
- stringserializable
- truerequired
- falsenotnull
- falselength
- 500default
- any numberOfAuthors
formula
- select count(*) from cb_author as author where author.FK_roleID=roleIDrequired
- falseserializable
- truedefault
- any numberOfPermissions
formula
- select count(*) from cb_rolePermissions as rolePermissions where rolePermissions.FK_roleID=roleIDrequired
- falseserializable
- truedefault
- any permissionList
required
- falseserializable
- truepersistent
- falsedefault
- any permissionService
inject
- permissionService@cbserializable
- truerequired
- falsepersistent
- falsedefault
- array permissions
cacheuse
- read-writeserializable
- truelazy
- extradefault
- linktable
- cb_rolePermissionsfieldtype
- many-to-manysingularname
- permissionorderby
- permissionrequired
- falseinversejoincolumn
- FK_permissionIDcascade
- allcfc
- contentbox.model.security.Permissionfkcolumn
- FK_roleIDany role
unique
- trueormtype
- stringserializable
- truerequired
- falsenotnull
- truelength
- 255default
- any roleID
generator
- nativefieldtype
- idserializable
- truerequired
- falsedefault
- setter
- falseMethod Detail |
---|
public void ADDPERMISSION(Permission permission)
permission
public any GETDESCRIPTION()
public any GETNUMBEROFAUTHORS()
public any GETNUMBEROFPERMISSIONS()
public any GETPERMISSIONLIST()
public array GETPERMISSIONS()
public any GETPERMISSIONSERVICE()
public any GETROLE()
public any GETROLEID()
public boolean HASPERMISSION([Permission permissions])
permissions
public boolean REMOVEPERMISSION(Permission permission)
permission
public Role SETDESCRIPTION(any description)
description
public Role SETNUMBEROFAUTHORS(any numberOfAuthors)
numberOfAuthors
public Role SETNUMBEROFPERMISSIONS(any numberOfPermissions)
numberOfPermissions
public Role SETPERMISSIONLIST(any permissionList)
permissionList
public Role SETPERMISSIONSERVICE(any permissionService)
permissionService
public Role SETROLE(any role)
role
public boolean checkPermission(any slug)
slug
- The permission slug or list of slugs to validate the role has. If it's a list then they are ORed togetherpublic Role clearPermissions()
public any getMemento()
public boolean isLoaded()
public Role setPermissions(array permissions)
permissions
|
ContentBox Core API 1.6.0 | ||||
FRAMES |