Package org.bonitasoft.web.client.api

Interface RoleApi

All Superinterfaces:

ApiClient.Api

public interface RoleApi
extends ApiClient.Api

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	RoleApi.SearchRolesQueryParams	A convenience class for generating query parameters for the searchRoles method in a fluent style.

Method Summary

Modifier and Type	Method	Description
Role	createRole(RoleCreateRequest body)	Create the Role Create the Role
void	deleteRoleById(String id)	Delete the Role by ID Delete the single Role for the given ID
Role	getRoleById(String id)	Finds the Role by ID Returns the single Role for the given ID
List<Role>	searchRoles(Integer p, Integer c, List<String> f, String o, String s)	Finds Roles Finds Roles with pagination params and filters - can order on `id`, `name` and `displayName` - can filter on `name` and `displayName`
List<Role>	searchRoles(Map<String,Object> queryParams)	Finds Roles Finds Roles with pagination params and filters - can order on `id`, `name` and `displayName` - can filter on `name` and `displayName` Note, this is equivalent to the other searchRoles method, but with the query parameters collected into a single Map parameter.
void	updateRoleById(String id, RoleUpdateRequest roleUpdateRequest)	Update the Role by ID Update the Role for the given ID

Method Detail

createRole

Role createRole(RoleCreateRequest body)

Create the Role Create the Role

Parameters:

body - Partial Role description (required)

Returns:

Role

deleteRoleById

void deleteRoleById(String id)

Delete the Role by ID Delete the single Role for the given ID

Parameters:

id - ID of the Role to delete (required)

getRoleById

Role getRoleById(String id)

Finds the Role by ID Returns the single Role for the given ID

Parameters:

id - ID of the Role to return (required)

Returns:

Role

searchRoles

List<Role> searchRoles(Integer p,
                       Integer c,
                       List<String> f,
                       String o,
                       String s)

Finds Roles Finds Roles with pagination params and filters - can order on `id`, `name` and `displayName` - can filter on `name` and `displayName`

Parameters:

p - index of the page to display (required)

c - maximum number of elements to retrieve (required)

f - can filter on attributes with the format f={filter\\_name}={filter\\_value} with the name/value pair as url encoded string. (optional)

o - can order on attributes (optional)

s - can search on attributes (optional)

Returns:

List<Role>

searchRoles

List<Role> searchRoles(Map<String,Object> queryParams)

Finds Roles Finds Roles with pagination params and filters - can order on `id`, `name` and `displayName` - can filter on `name` and `displayName` Note, this is equivalent to the other searchRoles method, but with the query parameters collected into a single Map parameter. This is convenient for services with optional query parameters, especially when used with the RoleApi.SearchRolesQueryParams class that allows for building up this map in a fluent style.

Parameters:

queryParams - Map of query parameters as name-value pairs

The following elements may be specified in the query map:

• p - index of the page to display (required)
• c - maximum number of elements to retrieve (required)
• f - can filter on attributes with the format f={filter\\_name}={filter\\_value} with the name/value pair as url encoded string. (optional)
• o - can order on attributes (optional)
• s - can search on attributes (optional)

Returns:

List<Role>

updateRoleById

void updateRoleById(String id,
                    RoleUpdateRequest roleUpdateRequest)

Update the Role by ID Update the Role for the given ID

Parameters:

id - ID of the Role to return (required)

roleUpdateRequest - Partial Role description (required)