ERUCES::TEPrincipalInfo
#include <teprincipal.h>
The TEPrincipalInfo class is the principal base class and is derived from the TEUpdatableObject class.
Inheritance
- Inherits ERUCES::TEUpdatableObject
- Inherited by ERUCES::TEGroupInfo
- Inherited by ERUCES::TELDAPPrincipalInfo
- Inherited by ERUCES::TEMessagePrincipal
- Inherited by ERUCES::TETransportPrincipalInfo
- Inherited by ERUCES::TEUnixPrincipalInfo
- Inherited by ERUCES::TEUserAndPasswordInfo
- Inherited by ERUCES::TEUserAndPasswordInfo_V1
- Inherited by ERUCES::TEWindowsPrincipalInfo
Protected Member Functions
| Member | Description |
|---|---|
TEPrincipalInfo() | The TEPrincipalInfo constructor is the default class constructor. |
Public Member Functions
| Member | Description |
|---|---|
~TEPrincipalInfo() | The TEPrincipalInfo destructor is the class destructor. |
void setPrincipalId(te_oid pid) | The setPrincipalId method sets a unique principal identifier. |
te_oid getPrincipalId() const | The getPrincipalId method gets a principal identifier. |
const _TESTD string getPrincipalName() const =0 | The getPrincipalName method gets a principal's name. |
void setSystemId(uint32_t sid) | Sets a unique system identifier. |
uint32_t getSystemId() const | The getSystemId method gets a system identifier. |
void setFlag(uint32_t flag) | |
uint32_t getFlag() const | The getFlag method gets a principal status flag. |
uint32_t RoleCount() const | The roleCount method gets the number of roles assigned to a TEPrincipalInfo object. |
void getRoleIds(TEObjectContainer &ids) const | The getRoleIDs method gets all the role identifiers assigned to a TEPrincipalInfo object. |
bool addRole(te_oid rid) | The addRole method adds a role to a TEPrincipalInfo object. |
bool removeRole(te_oid rid) | The removeRole method removes a role from a TEPrincipalInfo object. |
void clearRoles() | The clearRoles method clears all roles from a TEPrincipalInfo object. |
uint32_t GroupCount() const | The groupCount method gets the number of groups to which a principal belongs. |
void getGroupIds(TEObjectContainer &gids) const | The getGroupIDs method gets all the group identifiers of all the groups to which a principal belongs. |
bool addGroup(te_oid gid) | The addGroup method adds the principal to a group.. |
bool removeGroup(te_oid gid) | The removeGroup method removes a principal from a group. |
void clearGroups() | The clearGroups method clears a principal from all groups. |
void setDefaultGroup(te_oid gid) | The setDefaultGroup method sets the default group id. |
te_oid getDefaultGroup() const | The getDefaultGroup method retrieves the default group id. |
uint32_t ReviewerCount() const | The ReviewerCount method retrieves the number of reviewers which a principal has. |
void getReviewerIds(TEObjectContainer &rvids) const | The getReviewerIds method retrieves the identifiers of all reviewers which a principal has. |
bool addReviewer(te_oid rvid) | The addReviewer method adds a reviewer to the principal. |
bool removeReviewer(te_oid rvid) | The removeReviewer method removes a reviewer from the principal. |
void clearReviewers() | Remove all reviewers of the principal. |
void setAclTemplateId(te_oid id) | The setAclTemplateId method sets an ACL Template to be applied when generating TTag. |
te_oid getAclTemplateId() const | The getAclTemplateId method retrieves the ACL template ID currently used for generating the TTag. |
void clearAclTemplateId() | The clearAclTemplateId method clears the ACL Template ID currently being used for generating the TTag. |
const _TESTD string getClassName() const =0 | The getClassName retrieves the class name. |
Member Function Documentation
TEPrincipalInfo()
The TEPrincipalInfo constructor is the default class constructor.
~TEPrincipalInfo()
The TEPrincipalInfo destructor is the class destructor.
void setPrincipalId(te_oid pid)
The setPrincipalId method sets a unique principal identifier.
Parameters
| Parameter | Description |
|---|---|
pid | An integer representing the principal ID to be set. |
te_oid getPrincipalId() const
The getPrincipalId method gets a principal identifier.
Returns: An integer representing the principal ID.
const _TESTD string getPrincipalName() const =0
The getPrincipalName method gets a principal's name.
Returns: Returns the name of a principal.
void setSystemId(uint32_t sid)
Sets a unique system identifier.
Parameters
| Parameter | Description |
|---|---|
sid | An integer representing the system ID to be set. |
uint32_t getSystemId() const
The getSystemId method gets a system identifier.
Returns: An integer representing the system ID.
void setFlag(uint32_t flag)
The setFlag method sets a principal status flag.
Parameters
| Parameter | Description |
|---|---|
flag | The principal flag to be set. |
uint32_t getFlag() const
The getFlag method gets a principal status flag.
Returns: Returns a principal status flag.
uint32_t RoleCount() const
The roleCount method gets the number of roles assigned to a TEPrincipalInfo object.
Returns: An integer representing the number of roles assigned to a TEPrincipalInfo object.
void getRoleIds(TEObjectContainer &ids) const
The getRoleIDs method gets all the role identifiers assigned to a TEPrincipalInfo object.
Parameters
| Parameter | Description |
|---|---|
ids | A container to hold the role IDs. |
bool addRole(te_oid rid)
The addRole method adds a role to a TEPrincipalInfo object.
Parameters
| Parameter | Description |
|---|---|
rid | The role ID to be added. |
bool removeRole(te_oid rid)
The removeRole method removes a role from a TEPrincipalInfo object.
Parameters
| Parameter | Description |
|---|---|
rid | The ID of the role to be removed. |
Returns: A boolean representing
void clearRoles()
The clearRoles method clears all roles from a TEPrincipalInfo object.
uint32_t GroupCount() const
The groupCount method gets the number of groups to which a principal belongs.
Returns: An integer representing the number of groups to which the principal belongs.
void getGroupIds(TEObjectContainer &gids) const
The getGroupIDs method gets all the group identifiers of all the groups to which a principal belongs.
Parameters
| Parameter | Description |
|---|---|
gids | A container to hold the group IDs. |
bool addGroup(te_oid gid)
The addGroup method adds the principal to a group..
Parameters
| Parameter | Description |
|---|---|
gid | The group ID of the group to which the principal is added. |
bool removeGroup(te_oid gid)
The removeGroup method removes a principal from a group.
Parameters
| Parameter | Description |
|---|---|
gid | The group ID of the group from which the principal is removed. |
void clearGroups()
The clearGroups method clears a principal from all groups.
void setDefaultGroup(te_oid gid)
The setDefaultGroup method sets the default group id.
Parameters
| Parameter | Description |
|---|---|
gid | An integer representing the default group ID to be added. |
te_oid getDefaultGroup() const
The getDefaultGroup method retrieves the default group id.
Returns: An integer representing the default group ID.
uint32_t ReviewerCount() const
The ReviewerCount method retrieves the number of reviewers which a principal has.
Returns: Returns the number of reviewers which the principal has.
void getReviewerIds(TEObjectContainer &rvids) const
The getReviewerIds method retrieves the identifiers of all reviewers which a principal has.
Parameters
| Parameter | Description |
|---|---|
rvids | A container to hold the reviewer IDs. |
bool addReviewer(te_oid rvid)
The addReviewer method adds a reviewer to the principal.
Parameters
| Parameter | Description |
|---|---|
rvid | The reviewer principal ID. |
Returns: A boolean representing
bool removeReviewer(te_oid rvid)
The removeReviewer method removes a reviewer from the principal.
Parameters
| Parameter | Description |
|---|---|
rvid | An integer representing the reviewer ID which is removed from the principal. |
Returns: A boolean representing
void clearReviewers()
Remove all reviewers of the principal.
void setAclTemplateId(te_oid id)
The setAclTemplateId method sets an ACL Template to be applied when generating TTag.
Parameters
| Parameter | Description |
|---|---|
id | An integer representing the ACL Template ID |
te_oid getAclTemplateId() const
The getAclTemplateId method retrieves the ACL template ID currently used for generating the TTag.
Returns: An integer representing the ACL template ID. 0 means no ACL template is set.
void clearAclTemplateId()
The clearAclTemplateId method clears the ACL Template ID currently being used for generating the TTag.
const _TESTD string getClassName() const =0
The getClassName retrieves the class name.
Returns: String of class name