ContentBox Core API 1.5.7

contentbox.model.security
Class Role

WEB-INF.cftags.component
        extended by contentbox.model.security.Role

public class Role
extends WEB-INF.cftags.component

******************************************************************************* 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


Constructor Summary
init()
 
Method Summary
 void ADDPERMISSION(Permission permission)
 any GETDESCRIPTION()
 any GETNUMBEROFAUTHORS()
 any GETNUMBEROFPERMISSIONS()
 any GETPERMISSIONLIST()
 array GETPERMISSIONS()
 any GETPERMISSIONSERVICE()
 any GETROLE()
 any GETROLEID()
 boolean HASPERMISSION([Permission permissions])
 boolean REMOVEPERMISSION(Permission permission)
 void SETDESCRIPTION(any description)
 void SETNUMBEROFAUTHORS(any numberOfAuthors)
 void SETNUMBEROFPERMISSIONS(any numberOfPermissions)
 void SETPERMISSIONLIST(any permissionList)
 void SETPERMISSIONSERVICE(any permissionService)
 void SETROLE(any role)
 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
 

Constructor Detail

init

public init()

Method Detail

ADDPERMISSION

public void ADDPERMISSION(Permission permission)

Parameters:
permission

GETDESCRIPTION

public any GETDESCRIPTION()


GETNUMBEROFAUTHORS

public any GETNUMBEROFAUTHORS()


GETNUMBEROFPERMISSIONS

public any GETNUMBEROFPERMISSIONS()


GETPERMISSIONLIST

public any GETPERMISSIONLIST()


GETPERMISSIONS

public array GETPERMISSIONS()


GETPERMISSIONSERVICE

public any GETPERMISSIONSERVICE()


GETROLE

public any GETROLE()


GETROLEID

public any GETROLEID()


HASPERMISSION

public boolean HASPERMISSION([Permission permissions])

Parameters:
permissions

REMOVEPERMISSION

public boolean REMOVEPERMISSION(Permission permission)

Parameters:
permission

SETDESCRIPTION

public void SETDESCRIPTION(any description)

Parameters:
description

SETNUMBEROFAUTHORS

public void SETNUMBEROFAUTHORS(any numberOfAuthors)

Parameters:
numberOfAuthors

SETNUMBEROFPERMISSIONS

public void SETNUMBEROFPERMISSIONS(any numberOfPermissions)

Parameters:
numberOfPermissions

SETPERMISSIONLIST

public void SETPERMISSIONLIST(any permissionList)

Parameters:
permissionList

SETPERMISSIONSERVICE

public void SETPERMISSIONSERVICE(any permissionService)

Parameters:
permissionService

SETROLE

public void SETROLE(any role)

Parameters:
role

checkPermission

public boolean checkPermission(any slug)
Check for permission

Parameters:
slug - The permission slug or list of slugs to validate the role has. If it's a list then they are ORed together

clearPermissions

public Role clearPermissions()
Clear all permissions


getMemento

public any getMemento()
Get memento representation


isLoaded

public boolean isLoaded()
is loaded?


setPermissions

public Role setPermissions(array permissions)
Override the setPermissions

Parameters:
permissions

ContentBox Core API 1.5.7