Package org.bonitasoft.web.client.api

Interface ProcessSupervisorApi

All Superinterfaces:

ApiClient.Api

public interface ProcessSupervisorApi
extends ApiClient.Api

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ProcessSupervisorApi.SearchProcessSupervisorsQueryParams	A convenience class for generating query parameters for the searchProcessSupervisors method in a fluent style.

Method Summary

Modifier and Type	Method	Description
ProcessSupervisor	createProcessSupervisor(ProcessSupervisor body)	Create the ProcessSupervisor Create the ProcessSupervisor
void	deleteProcessSupervisorById(List<String> requestBody)	Delete the ProcessSupervisor by ID Delete the ProcessSupervisor for the given compoound IDs You can delete a process supervisor by specifying its compound Id in the body of the request with the following format: `process_id/user_id/role_id/group_id`
List<ProcessSupervisor>	searchProcessSupervisors(Integer p, Integer c, List<String> f, String o, String s)	Finds ProcessSupervisors Finds ProcessSupervisors with pagination params and filters To filter, you need to specify the `process_id`, and then the `user_id`, `group_id` and `role_id` with one of them (two if you want to filter on group and role) set to `>0` and the other ones set to `-1`.
List<ProcessSupervisor>	searchProcessSupervisors(Map<String,Object> queryParams)	Finds ProcessSupervisors Finds ProcessSupervisors with pagination params and filters To filter, you need to specify the `process_id`, and then the `user_id`, `group_id` and `role_id` with one of them (two if you want to filter on group and role) set to `>0` and the other ones set to `-1`.

Method Detail

createProcessSupervisor

ProcessSupervisor createProcessSupervisor(ProcessSupervisor body)

Create the ProcessSupervisor Create the ProcessSupervisor

Parameters:

body - The process definition id and either the user, role and/or group id. (required)

Returns:

ProcessSupervisor

deleteProcessSupervisorById

void deleteProcessSupervisorById(List<String> requestBody)

Delete the ProcessSupervisor by ID Delete the ProcessSupervisor for the given compoound IDs You can delete a process supervisor by specifying its compound Id in the body of the request with the following format: `process_id/user_id/role_id/group_id`

Parameters:

requestBody - The process definition id and either the user, role and/or group id. (required)

searchProcessSupervisors

List<ProcessSupervisor> searchProcessSupervisors(Integer p,
                                                 Integer c,
                                                 List<String> f,
                                                 String o,
                                                 String s)

Finds ProcessSupervisors Finds ProcessSupervisors with pagination params and filters To filter, you need to specify the `process_id`, and then the `user_id`, `group_id` and `role_id` with one of them (two if you want to filter on group and role) set to `>0` and the other ones set to `-1`. E.g.: `f=process_id%3D8040901857674754544&f=user_id%3D>0&f=group_id%3D-1&f=role_id%3D-1`

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<ProcessSupervisor>

searchProcessSupervisors

List<ProcessSupervisor> searchProcessSupervisors(Map<String,Object> queryParams)

Finds ProcessSupervisors Finds ProcessSupervisors with pagination params and filters To filter, you need to specify the `process_id`, and then the `user_id`, `group_id` and `role_id` with one of them (two if you want to filter on group and role) set to `>0` and the other ones set to `-1`. E.g.: `f=process_id%3D8040901857674754544&f=user_id%3D>0&f=group_id%3D-1&f=role_id%3D-1` Note, this is equivalent to the other searchProcessSupervisors 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 ProcessSupervisorApi.SearchProcessSupervisorsQueryParams 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<ProcessSupervisor>