rcUsers Class Reference

List of all members.

Public Member Functions
	__init__ ()
	addUser (user)
	deleteUser (userId)
	getUserByLoginId (loginId)
	getUserByName (name)
	getUser (userId)
	getUsers ()
	getIdNameDict ()

---

Detailed Description

A dictionary like class that maintains a list of user objects

Definition at line 65 of file rcUsers.py.

---

Member Function Documentation

addUser (  user   )

Adds the user to the list Parameters: user  An rcUser object instance

deleteUser (  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

getIdNameDict (   )

Retrieves all users in the form of a dictionary where values are user names. Provided for backward compatibility with the old code. Returns: A dictionary of user names keyed by the user id

getUser (  userId   )

Retrieves the user based on userid Parameters: Three  digit of the user Returns: rcUser object instance

getUserByLoginId (  loginId   )

Retrieves the user based on the loginId Parameters: loginId  Login id of the user Returns: rcUser object instance

getUserByName (  name   )

Retrieves the user based on the name Parameters: name  Name of the user Returns: rcUser object instance

getUsers (   )

Retrieves all users Returns: A dictionary of all users keyed by the user id

---

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

• rcUsers.py

---