Package org.bonitasoft.web.client.api

Interface ArchivedFlowNodeApi

  • All Superinterfaces:
    ApiClient.Api
    @Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public interface ArchivedFlowNodeApi
extends ApiClient.Api

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      ArchivedFlowNode getArchivedFlowNodeById​(String id)
      Finds the ArchivedFlowNode by ID Returns the single ArchivedFlowNode for the given ID
      List<ArchivedFlowNode> searchArchivedFlowNodes​(Integer p, Integer c, List<String> f, String o, String s)
      Finds ArchivedFlowNodes Finds ArchivedFlowNodes with pagination params and filters - can order on `name`, `displayName`, `state`, `type`, `isTerminal`, `processId`, `caseId`, `archivedDate` - can search on any field that can be used to order results - can filter on `name`, `displayName`, `state`, `stateId`, `kind`, `terminal`, `processDefinitionId`, `parentProcessInstanceId`, `rootProcessInstanceId`, `parentActivityInstanceId`, `archivedDate`, `reachedStateDate`, `sourceObjectId`
      List<ArchivedFlowNode> searchArchivedFlowNodes​(Map<String,​Object> queryParams)
      Finds ArchivedFlowNodes Finds ArchivedFlowNodes with pagination params and filters - can order on `name`, `displayName`, `state`, `type`, `isTerminal`, `processId`, `caseId`, `archivedDate` - can search on any field that can be used to order results - can filter on `name`, `displayName`, `state`, `stateId`, `kind`, `terminal`, `processDefinitionId`, `parentProcessInstanceId`, `rootProcessInstanceId`, `parentActivityInstanceId`, `archivedDate`, `reachedStateDate`, `sourceObjectId` Note, this is equivalent to the other searchArchivedFlowNodes method, but with the query parameters collected into a single Map parameter.

    • Method Detail

      • getArchivedFlowNodeById

        ArchivedFlowNode getArchivedFlowNodeById​(String id)
        Finds the ArchivedFlowNode by ID Returns the single ArchivedFlowNode for the given ID
        Parameters:
        id - ID of the ArchivedFlowNode to return (required)
        Returns:
        ArchivedFlowNode

      • searchArchivedFlowNodes

        List<ArchivedFlowNode> searchArchivedFlowNodes​(Integer p,
                                               Integer c,
                                               List<String> f,
                                               String o,
                                               String s)
        Finds ArchivedFlowNodes Finds ArchivedFlowNodes with pagination params and filters - can order on `name`, `displayName`, `state`, `type`, `isTerminal`, `processId`, `caseId`, `archivedDate` - can search on any field that can be used to order results - can filter on `name`, `displayName`, `state`, `stateId`, `kind`, `terminal`, `processDefinitionId`, `parentProcessInstanceId`, `rootProcessInstanceId`, `parentActivityInstanceId`, `archivedDate`, `reachedStateDate`, `sourceObjectId`
        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<ArchivedFlowNode>

      • searchArchivedFlowNodes

        List<ArchivedFlowNode> searchArchivedFlowNodes​(Map<String,​Object> queryParams)
        Finds ArchivedFlowNodes Finds ArchivedFlowNodes with pagination params and filters - can order on `name`, `displayName`, `state`, `type`, `isTerminal`, `processId`, `caseId`, `archivedDate` - can search on any field that can be used to order results - can filter on `name`, `displayName`, `state`, `stateId`, `kind`, `terminal`, `processDefinitionId`, `parentProcessInstanceId`, `rootProcessInstanceId`, `parentActivityInstanceId`, `archivedDate`, `reachedStateDate`, `sourceObjectId` Note, this is equivalent to the other searchArchivedFlowNodes 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 ArchivedFlowNodeApi.SearchArchivedFlowNodesQueryParams 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<ArchivedFlowNode>