Role

The basic Role class.

class UserKit.Role.Role(name, description=None)

Bases: object

Used in conjunction with RoleUser to provide role-based security.

All roles have a name and a description and respond to playsRole().

RoleUser also responds to playsRole() and is the more popular entry point for programmers. Application code may then do something along the lines of:

if user.playsRole(‘admin’):

self.displayAdminMenuItems()

See also:

• class HierRole

• class RoleUser

__init__(name, description=None)

description()

name()

playsRole(role)

Return true if the receiving role plays the role passed in.

For Role, this is simply a test of equality. Subclasses may override this method to provide richer semantics (such as hierarchical roles).

setDescription(description)

setName(name)