Package org.bonitasoft.web.client.api

Interface ArchivedConnectorInstanceApi

All Superinterfaces:

ApiClient.Api

public interface ArchivedConnectorInstanceApi
extends ApiClient.Api

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ArchivedConnectorInstanceApi.SearchArchivedConnectorInstancesQueryParams	A convenience class for generating query parameters for the searchArchivedConnectorInstances method in a fluent style.

Method Summary

Modifier and Type	Method	Description
List<ArchivedConnectorInstance>	searchArchivedConnectorInstances(Integer p, Integer c, List<String> f, String o, String s)	Finds ArchivedConnectorInstances Finds ArchivedConnectorInstances with pagination params and filters
List<ArchivedConnectorInstance>	searchArchivedConnectorInstances(Map<String,Object> queryParams)	Finds ArchivedConnectorInstances Finds ArchivedConnectorInstances with pagination params and filters Note, this is equivalent to the other searchArchivedConnectorInstances method, but with the query parameters collected into a single Map parameter.

Method Detail

searchArchivedConnectorInstances

List<ArchivedConnectorInstance> searchArchivedConnectorInstances(Integer p,
                                                                 Integer c,
                                                                 List<String> f,
                                                                 String o,
                                                                 String s)

Finds ArchivedConnectorInstances Finds ArchivedConnectorInstances with pagination params and filters

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

searchArchivedConnectorInstances

List<ArchivedConnectorInstance> searchArchivedConnectorInstances(Map<String,Object> queryParams)

Finds ArchivedConnectorInstances Finds ArchivedConnectorInstances with pagination params and filters Note, this is equivalent to the other searchArchivedConnectorInstances 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 ArchivedConnectorInstanceApi.SearchArchivedConnectorInstancesQueryParams 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<ArchivedConnectorInstance>