Package org.bonitasoft.web.client.api

Interface TenantApi

All Superinterfaces:

ApiClient.Api

public interface TenantApi
extends ApiClient.Api

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	TenantApi.SearchTenantsQueryParams	A convenience class for generating query parameters for the searchTenants method in a fluent style.

Method Summary

Modifier and Type	Method	Description
Tenant	createTenant(TenantCreateRequest body)	Create the Tenant  Create the Tenant
void	deleteTenantById(String id)	Delete the Tenant by ID  Delete the single Tenant for the given ID
Tenant	getTenantById(String id)	Finds the Tenant by ID  Returns the single Tenant for the given ID
List<Tenant>	searchTenants(Integer p, Integer c, List<String> f, String o, String s)	Finds Tenants  Finds Tenants with pagination params and filters - can order on `id` - can search on `displayName` - can filter on `displayName`
List<Tenant>	searchTenants(Map<String,Object> queryParams)	Finds Tenants  Finds Tenants with pagination params and filters - can order on `id` - can search on `displayName` - can filter on `displayName` Note, this is equivalent to the other searchTenants method, but with the query parameters collected into a single Map parameter.
void	updateTenantById(String id, TenantUpdateRequest tenantUpdateRequest)	Update the Tenant by ID  Update the Tenant for the given ID

Method Detail

createTenant

Tenant createTenant(TenantCreateRequest body)

Create the Tenant  Create the Tenant

Parameters:

body - Partial Tenant description (required)

Returns:

Tenant

deleteTenantById

void deleteTenantById(String id)

Delete the Tenant by ID  Delete the single Tenant for the given ID

Parameters:

id - ID of the Tenant to delete (required)

getTenantById

Tenant getTenantById(String id)

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

Parameters:

id - ID of the Tenant to return (required)

Returns:

Tenant

searchTenants

List<Tenant> searchTenants(Integer p,
                           Integer c,
                           List<String> f,
                           String o,
                           String s)

Finds Tenants  Finds Tenants with pagination params and filters - can order on `id` - can search on `displayName` - can filter on `displayName`

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

searchTenants

List<Tenant> searchTenants(Map<String,Object> queryParams)

Finds Tenants  Finds Tenants with pagination params and filters - can order on `id` - can search on `displayName` - can filter on `displayName` Note, this is equivalent to the other searchTenants 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 TenantApi.SearchTenantsQueryParams 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<Tenant>

updateTenantById

void updateTenantById(String id,
                      TenantUpdateRequest tenantUpdateRequest)

Update the Tenant by ID  Update the Tenant for the given ID

Parameters:

id - ID of the Tenant to return (required)

tenantUpdateRequest - Partial Tenant description (required)