org.bonitasoft.web.client.api.ArchivedTaskApi Maven / Gradle / Ivy

Go to download
/** 
 * Copyright (C) 2023 BonitaSoft S.A.
 * BonitaSoft, 32 rue Gustave Eiffel - 38000 Grenoble
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2.0 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see .
 */
package org.bonitasoft.web.client.api;

import java.util.HashMap;
import java.util.List;

import org.bonitasoft.web.client.invoker.ApiClient;
import org.bonitasoft.web.client.invoker.EncodingUtils;
import org.bonitasoft.web.client.model.ApiResponse;
import org.bonitasoft.web.client.model.ArchivedTask;

import feign.*;

@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
public interface ArchivedTaskApi extends ApiClient.Api {

    /**
     * Finds the ArchivedTask by ID
     * Returns the single ArchivedTask for the given ID
     * 
     * @param id ID of the ArchivedTask to return (required)
     * @return ArchivedTask
     */
    @RequestLine("GET /API/bpm/archivedTask/{id}")
    @Headers({
            "Accept: application/json",
    })
    ArchivedTask getArchivedTaskById(@Param("id") String id);

    /**
     * Finds the ArchivedTask by ID
     * Similar to getArchivedTaskById but it also returns the http response headers .
     * Returns the single ArchivedTask for the given ID
     * 
     * @param id ID of the ArchivedTask to return (required)
     * @return A ApiResponse that wraps the response boyd and the http headers.
     */
    @RequestLine("GET /API/bpm/archivedTask/{id}")
    @Headers({
            "Accept: application/json",
    })
    ApiResponse getArchivedTaskByIdWithHttpInfo(@Param("id") String id);

    /**
     * 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`
     * 
     * @param p index of the page to display (required)
     * @param c maximum number of elements to retrieve (required)
     * @param f can filter on attributes with the format f={filter\\_name}={filter\\_value} with the name/value pair as url encoded string. (optional)
     * @param o can order on attributes (optional)
     * @return List<ArchivedTask>
     */
    @RequestLine("GET /API/bpm/archivedTask?p={p}&c={c}&f={f}&o={o}")
    @Headers({
            "Accept: application/json",
    })
    List searchArchivedTasks(@Param("p") Integer p, @Param("c") Integer c, @Param("f") List f,
            @Param("o") String o);

    /**
     * Finds ArchivedTasks
     * Similar to searchArchivedTasks but it also returns the http response headers .
     * 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`
     * 
     * @param p index of the page to display (required)
     * @param c maximum number of elements to retrieve (required)
     * @param f can filter on attributes with the format f={filter\\_name}={filter\\_value} with the name/value pair as url encoded string. (optional)
     * @param o can order on attributes (optional)
     * @return A ApiResponse that wraps the response boyd and the http headers.
     */
    @RequestLine("GET /API/bpm/archivedTask?p={p}&c={c}&f={f}&o={o}")
    @Headers({
            "Accept: application/json",
    })
    ApiResponse> searchArchivedTasksWithHttpInfo(@Param("p") Integer p, @Param("c") Integer c,
            @Param("f") List f, @Param("o") 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`
     * 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 {@link SearchArchivedTasksQueryParams} class that allows for
     * building up this map in a fluent style.
     * 
     * @param 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)
     *        
     * @return List<ArchivedTask>
     */
    @RequestLine("GET /API/bpm/archivedTask?p={p}&c={c}&f={f}&o={o}")
    @Headers({
            "Accept: application/json",
    })
    List searchArchivedTasks(@QueryMap(encoded = true) SearchArchivedTasksQueryParams 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 that receives the query parameters as a map,
     * but this one also exposes the Http response headers
     * 
     * @param 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)
     *        
     * @return List<ArchivedTask>
     */
    @RequestLine("GET /API/bpm/archivedTask?p={p}&c={c}&f={f}&o={o}")
    @Headers({
            "Accept: application/json",
    })
    ApiResponse> searchArchivedTasksWithHttpInfo(
            @QueryMap(encoded = true) SearchArchivedTasksQueryParams queryParams);

    /**
     * A convenience class for generating query parameters for the
     * searchArchivedTasks method in a fluent style.
     */
    public static class SearchArchivedTasksQueryParams extends HashMap {

        public SearchArchivedTasksQueryParams p(final Integer value) {
            put("p", EncodingUtils.encode(value));
            return this;
        }

        public SearchArchivedTasksQueryParams c(final Integer value) {
            put("c", EncodingUtils.encode(value));
            return this;
        }

        public SearchArchivedTasksQueryParams f(final List value) {
            put("f", EncodingUtils.encodeCollection(value, "multi"));
            return this;
        }

        public SearchArchivedTasksQueryParams o(final String value) {
            put("o", EncodingUtils.encode(value));
            return this;
        }
    }
}