Package org.bonitasoft.web.client.api

Interface ProcessInstanceVariableApi

All Superinterfaces:

ApiClient.Api

@Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public interface ProcessInstanceVariableApi
extends ApiClient.Api

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ProcessInstanceVariableApi.SearchProcessInstanceVariablesQueryParams	A convenience class for generating query parameters for the searchProcessInstanceVariables method in a fluent style.

Method Summary

Modifier and Type	Method	Description
ProcessInstanceVariable	getVariableByProcessInstanceId(String id, String variableName)	Finds the Variable by ProcessInstance ID Returns the single Variable for the given ProcessInstance ID
List<ProcessInstanceVariable>	searchProcessInstanceVariables(Integer p, Integer c, List<String> f, String o)	Finds ProcessInstance Variables Finds ProcessInstance Variables with pagination params and filters
List<ProcessInstanceVariable>	searchProcessInstanceVariables(Map<String,Object> queryParams)	Finds ProcessInstance Variables Finds ProcessInstance Variables with pagination params and filters Note, this is equivalent to the other searchProcessInstanceVariables method, but with the query parameters collected into a single Map parameter.
void	updateVariableByProcessInstanceId(String id, String variableName, ProcessInstanceVariableUpdateRequest processInstanceVariableUpdateRequest)	Update a Variable by ProcessInstance ID Update the variable for the given ProcessInstance ID.

Method Detail

getVariableByProcessInstanceId

ProcessInstanceVariable getVariableByProcessInstanceId(String id,
                                                       String variableName)

Finds the Variable by ProcessInstance ID Returns the single Variable for the given ProcessInstance ID

Parameters:

id - The identifier of the process instance from which to retrieve the variable (required)

variableName - The name of the variable to retrieve (required)

Returns:

ProcessInstanceVariable

searchProcessInstanceVariables

List<ProcessInstanceVariable> searchProcessInstanceVariables(Integer p,
                                                             Integer c,
                                                             List<String> f,
                                                             String o)

Finds ProcessInstance Variables Finds ProcessInstance Variables with pagination params and filters

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)

Returns:

List<ProcessInstanceVariable>

searchProcessInstanceVariables

List<ProcessInstanceVariable> searchProcessInstanceVariables(Map<String,Object> queryParams)

Finds ProcessInstance Variables Finds ProcessInstance Variables with pagination params and filters Note, this is equivalent to the other searchProcessInstanceVariables 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 ProcessInstanceVariableApi.SearchProcessInstanceVariablesQueryParams 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)

Returns:

List<ProcessInstanceVariable>

updateVariableByProcessInstanceId

void updateVariableByProcessInstanceId(String id,
                                       String variableName,
                                       ProcessInstanceVariableUpdateRequest processInstanceVariableUpdateRequest)

Update a Variable by ProcessInstance ID Update the variable for the given ProcessInstance ID. **Warning** : only following types are supported for javaTypeclassname: `java.lang.String`, `java.lang.Integer`, `java.lang.Double`, `java.lang.Long`, `java.lang.Boolean`, `java.util.Date`

Parameters:

id - The identifier of the process instance from which to retrieve the variable (required)

variableName - The name of the variable to retrieve (required)

processInstanceVariableUpdateRequest - Partial ProcessInstance variables description (required)