Package org.bonitasoft.web.client.api

Interface CustomUserApi

All Superinterfaces:

ApiClient.Api

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	CustomUserApi.SearchCustomUsersQueryParams	A convenience class for generating query parameters for the searchCustomUsers method in a fluent style.

Method Summary

Modifier and Type	Method	Description
List<CustomUser>	searchCustomUsers(Integer p, Integer c, List<String> f)	Finds CustomUsers Finds CustomUsers with pagination params and filters **The filter `userId` is mandatory**
List<CustomUser>	searchCustomUsers(Map<String,Object> queryParams)	Finds CustomUsers Finds CustomUsers with pagination params and filters **The filter `userId` is mandatory** Note, this is equivalent to the other searchCustomUsers method, but with the query parameters collected into a single Map parameter.

Method Detail

searchCustomUsers

List<CustomUser> searchCustomUsers(Integer p,
                                   Integer c,
                                   List<String> f)

Finds CustomUsers Finds CustomUsers with pagination params and filters **The filter `userId` is mandatory**

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)

Returns:

List<CustomUser>

searchCustomUsers

List<CustomUser> searchCustomUsers(Map<String,Object> queryParams)

Finds CustomUsers Finds CustomUsers with pagination params and filters **The filter `userId` is mandatory** Note, this is equivalent to the other searchCustomUsers 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 CustomUserApi.SearchCustomUsersQueryParams 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)

Returns:

List<CustomUser>