com.eruces.teadmin.XAuthPrincipalInfo
Inheritance
- Inherits com.eruces.teadmin.PrincipalInfo
Public Member Functions
| Member | Description |
|---|---|
XAuthPrincipalInfo() | The XAuthPrincipalInfo constructor is the default class constructor. |
XAuthPrincipalInfo(long pid) | The XAuthPrincipalInfo constructor specifies a principal ID. |
XAuthPrincipalInfo(int sid, long pid) | The PrincipalInfo constructor specifies a system ID and a principal ID. |
String getPrincipalName() | The getPrincipalName method returns XAuth principal name as principal name. |
String getUid() | The getUid method returns XAuth principal id. |
void setUid(String uid) | The setName method sets a XAuth principal id. |
String getMetaInfo() | The getMeta method returns XAuth principal meta information. |
void setMetaInfo(String meta) | The setName method sets a XAuth principal meta information. |
boolean equals(Object anotherInfo) | The equals method compares two principals. |
String toString() | The toString method converts XAuth object data to a string. |
Member Function Documentation
XAuthPrincipalInfo()
The XAuthPrincipalInfo constructor is the default class constructor.
XAuthPrincipalInfo(long pid)
The XAuthPrincipalInfo constructor specifies a principal ID.
Parameters
| Parameter | Description |
|---|---|
pid | An integer representing a principal ID. type:long |
XAuthPrincipalInfo(int sid, long pid)
The PrincipalInfo constructor specifies a system ID and a principal ID.
Parameters
| Parameter | Description |
|---|---|
sid | An integer representing a system ID. type:integer |
pid | An integer representing a principal ID. type:long |
String getPrincipalName()
The getPrincipalName method returns XAuth principal name as principal name.
Returns: Returns a string representing a principal name.
String getUid()
The getUid method returns XAuth principal id.
Returns: A string of user name.
void setUid(String uid)
The setName method sets a XAuth principal id.
Parameters
| Parameter | Description |
|---|---|
uid | An integer representing a principal ID. |
String getMetaInfo()
The getMeta method returns XAuth principal meta information.
Returns: A string of user meta information.
void setMetaInfo(String meta)
The setName method sets a XAuth principal meta information.
Parameters
| Parameter | Description |
|---|---|
uid | An integer representing a principal meta information. |
boolean equals(Object anotherInfo)
The equals method compares two principals.
Two XAuthPrincipalInfo principals are the same if their user names or principal IDs are the same
Parameters
| Parameter | Description |
|---|---|
anotherInfo | A PrincipalInfo object to which the current PrincipalInfo object will be compared. |
Returns: 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 XAuth object data to a string.
Returns: Returns a string representing XAuthPrincipalInfo object data.
Remark: Overrides the toString method in the com.eruces.teadmin.UpdatableObject class.