Package org.bonitasoft.web.client.api

Interface PageApi

All Superinterfaces:

ApiClient.Api

public interface PageApi
extends ApiClient.Api

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	PageApi.SearchPagesQueryParams	A convenience class for generating query parameters for the searchPages method in a fluent style.

Method Summary

Modifier and Type	Method	Description
Page	createPage(PageCreateRequest body)	Create the Page Upload the page content using the `portal/pageUpload` .
void	deletePageById(String id)	Delete the Page by ID Delete the single Page for the given ID
Page	getPageById(String id)	Finds the Page by ID Returns the single Page for the given ID
List<Page>	searchPages(Integer p, Integer c, List<String> f, String o, String s)	Finds Pages Finds Pages with pagination params and filters - can search on `displayName`,`description` - can filter on `createdBy`,`contentType`
List<Page>	searchPages(Map<String,Object> queryParams)	Finds Pages Finds Pages with pagination params and filters - can search on `displayName`,`description` - can filter on `createdBy`,`contentType` Note, this is equivalent to the other searchPages method, but with the query parameters collected into a single Map parameter.
void	updatePageById(String id, PageUpdateRequest pageUpdateRequest)	Update the Page by ID Use the PUT method to update an existing custom page.
String	uploadPage(File file)	Upload a Page Upload Page

Method Detail

createPage

Page createPage(PageCreateRequest body)

Create the Page Upload the page content using the `portal/pageUpload` . This returns a temporary file name that can be used as input for this operation.

Parameters:

body - Zip name as named in the temp folder after upload (required)

Returns:

Page

deletePageById

void deletePageById(String id)

Delete the Page by ID Delete the single Page for the given ID

Parameters:

id - ID of the Page to delete (required)

getPageById

Page getPageById(String id)

Finds the Page by ID Returns the single Page for the given ID

Parameters:

id - ID of the Page to return (required)

Returns:

Page

searchPages

List<Page> searchPages(Integer p,
                       Integer c,
                       List<String> f,
                       String o,
                       String s)

Finds Pages Finds Pages with pagination params and filters - can search on `displayName`,`description` - can filter on `createdBy`,`contentType`

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

searchPages

List<Page> searchPages(Map<String,Object> queryParams)

Finds Pages Finds Pages with pagination params and filters - can search on `displayName`,`description` - can filter on `createdBy`,`contentType` Note, this is equivalent to the other searchPages 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 PageApi.SearchPagesQueryParams 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<Page>

updatePageById

void updatePageById(String id,
                    PageUpdateRequest pageUpdateRequest)

Update the Page by ID Use the PUT method to update an existing custom page. To update a custom page, upload the new page content using the pageUpload servlet, which returns a temporary file name, and then call this API with the temporary file name.

Parameters:

id - ID of the Page to return (required)

pageUpdateRequest - Partial Page description (required)

uploadPage

String uploadPage(File file)

Upload a Page Upload Page

Parameters:

file - (optional)

Returns:

String