Package org.bonitasoft.web.client.api

Interface ProfessionalContactDataApi

All Superinterfaces:

ApiClient.Api

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ProfessionalContactDataApi.SearchProfessionalContactDatasQueryParams	A convenience class for generating query parameters for the searchProfessionalContactDatas method in a fluent style.

Method Summary

Modifier and Type	Method	Description
ProfessionalContactData	createProfessionalContactData(ProfessionalContactData body)	Create the ProfessionalContactData Create the ProfessionalContactData
ProfessionalContactData	getPersonalContactDataById(String userId)	Finds the PersonalContactData by ID Returns the single PersonalContactData for the given ID
ProfessionalContactData	getProfessionalContactDataById(String userId)	Finds the ProfessionalContactData by ID Returns the single ProfessionalContactData for the given ID
List<ProfessionalContactData>	searchProfessionalContactDatas(Integer p, Integer c, List<String> f, String o, String s)	Finds ProfessionalContactData Finds ProfessionalContactData with pagination params and filters - can order on `id` - can search on `displayName` - can filter on `displayName`
List<ProfessionalContactData>	searchProfessionalContactDatas(Map<String,Object> queryParams)	Finds ProfessionalContactData Finds ProfessionalContactData with pagination params and filters - can order on `id` - can search on `displayName` - can filter on `displayName` Note, this is equivalent to the other searchProfessionalContactDatas method, but with the query parameters collected into a single Map parameter.
void	updatePersonalContactDataById(String userId, ProfessionalContactData professionalContactData)	Update the PersonalContactData by ID Update the PersonalContactData for the given ID
void	updateProfessionalContactDataById(String userId, ProfessionalContactData professionalContactData)	Update the ProfessionalContactData by ID Update the ProfessionalContactData for the given ID

Method Detail

createProfessionalContactData

ProfessionalContactData createProfessionalContactData(ProfessionalContactData body)

Create the ProfessionalContactData Create the ProfessionalContactData

Parameters:

body - Partial ProfessionalContactData description including the user ID (required)

Returns:

ProfessionalContactData

getPersonalContactDataById

ProfessionalContactData getPersonalContactDataById(String userId)

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

Parameters:

userId - User ID of the PersonalContactData to return (required)

Returns:

ProfessionalContactData

getProfessionalContactDataById

ProfessionalContactData getProfessionalContactDataById(String userId)

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

Parameters:

userId - User ID of the ProfessionalContactData to return (required)

Returns:

ProfessionalContactData

searchProfessionalContactDatas

List<ProfessionalContactData> searchProfessionalContactDatas(Integer p,
                                                             Integer c,
                                                             List<String> f,
                                                             String o,
                                                             String s)

Finds ProfessionalContactData Finds ProfessionalContactData 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<ProfessionalContactData>

searchProfessionalContactDatas

List<ProfessionalContactData> searchProfessionalContactDatas(Map<String,Object> queryParams)

Finds ProfessionalContactData Finds ProfessionalContactData with pagination params and filters - can order on `id` - can search on `displayName` - can filter on `displayName` Note, this is equivalent to the other searchProfessionalContactDatas 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 ProfessionalContactDataApi.SearchProfessionalContactDatasQueryParams 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<ProfessionalContactData>

updatePersonalContactDataById

void updatePersonalContactDataById(String userId,
                                   ProfessionalContactData professionalContactData)

Update the PersonalContactData by ID Update the PersonalContactData for the given ID

Parameters:

userId - User ID of the PersonalContactData to update (required)

professionalContactData - Partial PersonalContactData description including the user ID (required)

updateProfessionalContactDataById

void updateProfessionalContactDataById(String userId,
                                       ProfessionalContactData professionalContactData)

Update the ProfessionalContactData by ID Update the ProfessionalContactData for the given ID

Parameters:

userId - User ID of the ProfessionalContactData to update (required)

professionalContactData - Partial ProfessionalContactData description including the user ID (required)