Package org.bonitasoft.web.client.api

Interface ArchivedTaskApi

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static class  ArchivedTaskApi.SearchArchivedTasksQueryParams
      A convenience class for generating query parameters for the searchArchivedTasks method in a fluent style.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      ArchivedTask getArchivedTaskById​(String id)
      Finds the ArchivedTask by ID Returns the single ArchivedTask for the given ID
      List<ArchivedTask> searchArchivedTasks​(Integer p, Integer c, List<String> f, String o)
      Finds ArchivedTasks Finds ArchivedTasks with pagination params and filters - Can order on `caseId`, `name`, `displayName`, `processId`, `state`, `type`, `archivedDate`, `reached_state_date`, `assigned_id` - Can filter on `caseId`, `name`, `displayName`, `processId`, `state`, `type`, `archivedDate`, `reached_state_date`, `assigned_id`, `isTerminal`
      List<ArchivedTask> searchArchivedTasks​(Map<String,​Object> queryParams)
      Finds ArchivedTasks Finds ArchivedTasks with pagination params and filters - Can order on `caseId`, `name`, `displayName`, `processId`, `state`, `type`, `archivedDate`, `reached_state_date`, `assigned_id` - Can filter on `caseId`, `name`, `displayName`, `processId`, `state`, `type`, `archivedDate`, `reached_state_date`, `assigned_id`, `isTerminal` Note, this is equivalent to the other searchArchivedTasks method, but with the query parameters collected into a single Map parameter.

    • Method Detail

      • getArchivedTaskById

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

      • searchArchivedTasks

        List<ArchivedTask> searchArchivedTasks​(Integer p,
                                       Integer c,
                                       List<String> f,
                                       String o)
        Finds ArchivedTasks Finds ArchivedTasks with pagination params and filters - Can order on `caseId`, `name`, `displayName`, `processId`, `state`, `type`, `archivedDate`, `reached_state_date`, `assigned_id` - Can filter on `caseId`, `name`, `displayName`, `processId`, `state`, `type`, `archivedDate`, `reached_state_date`, `assigned_id`, `isTerminal`
        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<ArchivedTask>

      • searchArchivedTasks

        List<ArchivedTask> searchArchivedTasks​(Map<String,​Object> queryParams)
        Finds ArchivedTasks Finds ArchivedTasks with pagination params and filters - Can order on `caseId`, `name`, `displayName`, `processId`, `state`, `type`, `archivedDate`, `reached_state_date`, `assigned_id` - Can filter on `caseId`, `name`, `displayName`, `processId`, `state`, `type`, `archivedDate`, `reached_state_date`, `assigned_id`, `isTerminal` Note, this is equivalent to the other searchArchivedTasks 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 ArchivedTaskApi.SearchArchivedTasksQueryParams 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<ArchivedTask>