Represents a collection of permissions which can be assigned to a user. More...

#include <IVxRole.h>

Public Member Functions
virtual VxResult::Value	AddPrivilege (VxNewPrivilege &newPrivilege) const =0
	Adds a new privilege to this role. More...

virtual VxResult::Value	Delete () const =0
	Deletes this instance. More...

virtual VxResult::Value	DeleteRole () const =0
	Deletes this role from the VideoXpert system. More...

virtual VxResult::Value	GetPrivileges (VxCollection< IVxPrivilege ** > &privilegeCollection) const =0
	Gets the privileges assigned to this role. More...

virtual VxResult::Value	GetUsers (VxCollection< IVxUser ** > &userCollection) const =0
	Gets the users which are currently assigned this role. More...

virtual VxResult::Value	Refresh ()=0
	Refreshes the member values for this object by retrieving its current information from the VideoXpert system. More...

virtual VxResult::Value	SetName (char name[64])=0
	Sets the name property. More...

Public Attributes
bool	isReadOnly
	Indicates whether this role is read-only. More...

char	id [64]
	The unique identifier of the role. More...

char	name [64]
	The friendly name of the role. More...

Protected Member Functions
void	Clear ()
	Clears this instance. More...

Detailed Description

Represents a collection of permissions which can be assigned to a user.

Definition at line 17 of file IVxRole.h.

Member Function Documentation

virtual VxResult::Value VxSdk::IVxRole::AddPrivilege ( VxNewPrivilege & newPrivilege ) const

pure virtual

Adds a new privilege to this role.

Parameters

newPrivilege The privilege to add.

Returns: The Result of the request.

void VxSdk::IVxRole::Clear ( )

inlineprotected

Clears this instance.

Definition at line 78 of file IVxRole.h.

                      {
             this->isReadOnly = false;
             VxZeroArray(this->id);
             VxZeroArray(this->name);
         }

virtual VxResult::Value VxSdk::IVxRole::Delete ( ) const

pure virtual

Deletes this instance.

Returns: The Result of deleting this instance.

virtual VxResult::Value VxSdk::IVxRole::DeleteRole ( ) const

pure virtual

Deletes this role from the VideoXpert system.

Returns: The Result of deleting this role.

virtual VxResult::Value VxSdk::IVxRole::GetPrivileges ( VxCollection< IVxPrivilege ** > & privilegeCollection ) const

pure virtual

Gets the privileges assigned to this role.

Parameters

privilegeCollection The privileges assigned to this role.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxRole::GetUsers ( VxCollection< IVxUser ** > & userCollection ) const

pure virtual

Gets the users which are currently assigned this role.

Available filters: kFirstName, kLastName, kModifiedSince, kName.

Parameters

userCollection A VxCollection of users which are currently assigned this role.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxRole::Refresh ( )

pure virtual

Refreshes the member values for this object by retrieving its current information from the VideoXpert system.

Returns: The Result of refreshing the member values for this object.

virtual VxResult::Value VxSdk::IVxRole::SetName ( char name[64] )

pure virtual

Sets the name property.

Parameters

name	The new name value.

Returns: The Result of setting the property.

Member Data Documentation

char VxSdk::IVxRole::id[64]

The unique identifier of the role.

Definition at line 68 of file IVxRole.h.

bool VxSdk::IVxRole::isReadOnly

Indicates whether this role is read-only.

Definition at line 64 of file IVxRole.h.

char VxSdk::IVxRole::name[64]

The friendly name of the role.

Definition at line 72 of file IVxRole.h.

The documentation for this struct was generated from the following file:

C:/Git/VXSDK_M3/VxSdk/Include/IVxRole.h

Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Member Function Documentation

Member Data Documentation