Package org.bonitasoft.web.client.api

Interface CustomUserDefinitionApi

All Superinterfaces:

ApiClient.Api

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	CustomUserDefinitionApi.SearchCustomUserDefinitionsQueryParams	A convenience class for generating query parameters for the searchCustomUserDefinitions method in a fluent style.

Method Summary

Modifier and Type	Method	Description
CustomUserDefinition	createCustomUserDefinition(CustomUserDefinitionCreateRequest body)	Create the CustomUserDefinition Create the CustomUserDefinition
void	deleteCustomUserDefinitionById(String id)	Delete the CustomUserDefinition by ID Delete the single CustomUserDefinition for the given ID
CustomUserDefinition	getCustomUserDefinitionById(String id)	Finds the CustomUserDefinition by ID Returns the single CustomUserDefinition for the given ID
List<CustomUserDefinition>	searchCustomUserDefinitions(Integer p, Integer c)	Finds CustomUserDefinitions Finds CustomUserDefinitions.
List<CustomUserDefinition>	searchCustomUserDefinitions(Map<String,Object> queryParams)	Finds CustomUserDefinitions Finds CustomUserDefinitions.

Method Detail

createCustomUserDefinition

CustomUserDefinition createCustomUserDefinition(CustomUserDefinitionCreateRequest body)

Create the CustomUserDefinition Create the CustomUserDefinition

Parameters:

body - Partial CustomUserDefinition description (required)

Returns:

CustomUserDefinition

deleteCustomUserDefinitionById

void deleteCustomUserDefinitionById(String id)

Delete the CustomUserDefinition by ID Delete the single CustomUserDefinition for the given ID

Parameters:

id - ID of the CustomUserDefinition to delete (required)

getCustomUserDefinitionById

CustomUserDefinition getCustomUserDefinitionById(String id)

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

Parameters:

id - ID of the CustomUserDefinition to return (required)

Returns:

CustomUserDefinition

searchCustomUserDefinitions

List<CustomUserDefinition> searchCustomUserDefinitions(Integer p,
                                                       Integer c)

Finds CustomUserDefinitions Finds CustomUserDefinitions. There are no filters, and no search terms. All the definitions are returned.

Parameters:

p - index of the page to display (required)

c - maximum number of elements to retrieve (required)

Returns:

List<CustomUserDefinition>

searchCustomUserDefinitions

List<CustomUserDefinition> searchCustomUserDefinitions(Map<String,Object> queryParams)

Finds CustomUserDefinitions Finds CustomUserDefinitions. There are no filters, and no search terms. All the definitions are returned. Note, this is equivalent to the other searchCustomUserDefinitions 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 CustomUserDefinitionApi.SearchCustomUserDefinitionsQueryParams 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)

Returns:

List<CustomUserDefinition>