com.eruces.teadmin.GroupInfo
The GroupInfo class represents a group.
Inheritance
- Inherits com.eruces.teadmin.PrincipalInfo
Public Member Functions
| Member | Description |
|---|---|
GroupInfo() | The GroupInfo constructor is the default class constructor. |
GroupInfo(String strName) | The GroupInfo constructor specifies a group name. |
GroupInfo(long nGroupID) | The GroupInfo constructor specifies a group ID. |
GroupInfo(int nSystemID, long nGroupID) | The GroupInfo constructor specifies a system ID and a group ID. |
void setName(String strName) | The setName method sets a group name. |
String getName() | The getName method gets a group name. |
String getPrincipalName() | The getPrincipalName method gets a principal name. |
void setPrincipalList(PList listPrincipals) | The setPrincipalList method sets a list of principals in a group. |
PList getPrincipalList() | The getPrincipalList method gets a list of principals in a group. |
boolean equals(Object anotherInfo) | The equals method compares two principals. |
String toString() | The toString method converts GroupInfo object data to a string. |
Member Function Documentation
GroupInfo()
The GroupInfo constructor is the default class constructor.
GroupInfo(String strName)
The GroupInfo constructor specifies a group name.
Parameters
| Parameter | Description |
|---|---|
strName | A string representing a group name. |
GroupInfo(long nGroupID)
The GroupInfo constructor specifies a group ID.
Parameters
| Parameter | Description |
|---|---|
nGroupID | An integer representing a group ID. |
GroupInfo(int nSystemID, long nGroupID)
The GroupInfo constructor specifies a system ID and a group ID.
Parameters
| Parameter | Description |
|---|---|
nSystemID | An integer representing a system ID. |
nGroupID | An integer representing a group ID. |
void setName(String strName)
The setName method sets a group name.
Parameters
| Parameter | Description |
|---|---|
strName | A string representing a group name. |
String getName()
The getName method gets a group name.
Returns: Returns a string representing a group name.
String getPrincipalName()
The getPrincipalName method gets a principal name.
Returns: Returns a string representing a principal name.
Remark: Specified by the getPrincipalName method in the PrincipalInfo class.
void setPrincipalList(PList listPrincipals)
The setPrincipalList method sets a list of principals in a group.
Parameters
| Parameter | Description |
|---|---|
listPrincipals | A list of principals. |
PList getPrincipalList()
The getPrincipalList method gets a list of principals in a group.
Returns: Returns a list of principals.
boolean equals(Object anotherInfo)
The equals method compares two principals.
Parameters
| Parameter | Description |
|---|---|
anotherInfo | A principal object to which the current principal object will be compared. |
Returns: A boolean value indicating whether the two principals are the same; True = principals are the same, False = principals are different.
String toString()
The toString method converts GroupInfo object data to a string.
Returns: Returns a string representing GroupInfo object data.