openDAQ
Open data acquisition platform
IPermissions Struct Referenceabstract

A class which describes a permission configuration for openDAQ object.A configuration object can be constructed using the permission builder class. More...

+ Inheritance diagram for IPermissions:
+ Collaboration diagram for IPermissions:

Detailed Description

A class which describes a permission configuration for openDAQ object.A configuration object can be constructed using the permission builder class.

Public Member Functions

virtual ErrCode INTERFACE_FUNC getInherited (Bool *isInherited)=0
 Returns true if an object should inherit permissions from its parent object. More...
 
virtual ErrCode INTERFACE_FUNC getAllowed (IDict **permissions)=0
 Returns a dictionary of allowed permissions for each group. More...
 
virtual ErrCode INTERFACE_FUNC getDenied (IDict **permissions)=0
 Returns a dictionary of denied permissions for each group. More...
 
- Public Member Functions inherited from IBaseObject
virtual ErrCode INTERFACE_FUNC borrowInterface (const IntfID &intfID, void **obj) const =0
 Returns another interface which is supported by the object without incrementing the reference count. More...
 
virtual ErrCode INTERFACE_FUNC dispose ()=0
 Disposes all references held by the object. More...
 
virtual ErrCode INTERFACE_FUNC getHashCode (SizeT *hashCode)=0
 Returns hash code of the object. More...
 
virtual ErrCode INTERFACE_FUNC equals (IBaseObject *other, Bool *equal) const =0
 Compares object to another object for equality. More...
 
virtual ErrCode INTERFACE_FUNC toString (CharPtr *str)=0
 Returns a string representation of the object. More...
 
- Public Member Functions inherited from IUnknown
virtual ErrCode INTERFACE_FUNC queryInterface (const IntfID &intfID, void **obj)=0
 Returns another interface which is supported by the object and increments the reference count. More...
 
virtual int INTERFACE_FUNC addRef ()=0
 Increments the reference count for an interface on an object. More...
 
virtual int INTERFACE_FUNC releaseRef ()=0
 Decrements the reference count for an interface on an object. More...
 

Member Function Documentation

◆ getAllowed()

virtual ErrCode INTERFACE_FUNC getAllowed ( IDict **  permissions)
pure virtual

Returns a dictionary of allowed permissions for each group.

Parameters
permissions[out]A dictionary of allowed permissions for each group.

◆ getDenied()

virtual ErrCode INTERFACE_FUNC getDenied ( IDict **  permissions)
pure virtual

Returns a dictionary of denied permissions for each group.

Parameters
permissions[out]A dictionary of denied permissions for each group.

◆ getInherited()

virtual ErrCode INTERFACE_FUNC getInherited ( Bool *  isInherited)
pure virtual

Returns true if an object should inherit permissions from its parent object.

Parameters
isInherited[out]True if permissions should be inherited from parent object.