Package org.bonitasoft.web.client.api

Interface I18ntranslationApi

All Superinterfaces:

ApiClient.Api

public interface I18ntranslationApi
extends ApiClient.Api

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	I18ntranslationApi.SearchI18ntranslationsQueryParams	A convenience class for generating query parameters for the searchI18ntranslations method in a fluent style.

Method Summary

Modifier and Type	Method	Description
List<Map<String,String>>	searchI18ntranslations(Integer p, Integer c, List<String> f)	Finds I18ntranslations List the available I18ntranslations with pagination params and filters Returns all translations of the product.
List<Map<String,String>>	searchI18ntranslations(Map<String,Object> queryParams)	Finds I18ntranslations List the available I18ntranslations with pagination params and filters Returns all translations of the product.

Method Detail

searchI18ntranslations

List<Map<String,String>> searchI18ntranslations(Integer p,
                                                      Integer c,
                                                      List<String> f)

Finds I18ntranslations List the available I18ntranslations with pagination params and filters Returns all translations of the product. If a locale is specified in the filter, that translation for that locale are returned. If no locale is specified, the translations in English are returned. You can filter on `locale`

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<Map<String, String>>

searchI18ntranslations

List<Map<String,String>> searchI18ntranslations(Map<String,Object> queryParams)

Finds I18ntranslations List the available I18ntranslations with pagination params and filters Returns all translations of the product. If a locale is specified in the filter, that translation for that locale are returned. If no locale is specified, the translations in English are returned. You can filter on `locale` Note, this is equivalent to the other searchI18ntranslations 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 I18ntranslationApi.SearchI18ntranslationsQueryParams 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<Map<String, String>>