Package org.bonitasoft.web.client.api

Interface FlowNodeApi

All Superinterfaces:

ApiClient.Api

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	FlowNodeApi.SearchFlowNodesQueryParams	A convenience class for generating query parameters for the searchFlowNodes method in a fluent style.

Method Summary

Modifier and Type	Method	Description
FlowNode	getFlowNodeById(String id)	Finds the FlowNode by ID Returns the single FlowNode for the given ID
ApiResponse<FlowNode>	getFlowNodeByIdWithHttpInfo(String id)	Finds the FlowNode by ID Similar to getFlowNodeById but it also returns the http response headers .
List<FlowNode>	searchFlowNodes(Integer p, Integer c, List<String> f, String o, String s)	Finds FlowNodes Finds FlowNodes with pagination params and filters - can order on `name`, `displayName`, `state`, `processDefinitionId`, `parentProcessInstanceId`, `parentActivityInstanceId` (if the retrieved flow nodes are activities, order by parent activity id), `rootProcessInstanceId`, `lastUpdateDate` - can search on any field that can be used to order results - can filter on `name`, `state`, `processId`, `parentProcessInstanceId`, `rootProcessInstanceId`, `last_update_date`
List<FlowNode>	searchFlowNodes(Map<String,Object> queryParams)	Finds FlowNodes Finds FlowNodes with pagination params and filters - can order on `name`, `displayName`, `state`, `processDefinitionId`, `parentProcessInstanceId`, `parentActivityInstanceId` (if the retrieved flow nodes are activities, order by parent activity id), `rootProcessInstanceId`, `lastUpdateDate` - can search on any field that can be used to order results - can filter on `name`, `state`, `processId`, `parentProcessInstanceId`, `rootProcessInstanceId`, `last_update_date` Note, this is equivalent to the other searchFlowNodes method, but with the query parameters collected into a single Map parameter.
ApiResponse<List<FlowNode>>	searchFlowNodesWithHttpInfo(Integer p, Integer c, List<String> f, String o, String s)	Finds FlowNodes Similar to searchFlowNodes but it also returns the http response headers .
ApiResponse<List<FlowNode>>	searchFlowNodesWithHttpInfo(Map<String,Object> queryParams)	Finds FlowNodes Finds FlowNodes with pagination params and filters - can order on `name`, `displayName`, `state`, `processDefinitionId`, `parentProcessInstanceId`, `parentActivityInstanceId` (if the retrieved flow nodes are activities, order by parent activity id), `rootProcessInstanceId`, `lastUpdateDate` - can search on any field that can be used to order results - can filter on `name`, `state`, `processId`, `parentProcessInstanceId`, `rootProcessInstanceId`, `last_update_date` Note, this is equivalent to the other searchFlowNodes that receives the query parameters as a map, but this one also exposes the Http response headers
void	updateFlowNodeById(String id, FlowNodeUpdateRequest flowNodeUpdateRequest)	Update the FlowNode by ID  Replay the flow node for the given ID.
ApiResponse<Void>	updateFlowNodeByIdWithHttpInfo(String id, FlowNodeUpdateRequest flowNodeUpdateRequest)	Update the FlowNode by ID Similar to updateFlowNodeById but it also returns the http response headers .

Method Detail

getFlowNodeById

FlowNode getFlowNodeById(String id)

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

Parameters:

id - ID of the FlowNode to return (required)

Returns:

FlowNode

getFlowNodeByIdWithHttpInfo

ApiResponse<FlowNode> getFlowNodeByIdWithHttpInfo(String id)

Finds the FlowNode by ID Similar to getFlowNodeById but it also returns the http response headers . Returns the single FlowNode for the given ID

Parameters:

id - ID of the FlowNode to return (required)

Returns:

A ApiResponse that wraps the response boyd and the http headers.

searchFlowNodes

List<FlowNode> searchFlowNodes(Integer p,
                               Integer c,
                               List<String> f,
                               String o,
                               String s)

Finds FlowNodes Finds FlowNodes with pagination params and filters - can order on `name`, `displayName`, `state`, `processDefinitionId`, `parentProcessInstanceId`, `parentActivityInstanceId` (if the retrieved flow nodes are activities, order by parent activity id), `rootProcessInstanceId`, `lastUpdateDate` - can search on any field that can be used to order results - can filter on `name`, `state`, `processId`, `parentProcessInstanceId`, `rootProcessInstanceId`, `last_update_date`

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

searchFlowNodesWithHttpInfo

ApiResponse<List<FlowNode>> searchFlowNodesWithHttpInfo(Integer p,
                                                        Integer c,
                                                        List<String> f,
                                                        String o,
                                                        String s)

Finds FlowNodes Similar to searchFlowNodes but it also returns the http response headers . Finds FlowNodes with pagination params and filters - can order on `name`, `displayName`, `state`, `processDefinitionId`, `parentProcessInstanceId`, `parentActivityInstanceId` (if the retrieved flow nodes are activities, order by parent activity id), `rootProcessInstanceId`, `lastUpdateDate` - can search on any field that can be used to order results - can filter on `name`, `state`, `processId`, `parentProcessInstanceId`, `rootProcessInstanceId`, `last_update_date`

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:

A ApiResponse that wraps the response boyd and the http headers.

searchFlowNodes

List<FlowNode> searchFlowNodes(Map<String,Object> queryParams)

Finds FlowNodes Finds FlowNodes with pagination params and filters - can order on `name`, `displayName`, `state`, `processDefinitionId`, `parentProcessInstanceId`, `parentActivityInstanceId` (if the retrieved flow nodes are activities, order by parent activity id), `rootProcessInstanceId`, `lastUpdateDate` - can search on any field that can be used to order results - can filter on `name`, `state`, `processId`, `parentProcessInstanceId`, `rootProcessInstanceId`, `last_update_date` Note, this is equivalent to the other searchFlowNodes 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 FlowNodeApi.SearchFlowNodesQueryParams 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<FlowNode>

searchFlowNodesWithHttpInfo

ApiResponse<List<FlowNode>> searchFlowNodesWithHttpInfo(Map<String,Object> queryParams)

Finds FlowNodes Finds FlowNodes with pagination params and filters - can order on `name`, `displayName`, `state`, `processDefinitionId`, `parentProcessInstanceId`, `parentActivityInstanceId` (if the retrieved flow nodes are activities, order by parent activity id), `rootProcessInstanceId`, `lastUpdateDate` - can search on any field that can be used to order results - can filter on `name`, `state`, `processId`, `parentProcessInstanceId`, `rootProcessInstanceId`, `last_update_date` Note, this is equivalent to the other searchFlowNodes that receives the query parameters as a map, but this one also exposes the Http response headers

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

updateFlowNodeById

void updateFlowNodeById(String id,
                        FlowNodeUpdateRequest flowNodeUpdateRequest)

Update the FlowNode by ID  Replay the flow node for the given ID.

Parameters:

id - ID of the FlowNode to return (required)

flowNodeUpdateRequest - Replay the flow node. (required)

updateFlowNodeByIdWithHttpInfo

ApiResponse<Void> updateFlowNodeByIdWithHttpInfo(String id,
                                                 FlowNodeUpdateRequest flowNodeUpdateRequest)

Update the FlowNode by ID Similar to updateFlowNodeById but it also returns the http response headers .  Replay the flow node for the given ID.

Parameters:

id - ID of the FlowNode to return (required)

flowNodeUpdateRequest - Replay the flow node. (required)