Represents a specific permission that is given to a role. More...

#include <IVxPrivilege.h>

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

virtual VxResult::Value	DeletePrivilege () const =0
	Removes this privilege from the associated role. More...

virtual VxResult::Value	GetLinks (VxCollection< IVxDataSource ** > &dataSourceCollection) const =0
	Gets the data sources associated with this privilege. More...

virtual VxResult::Value	GetLinks (VxCollection< IVxDevice ** > &deviceCollection) const =0
	Gets the devices associated with this privilege. More...

virtual VxResult::Value	GetLinks (VxCollection< IVxUser ** > &userCollection) const =0
	Gets the users associated with this privilege. More...

virtual VxResult::Value	GetPriority (int &priority) const =0
	Gets the relative priority for the privilege. More...

virtual VxResult::Value	GetRestricted (bool &isRestricted) const =0
	Gets the restriction level for this privilege. More...

virtual VxResult::Value	GetUnLinked (VxCollection< IVxDataSource ** > &dataSourceCollection) const =0
	Gets the data sources not associated with this privilege. More...

virtual VxResult::Value	GetUnLinked (VxCollection< IVxDevice ** > &deviceCollection) const =0
	Gets the devices not associated with this privilege. More...

virtual VxResult::Value	GetUnLinked (VxCollection< IVxUser ** > &userCollection) const =0
	Gets the users not associated with this privilege. More...

virtual VxResult::Value	Link (IVxDataSource &dataSource) const =0
	Associates a data source with this privilege. If the data source is deleted, the association with this privilege shall also be removed. More...

virtual VxResult::Value	Link (IVxDevice &device) const =0
	Associates a device with this privilege. If the device is deleted, the association with this privilege shall also be removed. More...

virtual VxResult::Value	Link (IVxUser &user) const =0
	Associates a user with this privilege. If the user is deleted, the association with this privilege shall also be removed. 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	SetExcludeRestricted (bool excludeRestricted)=0
	Sets whether the privilege is excluded from the associated resources. More...

virtual VxResult::Value	SetPriority (int priority) const =0
	Sets the relative priority for the privilege, from 1 to 250. Smaller numbers have higher priority than larger numbers (e.g. 1 is the highest priority). More...

virtual VxResult::Value	SetRestricted (bool isRestricted) const =0
	Sets the restriction level for this privilege to the associated resources. More...

virtual VxResult::Value	UnLink (IVxDataSource &dataSource) const =0
	Removes a data source association from this privilege. More...

virtual VxResult::Value	UnLink (IVxDevice &device) const =0
	Removes a device association from this privilege. More...

virtual VxResult::Value	UnLink (IVxUser &user) const =0
	Removes a user association from this privilege. More...

Public Attributes
bool	excludeRestricted
	Indicates whether the privilege is excluded from the associated resources. More...

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

VxPermissionId::Value	permissionId
	The permission being granted by this privilege. More...

VxResourceType::Value	resourceType
	The resource type supported by this privilege, if any. More...

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

Detailed Description

Represents a specific permission that is given to a role.

Definition at line 15 of file IVxPrivilege.h.

Member Function Documentation

void VxSdk::IVxPrivilege::Clear ( )

inlineprotected

Clears this instance.

Definition at line 167 of file IVxPrivilege.h.

                      {
             this->excludeRestricted = false;
             VxZeroArray(this->id);
             this->permissionId = VxPermissionId::kUnknown;
             this->resourceType = VxResourceType::kUnknown;
         }

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

pure virtual

Deletes this instance.

Returns: The Result of deleting this instance.

virtual VxResult::Value VxSdk::IVxPrivilege::DeletePrivilege ( ) const

pure virtual

Removes this privilege from the associated role.

Returns: The Result of deleting this privilege.

virtual VxResult::Value VxSdk::IVxPrivilege::GetLinks ( VxCollection< IVxDataSource ** > & dataSourceCollection ) const

pure virtual

Gets the data sources associated with this privilege.

Available filters: kAllTags, kAllPrivateTags, kModifiedSince.

Parameters

dataSourceCollection The data sources associated with this privilege.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxPrivilege::GetLinks ( VxCollection< IVxDevice ** > & deviceCollection ) const

pure virtual

Gets the devices associated with this privilege.

Available filters: kAllTags, kAllPrivateTags, kModifiedSince.

Parameters

deviceCollection The devices associated with this privilege.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxPrivilege::GetLinks ( VxCollection< IVxUser ** > & userCollection ) const

pure virtual

Gets the users associated with this privilege.

Available filters: kAllTags, kAllPrivateTags, kModifiedSince.

Parameters

userCollection The users associated with this privilege.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxPrivilege::GetPriority ( int & priority ) const

pure virtual

Gets the relative priority for the privilege.

Parameters

priority The priority level for the privilege.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxPrivilege::GetRestricted ( bool & isRestricted ) const

pure virtual

Gets the restriction level for this privilege.

Parameters

isRestricted True if restricted, false if not.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxPrivilege::GetUnLinked ( VxCollection< IVxDataSource ** > & dataSourceCollection ) const

pure virtual

Gets the data sources not associated with this privilege.

Available filters: kAllTags, kAllPrivateTags, kModifiedSince.

Parameters

dataSourceCollection The data sources not associated with this privilege.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxPrivilege::GetUnLinked ( VxCollection< IVxDevice ** > & deviceCollection ) const

pure virtual

Gets the devices not associated with this privilege.

Available filters: kAllTags, kAllPrivateTags, kModifiedSince.

Parameters

deviceCollection The devices not associated with this privilege.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxPrivilege::GetUnLinked ( VxCollection< IVxUser ** > & userCollection ) const

pure virtual

Gets the users not associated with this privilege.

Available filters: kAllTags, kAllPrivateTags, kModifiedSince.

Parameters

userCollection The users not associated with this privilege.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxPrivilege::Link ( IVxDataSource & dataSource ) const

pure virtual

Associates a data source with this privilege. If the data source is deleted, the association with this privilege shall also be removed.

Parameters

dataSource The data source to associate the privilege with.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxPrivilege::Link ( IVxDevice & device ) const

pure virtual

Associates a device with this privilege. If the device is deleted, the association with this privilege shall also be removed.

Parameters

device The device to associate the privilege with.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxPrivilege::Link ( IVxUser & user ) const

pure virtual

Associates a user with this privilege. If the user is deleted, the association with this privilege shall also be removed.

Parameters

user	The user to associate the privilege with.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxPrivilege::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::IVxPrivilege::SetExcludeRestricted ( bool excludeRestricted )

pure virtual

Sets whether the privilege is excluded from the associated resources.

Parameters

excludeRestricted True to exclude this privilege from associated resources, otherwise false.

Returns: The Result of setting the property.

virtual VxResult::Value VxSdk::IVxPrivilege::SetPriority ( int priority ) const

pure virtual

Sets the relative priority for the privilege, from 1 to 250. Smaller numbers have higher priority than larger numbers (e.g. 1 is the highest priority).

Parameters

priority The priority level for the privilege.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxPrivilege::SetRestricted ( bool isRestricted ) const

pure virtual

Sets the restriction level for this privilege to the associated resources.

Parameters

isRestricted True if restricted, false if not.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxPrivilege::UnLink ( IVxDataSource & dataSource ) const

pure virtual

Removes a data source association from this privilege.

Parameters

dataSource The data source to remove association with.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxPrivilege::UnLink ( IVxDevice & device ) const

pure virtual

Removes a device association from this privilege.

Parameters

device The device to remove association with.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxPrivilege::UnLink ( IVxUser & user ) const

pure virtual

Removes a user association from this privilege.

Parameters

user	The user to remove association with.

Returns: The Result of the request.

Member Data Documentation

bool VxSdk::IVxPrivilege::excludeRestricted

Indicates whether the privilege is excluded from the associated resources.

Definition at line 149 of file IVxPrivilege.h.

char VxSdk::IVxPrivilege::id[64]

The unique identifier of the privilege.

Definition at line 153 of file IVxPrivilege.h.

VxPermissionId::Value VxSdk::IVxPrivilege::permissionId

The permission being granted by this privilege.

Definition at line 157 of file IVxPrivilege.h.

VxResourceType::Value VxSdk::IVxPrivilege::resourceType

The resource type supported by this privilege, if any.

Definition at line 161 of file IVxPrivilege.h.

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

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

Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Member Function Documentation

Member Data Documentation