ERUCES::TEGroupInfo
#include <tegroup.h>
The TEGroupInfo class represents a group.
The TEGroupInfo class is derived from the TEPrincipalInfo class.
© Pi Soft, 2018-2026 · Tricryption Engine 8.1
Inheritance
- Inherits ERUCES::TEPrincipalInfo
Static Public Attributes
| Type | Name | Description |
|---|---|---|
| _TESTD string | CLASSNAME |
Public Member Functions
| Member | Description |
|---|---|
TEGroupInfo() | The TEGroupInfo constructor is the default class constructor. |
TEGroupInfo(const TEGroupInfo &) | The TEGroupInfo constructor copies a TEGroupInfo object. |
TEGroupInfo & operator=(const TEGroupInfo &) | The = operator assigns a deep copy of the source's implementation object to this object (self-assignment safe; the previous implementation object is freed). |
~TEGroupInfo() | The TEGroupInfo destructor is the class destructor. |
const _TESTD string getPrincipalName() const | The getPrincipalName method gets a principal's name. |
void setGroupName(const _TESTD string &name) | The setGroupName method sets a group name. |
const _TESTD string getGroupName() const | The getGroupName method gets a group name. |
size_t PrincipalCount() const | The principalCount method gets the number of principals in a group. |
void getPrincipalIds(TEObjectContainer &container) const | The getPrincipalIDs method gets all the principal identifiers of a group. |
bool addPrincipal(te_oid nid) | The addPrincipal method adds a principal to a group. |
bool removePrincipal(te_oid nid) | The removePrincipal method removes a principal from a group. |
void clearPrincipals() | The clearPrincipals method clears all principals from a TEGroupInfo object. |
const _TESTD string getClassName() const | The getClassName method gets a TEGroupInfo object's class name. |
TEObject * clone() const | The clone method clones a TEGroupInfo object. |
Member Function Documentation
TEGroupInfo()
The TEGroupInfo constructor is the default class constructor.
TEGroupInfo(const TEGroupInfo &)
The TEGroupInfo constructor copies a TEGroupInfo object.
Parameters
| Parameter | Description |
|---|---|
& | A TEGroupInfo object to be copied. |
TEGroupInfo & operator=(const TEGroupInfo &)
The = operator assigns a deep copy of the source's implementation object to this object (self-assignment safe; the previous implementation object is freed).
TE81-448 (W36 round 1): until this round the implicit member copied the pointer, so the assignee and the source freed one object twice.
~TEGroupInfo()
The TEGroupInfo destructor is the class destructor.
const _TESTD string getPrincipalName() const
The getPrincipalName method gets a principal's name.
Remark: It's the same as group name.
Returns: Returns a group's principal name.
void setGroupName(const _TESTD string &name)
The setGroupName method sets a group name.
Parameters
| Parameter | Description |
|---|---|
name | A string representing the group name to be set. |
const _TESTD string getGroupName() const
The getGroupName method gets a group name.
Returns: Returns a string representing the group name.
size_t PrincipalCount() const
The principalCount method gets the number of principals in a group.
Returns: Returns the number of principals in a group.
void getPrincipalIds(TEObjectContainer &container) const
The getPrincipalIDs method gets all the principal identifiers of a group.
Parameters
| Parameter | Description |
|---|---|
container | A container to hold the returned principal IDs. |
bool addPrincipal(te_oid nid)
The addPrincipal method adds a principal to a group.
Parameters
| Parameter | Description |
|---|---|
nid | The ID of the principal to be added. |
Returns: Returns a boolean value indicating if the principal has been added to the group successfully.
bool removePrincipal(te_oid nid)
The removePrincipal method removes a principal from a group.
Parameters
| Parameter | Description |
|---|---|
nid | The ID of the principal to be removed. |
Returns: Returns a boolean value indicating if the principal has been removed from the group successfully.
void clearPrincipals()
The clearPrincipals method clears all principals from a TEGroupInfo object.
const _TESTD string getClassName() const
The getClassName method gets a TEGroupInfo object's class name.
Returns: Returns a string representing the class name of a TEGroupInfo object.
TEObject * clone() const
The clone method clones a TEGroupInfo object.
Returns: Returns a cloned TEGroupInfo object.
Examples
- cpp_admin_group_addto_2.cpp
- cpp_admin_group_removefrom_2.cpp
- cpp_admin_principal_add.cpp
- cpp_admin_principal_defaultgroup_set.cpp
- cpp_admin_principal_get.cpp
- cpp_admin_principal_getList.cpp
- cpp_admin_principal_getbyid_1.cpp
- cpp_admin_principal_getbyid_2.cpp
- cpp_admin_principal_getbyid_3.cpp
- cpp_admin_principal_group_add.cpp
- cpp_admin_principal_group_remove.cpp
- cpp_admin_principal_remove.cpp
- cpp_admin_principal_update.cpp
- cpp_admin_query.cpp