rcUser Class Reference

Class that stores security and identification information about users. More...

List of all members.

Public Member Functions
def	__init__
	rcUser constructor.
def	getId
	Returns the three digit user id.
def	getLoginId
	Returns the user's login id.
def	getName
	Returns the user name.
def	getRoles
	Returns the list of roles that this user belongs in.
def	getPermissions
	Returns the list of permissions that this user has.
def	addRole
	Adds role to this user's roles.
def	addPermission
	Adds permission to this user's permissions.
def	isAdministrator
	Returns the user's administrator status.
def	__str__

---

Detailed Description

Class that stores security and identification information about users.

Definition at line 21 of file rcUsers.py.

---

Member Function Documentation

def __init__ (    self,   userId,   loginId,   userName )

rcUser constructor. Parameters: userId  User id loginId  Login id userName  User name Definition at line 23 of file rcUsers.py.

def __str__ (    self  )

Definition at line 93 of file rcUsers.py.

def addPermission (    self,   permission )

Adds permission to this user's permissions. Parameters: permission  Permission name Definition at line 78 of file rcUsers.py.

def addRole (    self,   role )

Adds role to this user's roles. Parameters: role  Role name Definition at line 71 of file rcUsers.py.

def getId (    self  )

Returns the three digit user id. Returns: User Id Definition at line 36 of file rcUsers.py.

def getLoginId (    self  )

Returns the user's login id. Returns: Login id Definition at line 43 of file rcUsers.py.

def getName (    self  )

Returns the user name. Returns: User name Definition at line 50 of file rcUsers.py.

def getPermissions (    self  )

Returns the list of permissions that this user has. Returns: List of permissions Definition at line 64 of file rcUsers.py.

def getRoles (    self  )

Returns the list of roles that this user belongs in. Returns: List of roles Definition at line 57 of file rcUsers.py.

def isAdministrator (    self  )

Returns the user's administrator status. Returns: 1: If this user is an administrator 0: Otherwise Definition at line 85 of file rcUsers.py.

---

The documentation for this class was generated from the following file:

• rcUsers.py

---