Package org.bonitasoft.web.client.api

Interface ProfileMemberApi

All Superinterfaces:

ApiClient.Api

public interface ProfileMemberApi
extends ApiClient.Api

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ProfileMemberApi.SearchProfileMembersQueryParams	A convenience class for generating query parameters for the searchProfileMembers method in a fluent style.

Method Summary

Modifier and Type	Method	Description
ProfileMember	createProfileMember(ProfileMemberCreateRequest body)	Create the ProfileMember Create the ProfileMember
void	deleteProfileMemberById(String id)	Delete the ProfileMember by ID Delete the single ProfileMember for the given ID
ProfileMember	getProfileMemberById(String id)	Finds the ProfileMember by ID Returns the single ProfileMember for the given ID
List<ProfileMember>	searchProfileMembers(Integer p, Integer c, List<String> f)	Finds ProfileMembers Finds ProfileMembers with pagination params and filters **Filter `member_type` is mandatory** You can filter on `profile_id`, `user_id`, `role_id` and `group_id`
List<ProfileMember>	searchProfileMembers(Map<String,Object> queryParams)	Finds ProfileMembers Finds ProfileMembers with pagination params and filters **Filter `member_type` is mandatory** You can filter on `profile_id`, `user_id`, `role_id` and `group_id` Note, this is equivalent to the other searchProfileMembers method, but with the query parameters collected into a single Map parameter.

Method Detail

createProfileMember

ProfileMember createProfileMember(ProfileMemberCreateRequest body)

Create the ProfileMember Create the ProfileMember

Parameters:

body - Partial ProfileMember description (required)

Returns:

ProfileMember

deleteProfileMemberById

void deleteProfileMemberById(String id)

Delete the ProfileMember by ID Delete the single ProfileMember for the given ID

Parameters:

id - ID of the ProfileMember to delete (required)

getProfileMemberById

ProfileMember getProfileMemberById(String id)

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

Parameters:

id - ID of the ProfileMember to return (required)

Returns:

ProfileMember

searchProfileMembers

List<ProfileMember> searchProfileMembers(Integer p,
                                         Integer c,
                                         List<String> f)

Finds ProfileMembers Finds ProfileMembers with pagination params and filters **Filter `member_type` is mandatory** You can filter on `profile_id`, `user_id`, `role_id` and `group_id`

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

searchProfileMembers

List<ProfileMember> searchProfileMembers(Map<String,Object> queryParams)

Finds ProfileMembers Finds ProfileMembers with pagination params and filters **Filter `member_type` is mandatory** You can filter on `profile_id`, `user_id`, `role_id` and `group_id` Note, this is equivalent to the other searchProfileMembers 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 ProfileMemberApi.SearchProfileMembersQueryParams 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<ProfileMember>