arm4::QArmUser Class Reference
Represents a user on behalf of whom a transaction is executed. More...
Inheritance diagram for arm4::QArmUser:
Public Member Functions | |
QArmUser (const QString &name, const QArmID &id=QArmID::Null) | |
Constructs an QArmUser object that represents the user who invoked (directly or indirectly) the transaction. | |
const QString & | getName () const |
returns the name of the user | |
const QArmID & | getID () const |
Detailed Description
Represents a user on behalf of whom a transaction is executed.
It has the following attributes, all of which are immutable:
-
Name: The maximum length is 127 characters (CIM allows 256 but ARM 2.0 allows 128 bytes, including the null-termination character, so 127 is used). The name must not be
NullString
or zero-length. -
(optional) A 16-byte ID is optionally associated with each
QArmUser
. It is provided by the application. If the value isQArmID::Null
, no ID was provided.
Constructor & Destructor Documentation
arm4::QArmUser::QArmUser | ( | const QString & | name, | |
const QArmID & | id = QArmID::Null | |||
) |
Constructs an QArmUser object that represents the user who invoked (directly or indirectly) the transaction.
- Parameters:
-
name name of the user. id An optional 16-byte ID associated with the user.
Member Function Documentation
const QArmID& arm4::QArmUser::getID | ( | ) | const |
- Returns:
- a 16-byte ID associated with the identity of this user, or
QArmID::Null
.
const QString& arm4::QArmUser::getName | ( | ) | const |
returns the name of the user
- Returns:
- the name of the user.
The documentation for this class was generated from the following file:
- QArm4/QArmUser