PHP Class Scalr\Api\Service\User\V1beta0\Controller\RoleCategories

Since: 5.4.0 (18.03.2015)
Author: Vitaliy Demidov ([email protected])
Inheritance: extends Scalr\Api\Rest\Controller\ApiController
Show file Open project: scalr/scalr

Public Methods

Method Description
createAction ( ) : Scalr\Api\DataType\ResultEnvelope Create a new Role Category in this Environment or account
deleteAction ( integer $roleCategoryId ) : Scalr\Api\DataType\ResultEnvelope Deletes the Role Category from the environment or account
describeAction ( ) Gets the list of the available Role Categories
fetchAction ( integer $roleCategoryId ) : Scalr\Api\DataType\ResultEnvelope Gets the specified Role Category
modifyAction ( integer $roleCategoryId ) : Scalr\Api\DataType\ResultEnvelope Modifies Role Category attributes

Private Methods

Method Description
getDefaultCriteria ( ) : array Gets default search criteria for Role Categories
getRoleCategory ( integer $roleCategoryId, boolean $restrictToCurrentScope = false ) : RoleCategory Gets RoleCategory from database using User's Environement

Method Details

createAction() public method

Create a new Role Category in this Environment or account
public createAction ( ) : Scalr\Api\DataType\ResultEnvelope
return Scalr\Api\DataType\ResultEnvelope

deleteAction() public method

Deletes the Role Category from the environment or account
public deleteAction ( integer $roleCategoryId ) : Scalr\Api\DataType\ResultEnvelope
$roleCategoryId integer The identifier of the Role Category
return Scalr\Api\DataType\ResultEnvelope

describeAction() public method

Gets the list of the available Role Categories
public describeAction ( )

fetchAction() public method

Gets the specified Role Category
public fetchAction ( integer $roleCategoryId ) : Scalr\Api\DataType\ResultEnvelope
$roleCategoryId integer The identifier of the Role Category
return Scalr\Api\DataType\ResultEnvelope

modifyAction() public method

Modifies Role Category attributes
public modifyAction ( integer $roleCategoryId ) : Scalr\Api\DataType\ResultEnvelope
$roleCategoryId integer The identifier of the Role Category
return Scalr\Api\DataType\ResultEnvelope