CPPCli::Role Class Reference

The Role class represents a collection of permissions which can be assigned to a user. More...

#include <Role.h>

Public Member Functions
	Role (VxSdk::IVxRole *vxRole)
	Constructor. More...
virtual	~Role ()
	Destructor. More...
	!Role ()
	Finaliser. More...
CPPCli::Results::Value	AddPrivilege (CPPCli::NewPrivilege^ newPrivilege)
	Add a new privilege to the role. More...
Results::Value	Refresh ()
	Update this instances properties. More...
CPPCli::Results::Value	RemovePrivilege (CPPCli::Privilege^ privilegeItem)
	Remove a privilege from the role. More...

Package Functions
System::Collections::Generic::List< Privilege^ >^	_GetPrivileges ()
System::Collections::Generic::List< User^ >^	_GetUsers ()

Package Attributes
VxSdk::IVxRole *	_role

Properties
System::String^	Id [get]
	Gets the unique identifier for this role. More...
bool	IsReadOnly [get]
	Indicates that the role was created internally on the server and is read-only. More...
System::String^	Name [get, set]
	Gets or sets the friendly name. More...
System::Collections::Generic::List< Privilege^ >^	Privileges [get]
	Gets the privileges assigned to this role. More...
System::Collections::Generic::List< User^ >^	Users [get]
	Gets the users assigned to this role. More...

Detailed Description

The Role class represents a collection of permissions which can be assigned to a user.

Definition at line 14 of file Role.h.

Constructor & Destructor Documentation

CPPCli::Role::Role

(

VxSdk::IVxRole *

vxRole

)

Constructor.

Parameters

vxRole

The vx role.

Definition at line 10 of file Role.cpp.

                                     {
    _role = vxRole;
}

virtual CPPCli::Role::~Role ( )

inlinevirtual

Destructor.

Definition at line 26 of file Role.h.

                        {
            this->!Role();
        }

CPPCli::Role::!Role

(

)

Finaliser.

Definition at line 14 of file Role.cpp.

                  {
    _role->Delete();
    _role = nullptr;
}

Member Function Documentation

System::Collections::Generic::List< CPPCli::Privilege^ > CPPCli::Role::_GetPrivileges ( )

package

Definition at line 40 of file Role.cpp.

                                                                           {
    // Create a list of managed privileges
    List<Privilege^>^ mlist = gcnew List<Privilege^>();
    // Create a collection of unmanaged privileges
    VxSdk::VxCollection<VxSdk::IVxPrivilege**> privileges;

    // Make the GetPrivileges call, which will return with the total privilege count, this allows the
    // client to allocate memory.
    VxSdk::VxResult::Value result = _role->GetPrivileges(privileges);
    // As long as there are privileges linked the result should be VxSdk::VxResult::kInsufficientSize
    if (result == VxSdk::VxResult::kInsufficientSize) {
        // Allocate enough space for the IVxPrivilege collection
        privileges.collection = new VxSdk::IVxPrivilege*[privileges.collectionSize];
        result = _role->GetPrivileges(privileges);
        // The result should now be kOK since we have allocated enough space
        if (result == VxSdk::VxResult::kOK) {
            for (int i = 0; i < privileges.collectionSize; i++)
                mlist->Add(gcnew Privilege(privileges.collection[i]));
        }
        // Remove the memory we previously allocated to the collection
        delete[] privileges.collection;
    }
    return mlist;
}

System::Collections::Generic::List< CPPCli::User^ > CPPCli::Role::_GetUsers ( )

package

Definition at line 65 of file Role.cpp.

                                                                 {
    // Create a list of managed users
    List<User^>^ mlist = gcnew List<User^>();
    // Create a collection of unmanaged users
    VxSdk::VxCollection<VxSdk::IVxUser**> users;

    // Make the GetUsers call, which will return with the total user count, this
    // allows the client to allocate memory.
    VxSdk::VxResult::Value result = _role->GetUsers(users);
    // As long as there are users linked the result should be VxSdk::VxResult::kInsufficientSize
    if (result == VxSdk::VxResult::kInsufficientSize) {
        // Allocate enough space for the IVxUser collection
        users.collection = new VxSdk::IVxUser*[users.collectionSize];
        result = _role->GetUsers(users);
        // The result should now be kOK since we have allocated enough space
        if (result == VxSdk::VxResult::kOK) {
            for (int i = 0; i < users.collectionSize; i++)
                mlist->Add(gcnew User(users.collection[i]));
        }
        // Remove the memory we previously allocated to the collection
        delete[] users.collection;
    }
    return mlist;
}

CPPCli::Results::Value CPPCli::Role::AddPrivilege

(

CPPCli::NewPrivilege^

newPrivilege

)

Add a new privilege to the role.

Parameters

newPrivilege

The new privilege to add.

Returns

The Result of adding the privilege.

Definition at line 19 of file Role.cpp.

                                                                            {
    // Make the call to add the privilege to the role
    VxSdk::VxResult::Value result = _role->AddPrivilege(*newPrivilege->_newPrivilege);
    // Unless there was an issue merging tags the result should be VxSdk::VxResult::kOK
    return CPPCli::Results::Value(result);
}

CPPCli::Results::Value CPPCli::Role::Refresh

(

)

Update this instances properties.

Returns

The Result of updating the properties.

Definition at line 26 of file Role.cpp.

                                       {
    return (CPPCli::Results::Value)_role->Refresh();
}

CPPCli::Results::Value CPPCli::Role::RemovePrivilege

(

CPPCli::Privilege^

privilegeItem

)

Remove a privilege from the role.

Parameters

privilegeItem

The privilege to remove.

Returns

The Result of removing the privilege.

Definition at line 30 of file Role.cpp.

                                                                             {
    // Create a privilege object using the privilegeItem
    VxSdk::IVxPrivilege* delPrivilege = privilegeItem->_privilege;

    // To remove a privilege simply make a DeletePrivilege call
    VxSdk::VxResult::Value result = delPrivilege->DeletePrivilege();
    // Unless there was an issue removing the privilege the result should be VxSdk::VxResult::kOK
    return CPPCli::Results::Value(result);
}

Member Data Documentation

VxSdk::IVxRole* CPPCli::Role::_role

package

Definition at line 106 of file Role.h.

Property Documentation

System:: String^ CPPCli::Role::Id

get

Gets the unique identifier for this role.

The unique identifier.

Definition at line 59 of file Role.h.

bool CPPCli::Role::IsReadOnly

get

Indicates that the role was created internally on the server and is read-only.

The read-only value.

Definition at line 68 of file Role.h.

System:: String^ CPPCli::Role::Name

getset

Gets or sets the friendly name.

The friendly name.

Definition at line 77 of file Role.h.

System:: Collections:: Generic:: List< Privilege^>^ CPPCli::Role::Privileges

get

Gets the privileges assigned to this role.

A list of privileges.

Definition at line 91 of file Role.h.

System:: Collections:: Generic:: List< User^>^ CPPCli::Role::Users

get

Gets the users assigned to this role.

A list of users.

Definition at line 100 of file Role.h.

---

The documentation for this class was generated from the following files:

• C:/Git/VxSDK-Samples/CSharpSample/CSharpWrapper/Include/Role.h
• C:/Git/VxSDK-Samples/CSharpSample/CSharpWrapper/Source/Role.cpp