Package org.alfresco.rm.rest.api

Interface RMRoles

All Known Implementing Classes:

RMRolesImpl

public interface RMRoles

RM Roles API

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PARAM_CAPABILITY_NAME
static final String	PARAM_INCLUDE_ASSIGNED_GROUPS
static final String	PARAM_INCLUDE_ASSIGNED_USERS
static final String	PARAM_INCLUDE_SYSTEM_ROLES
static final String	PARAM_PERSON_ID

Method Summary

Modifier and Type	Method	Description
CollectionWithPagingInfo<RoleModel>	getRoles(NodeRef filePlan, Parameters parameters)	Gets a list of roles.

Field Details

PARAM_INCLUDE_ASSIGNED_USERS

static final String PARAM_INCLUDE_ASSIGNED_USERS

See Also:

• Constant Field Values

PARAM_INCLUDE_ASSIGNED_GROUPS

static final String PARAM_INCLUDE_ASSIGNED_GROUPS

See Also:

• Constant Field Values

PARAM_INCLUDE_SYSTEM_ROLES

static final String PARAM_INCLUDE_SYSTEM_ROLES

See Also:

• Constant Field Values

PARAM_CAPABILITY_NAME

static final String PARAM_CAPABILITY_NAME

See Also:

• Constant Field Values

PARAM_PERSON_ID

static final String PARAM_PERSON_ID

See Also:

• Constant Field Values

Method Details

getRoles

CollectionWithPagingInfo<RoleModel> getRoles(NodeRef filePlan,
 Parameters parameters)

Gets a list of roles.

Parameters:

filePlan - the file plan node reference

parameters - the Parameters object to get the parameters passed into the request including: - filter, sort & paging params (where, orderBy, skipCount, maxItems) - include param (personId, includeSystemRoles)

Returns:

a paged list of org.alfresco.rm.rest.api.model.RoleModel objects