Package org.bonitasoft.web.client.api

Interface TimerEventTriggerApi

All Superinterfaces:
ApiClient.Api
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.12.0") public interface TimerEventTriggerApi extends ApiClient.Api

  • Method Details

    • getTimerEventTriggerById

      TimerEventTrigger getTimerEventTriggerById(String id)
      Finds the TimerEventTrigger by ID Returns the single TimerEventTrigger for the given ID
      Parameters:
      id - ID of the TimerEventTrigger to return (required)
      Returns:
      TimerEventTrigger

    • getTimerEventTriggerByIdWithHttpInfo

      ApiResponse<TimerEventTrigger> getTimerEventTriggerByIdWithHttpInfo(String id)
      Finds the TimerEventTrigger by ID Similar to getTimerEventTriggerById but it also returns the http response headers . Returns the single TimerEventTrigger for the given ID
      Parameters:
      id - ID of the TimerEventTrigger to return (required)
      Returns:
      A ApiResponse that wraps the response boyd and the http headers.

    • searchTimerEventTriggers

      List<TimerEventTrigger> searchTimerEventTriggers(Integer p, Integer c, String caseId, List<String> f, String o, String s)
      Finds TimerEventTriggers Finds TimerEventTriggers with pagination params and filters - can order on `id` - can search on `displayName` - can filter on `displayName`
      Parameters:
      p - index of the page to display (required)
      c - maximum number of elements to retrieve (required)
      caseId - the process instance id (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<TimerEventTrigger>

    • searchTimerEventTriggersWithHttpInfo

      ApiResponse<List<TimerEventTrigger>> searchTimerEventTriggersWithHttpInfo(Integer p, Integer c, String caseId, List<String> f, String o, String s)
      Finds TimerEventTriggers Similar to searchTimerEventTriggers but it also returns the http response headers . Finds TimerEventTriggers with pagination params and filters - can order on `id` - can search on `displayName` - can filter on `displayName`
      Parameters:
      p - index of the page to display (required)
      c - maximum number of elements to retrieve (required)
      caseId - the process instance id (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.

    • searchTimerEventTriggers

      List<TimerEventTrigger> searchTimerEventTriggers(TimerEventTriggerApi.SearchTimerEventTriggersQueryParams queryParams)
      Finds TimerEventTriggers Finds TimerEventTriggers with pagination params and filters - can order on `id` - can search on `displayName` - can filter on `displayName` Note, this is equivalent to the other searchTimerEventTriggers 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 TimerEventTriggerApi.SearchTimerEventTriggersQueryParams 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)
      • caseId - the process instance id (required)
      Returns:
      List<TimerEventTrigger>

    • searchTimerEventTriggersWithHttpInfo

      ApiResponse<List<TimerEventTrigger>> searchTimerEventTriggersWithHttpInfo(TimerEventTriggerApi.SearchTimerEventTriggersQueryParams queryParams)
      Finds TimerEventTriggers Finds TimerEventTriggers with pagination params and filters - can order on `id` - can search on `displayName` - can filter on `displayName` Note, this is equivalent to the other searchTimerEventTriggers 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)
      • caseId - the process instance id (required)
      Returns:
      List<TimerEventTrigger>

    • updateTimerEventTriggerById

      TimerEventTriggerUpdateResponse updateTimerEventTriggerById(String id, TimerEventTriggerUpdateRequest timerEventTriggerUpdateRequest)
      Update the TimerEventTrigger by ID Update the TimerEventTrigger for the given ID
      Parameters:
      id - ID of the TimerEventTrigger to return (required)
      timerEventTriggerUpdateRequest - a long value with attribute name \"executionDate\" (required)
      Returns:
      TimerEventTriggerUpdateResponse

    • updateTimerEventTriggerByIdWithHttpInfo

      ApiResponse<TimerEventTriggerUpdateResponse> updateTimerEventTriggerByIdWithHttpInfo(String id, TimerEventTriggerUpdateRequest timerEventTriggerUpdateRequest)
      Update the TimerEventTrigger by ID Similar to updateTimerEventTriggerById but it also returns the http response headers . Update the TimerEventTrigger for the given ID
      Parameters:
      id - ID of the TimerEventTrigger to return (required)
      timerEventTriggerUpdateRequest - a long value with attribute name \"executionDate\" (required)
      Returns:
      A ApiResponse that wraps the response boyd and the http headers.