rcUsers Class Reference

A dictionary like class that maintains a list of user objects. More...

List of all members.

Public Member Functions
def	__init__
	rcUsers constructor.
def	addUser
	Adds the user to the list.
def	deleteUser
	Deletes the user from the list based on the userId.
def	getUserByLoginId
	Retrieves the user based on the loginId.
def	getUserByName
	Retrieves the user based on the name.
def	getUser
	Retrieves the user based on userid.
def	getUsers
	Retrieves all users.
def	getIdNameDict
	Retrieves all users in the form of a dictionary.

---

Detailed Description

A dictionary like class that maintains a list of user objects.

Definition at line 98 of file rcUsers.py.

---

Member Function Documentation

def __init__ (    self  )

rcUsers constructor. Definition at line 100 of file rcUsers.py.

def addUser (    self,   user )

Adds the user to the list. Parameters: user  An rcUser object instance Definition at line 106 of file rcUsers.py.

def deleteUser (    self,   userId )

Deletes the user from the list based on the userId. Parameters: userId  The three digit id of the user Returns: True: If the user was successfully deleted False: If the user does not exist Definition at line 113 of file rcUsers.py.

def getIdNameDict (    self  )

Retrieves all users in the form of a dictionary. In this dictionary the values are user names. Provided for backward compatibility with the old code. Returns: A dictionary of user names keyed by the user id Definition at line 167 of file rcUsers.py.

def getUser (    self,   userId )

Retrieves the user based on userid. Parameters: Three  digit of the user Returns: rcUser object instance Definition at line 150 of file rcUsers.py.

def getUserByLoginId (    self,   loginId )

Retrieves the user based on the loginId. Parameters: loginId  Login id of the user Returns: rcUser object instance Definition at line 128 of file rcUsers.py.

def getUserByName (    self,   name )

Retrieves the user based on the name. Parameters: name  Name of the user Returns: rcUser object instance Definition at line 139 of file rcUsers.py.

def getUsers (    self  )

Retrieves all users. Returns: A dictionary of all users keyed by the user id Definition at line 160 of file rcUsers.py.

---

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

• rcUsers.py

---