com.eruces.teadmin.Role
The Role class is a role container.
Inheritance
- Inherits com.eruces.teadmin.UpdatableObject
Public Member Functions
| Member | Description |
|---|---|
Role() | The Role constructor is the default class constructor. |
Role(String strRoleName) | The Role constructor specifies a role name. |
Role(long nID) | The Role constructor specifies a role ID. |
long getRoleID() | The getRoleID method gets a role's unique identifier. |
String getRoleName() | The getRoleName method gets a role name. |
void setRoleName(String strName) | The setRoleName method sets the name of a role. |
short getRoleType() | The getRoleType method gets a role type. |
void addOperation(long nOp) | The addOperation method adds an operation to a role. |
void removeOperation(long nOp) | The removeOperation method removes a specific operation from a role. |
void clearOperation() | The clearOperation method removes all operations from a role. |
PList getOperations() | The getOperations method gets a list of operations assigned to a role. |
boolean isBuiltIn() | The isBuiltIn method indicates whether a role is preset or user-defined. |
String toString() | The toString method converts Role object data to a string. |
Member Function Documentation
Role()
The Role constructor is the default class constructor.
Role(String strRoleName)
The Role constructor specifies a role name.
Parameters
| Parameter | Description |
|---|---|
strRoleName | A string representing a role name. |
Role(long nID)
The Role constructor specifies a role ID.
Parameters
| Parameter | Description |
|---|---|
nID | An integer representing a role ID. |
long getRoleID()
The getRoleID method gets a role's unique identifier.
Returns: Returns an integer representing a role ID.
String getRoleName()
The getRoleName method gets a role name.
Returns: Returns a string representing a role name.
void setRoleName(String strName)
The setRoleName method sets the name of a role.
Parameters
| Parameter | Description |
|---|---|
strName | A string representing a role name. |
short getRoleType()
The getRoleType method gets a role type.
Returns: Returns a short variable representing a role type.
void addOperation(long nOp)
The addOperation method adds an operation to a role.
Parameters
| Parameter | Description |
|---|---|
nOp | An integer representing an operation code. |
void removeOperation(long nOp)
The removeOperation method removes a specific operation from a role.
Parameters
| Parameter | Description |
|---|---|
nOp | An integer representing an operation code. |
void clearOperation()
The clearOperation method removes all operations from a role.
PList getOperations()
The getOperations method gets a list of operations assigned to a role.
Returns: Returns a list of operations.
boolean isBuiltIn()
The isBuiltIn method indicates whether a role is preset or user-defined.
Returns: Returns a boolean value indicating whether a role is preset; True = Preset role, False = User-defined role.
String toString()
The toString method converts Role object data to a string.
Returns: Returns a string representing Role object data.
Remark: Overrides the toString method in the com.eruces.teadmin.UpdatableObject class.