tech.pisoft.teadmin.MsgPrincipalInfo
The MsgPrincipalInfo class represents a message principal.
Since: 3.1
© Pi Soft, 2018-2026 · Tricryption Engine 8.1
Inheritance
- Inherits tech.pisoft.teadmin.PrincipalInfo
Public Member Functions
| Member | Description |
|---|---|
MsgPrincipalInfo() | The MsgPrincipalInfo constructor is the default class constructor. |
MsgPrincipalInfo(long nPrincipalID) | The MsgPrincipalInfo constructor specifies a principal ID. |
MsgPrincipalInfo(int nSystemID, long nPrincipalID) | The MsgPrincipalInfo constructor specifies a system ID and a principal ID. |
String getPrincipalName() | The getPrincipalName method gets a principal name. |
String getMessage() | Get message information. |
int getCode() | The getCode method gets code information. |
boolean equals(Object anotherInfo) | The equals method compares two principals. |
String toString() | The toString method converts MsgPrincipalInfo object data to a string. |
Member Function Documentation
MsgPrincipalInfo()
The MsgPrincipalInfo constructor is the default class constructor.
MsgPrincipalInfo(long nPrincipalID)
The MsgPrincipalInfo constructor specifies a principal ID.
Parameters
| Parameter | Description |
|---|---|
nPrincipalID | An integer representing a principal ID. |
MsgPrincipalInfo(int nSystemID, long nPrincipalID)
The MsgPrincipalInfo constructor specifies a system ID and a principal ID.
Parameters
| Parameter | Description |
|---|---|
nSystemID | An integer representing a system ID. |
nPrincipalID | An integer representing a principal ID. |
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.
String getMessage()
Get message information.
Returns: string of message
int getCode()
The getCode method gets code information.
Returns: Returns an integer representing code information.
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: Returns a boolean value indicating whether the two principals are the same; True = principals are the same, False = principals are different.
Remark: Specified by the equals method in the PrincipalInfo class.
String toString()
The toString method converts MsgPrincipalInfo object data to a string.
Returns: Returns a string representing MsgPrincipalInfo object data.
Remark: Overrides the toString method in the PrincipalInfo class.