Package org.bonitasoft.web.client.api

Interface ApplicationPageApi

All Superinterfaces:

ApiClient.Api

@Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public interface ApplicationPageApi
extends ApiClient.Api

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ApplicationPageApi.SearchApplicationPagesQueryParams	A convenience class for generating query parameters for the searchApplicationPages method in a fluent style.

Method Summary

Modifier and Type	Method	Description
ApplicationPage	createApplicationPage(ApplicationPageCreateRequest body)	Create an application page Create an application page
void	deleteApplicationPageById(String id)	Delete an application page by ID Delete a single application page for the given ID
ApplicationPage	getApplicationPageById(String id)	Finds an application page by ID Returns a single application page for the given ID
List<ApplicationPage>	searchApplicationPages(Integer p, Integer c, List<String> f, String o, String s)	Finds application pages Finds application pages with pagination params and filters - can order on `id`, `token`, `applicationId`, `pageId` - can search on `token` - can filter on `id`, `token`, `applicationId`, `pageId`
List<ApplicationPage>	searchApplicationPages(Map<String,Object> queryParams)	Finds application pages Finds application pages with pagination params and filters - can order on `id`, `token`, `applicationId`, `pageId` - can search on `token` - can filter on `id`, `token`, `applicationId`, `pageId` Note, this is equivalent to the other searchApplicationPages method, but with the query parameters collected into a single Map parameter.

Method Detail

createApplicationPage

ApplicationPage createApplicationPage(ApplicationPageCreateRequest body)

Create an application page Create an application page

Parameters:

body - Partial application page description (required)

Returns:

ApplicationPage

deleteApplicationPageById

void deleteApplicationPageById(String id)

Delete an application page by ID Delete a single application page for the given ID

Parameters:

id - ID of application page to delete (required)

getApplicationPageById

ApplicationPage getApplicationPageById(String id)

Finds an application page by ID Returns a single application page for the given ID

Parameters:

id - ID of application page to return (required)

Returns:

ApplicationPage

searchApplicationPages

List<ApplicationPage> searchApplicationPages(Integer p,
                                             Integer c,
                                             List<String> f,
                                             String o,
                                             String s)

Finds application pages Finds application pages with pagination params and filters - can order on `id`, `token`, `applicationId`, `pageId` - can search on `token` - can filter on `id`, `token`, `applicationId`, `pageId`

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

searchApplicationPages

List<ApplicationPage> searchApplicationPages(Map<String,Object> queryParams)

Finds application pages Finds application pages with pagination params and filters - can order on `id`, `token`, `applicationId`, `pageId` - can search on `token` - can filter on `id`, `token`, `applicationId`, `pageId` Note, this is equivalent to the other searchApplicationPages 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 ApplicationPageApi.SearchApplicationPagesQueryParams 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<ApplicationPage>