org.bonitasoft.engine.api

Interface CustomUserInfoAPI

All Known Subinterfaces:

IdentityAPI

public interface CustomUserInfoAPI

CustomUserInfoAPI forms part of the OrganizationAPI and gives access to all the Administration operations available on CustomUserInfoDefinition and CustomUserInfoValue: creation, deletion and retrieve methods

Since:

6.3

Author:

Vincent Elcrin

See Also:

OrganizationAPI, CustomUserInfoDefinition, CustomUserInfoValue

Method Summary

Modifier and Type	Method and Description
CustomUserInfoDefinition	createCustomUserInfoDefinition(CustomUserInfoDefinitionCreator creator) Creates a new CustomUserInfoDefinition that will be available for all User s in the organization.
void	deleteCustomUserInfoDefinition(long id) Deletes the CustomUserInfoDefinition identified by the given id.
List<CustomUserInfo>	getCustomUserInfo(long userId, int startIndex, int maxResult) Retrieves the list of CustomUserInfo for the given user, ordered by CustomUserInfoDefinition name.
List<CustomUserInfoDefinition>	getCustomUserInfoDefinitions(int startIndex, int maxResult) Retrieves the list of CustomUserInfoDefinition according to the given pagination criteria, ordered by name.
long	getNumberOfCustomInfoDefinitions() Retrieves the number of existing CustomUserInfoDefinitions.
SearchResult<CustomUserInfoValue>	searchCustomUserInfoValues(SearchOptions options) Searches CustomUserInfoValues according to the criteria contained in the given SearchOptions.
CustomUserInfoValue	setCustomUserInfoValue(long definitionId, long userId, String value) Defines the value of a CustomUserInfoDefinition for a given User.

Method Detail

createCustomUserInfoDefinition

CustomUserInfoDefinition createCustomUserInfoDefinition(CustomUserInfoDefinitionCreator creator)
                                                 throws AlreadyExistsException,
                                                        CreationException

Creates a new CustomUserInfoDefinition that will be available for all User s in the organization. In order to set a value for the new created CustomUserInfoDefinition for a specif User use the method setCustomUserInfoValue(long, long, String).

Example:

 CustomUserInfoDefinitionCreator creator = new CustomUserInfoDefinitionCreator("Skills", "The user skills");
 CustomUserInfoDefinition userInfoDef = identityAPI.createCustomUserInfoDefinition(creator);
 

Parameters:

creator - A CustomUserInfoDefinitionCreator describing all information about the CustomUserInfoDefinition to be created

Returns:

The created CustomUserInfoDefinition

Throws:

AlreadyExistsException - If a CustomUserInfoDefinition already exists with the same name.

CreationException - If an error occurs during the creation

Since:

6.3

See Also:

CustomUserInfoDefinition, User, CustomUserInfoDefinitionCreator

getCustomUserInfoDefinitions

List<CustomUserInfoDefinition> getCustomUserInfoDefinitions(int startIndex,
                                                            int maxResult)

Retrieves the list of CustomUserInfoDefinition according to the given pagination criteria, ordered by name.

Parameters:

startIndex - The index for the first element to be retrieved (starts from zero)

maxResult - The maximum number of elements to be retrieved.

Returns:

The list of CustomUserInfoDefinition according to the given pagination criteria, ordered by name.

Since:

6.3

See Also:

CustomUserInfoDefinition

getNumberOfCustomInfoDefinitions

long getNumberOfCustomInfoDefinitions()

Retrieves the number of existing CustomUserInfoDefinitions.

Returns:

The number of existing CustomUserInfoDefinitions.

Since:

6.3

See Also:

CustomUserInfoDefinition

deleteCustomUserInfoDefinition

void deleteCustomUserInfoDefinition(long id)
                             throws DeletionException

Deletes the CustomUserInfoDefinition identified by the given id. All CustomUserInfoValue related to this CustomUserInfoDefinition will be deleted as well.

Parameters:

id - The identifier of the CustomUserInfoDefinition

Throws:

DeletionException - If an error occurs during deletion

Since:

6.3

See Also:

CustomUserInfoDefinition, CustomUserInfoValue

getCustomUserInfo

List<CustomUserInfo> getCustomUserInfo(long userId,
                                       int startIndex,
                                       int maxResult)

Retrieves the list of CustomUserInfo for the given user, ordered by CustomUserInfoDefinition name. For CustomUserInfos which have CustomUserInfoDefinition without a related CustomUserInfoValue, the field value will be null.

Parameters:

userId - The identifier of the User

startIndex - The index of the first element to be retrieved (it starts from zero)

maxResult - The maximum elements to be retrieved.

Returns:

The list of CustomUserInfo for the given User, ordered by CustomUserInfoDefinition name.

Since:

6.3

See Also:

CustomUserInfoDefinition, CustomUserInfoValue, CustomUserInfo, User

searchCustomUserInfoValues

SearchResult<CustomUserInfoValue> searchCustomUserInfoValues(SearchOptions options)

Searches CustomUserInfoValues according to the criteria contained in the given SearchOptions. In order to know which fields can be used in filters and sorting, please refer to CustomUserInfoValueSearchDescriptor.

Example: searches the first 10 CustomUserInfoValues having the given CustomUserInfoDefinition (referenced by its identifier) with the given value. The result is ordered by the related User identifier:

 SearchOptionsBuilder optionsBuilder = new SearchOptionsBuilder(0, 10);
 optionsBuilder.filter(CustomUserInfoValueSearchDescriptor.DEFINITION_ID, userInfoDefinition.getId());
 optionsBuilder.filter(CustomUserInfoValueSearchDescriptor.VALUE, value);
 optionsBuilder.sort(CustomUserInfoValueSearchDescriptor.USER_ID, Order.ASC);
 SearchResult<CustomUserInfoValue> searchResult = identityAPI.searchCustomUserInfoValues(optionsBuilder.done());
 

Parameters:

options - The SearchOptions containing the search criteria

Returns:

The SearchResult containing the number and the list of CustomUserInfoValues matching the criteria

Since:

6.3

See Also:

SearchOptions, CustomUserInfoValue, CustomUserInfoValueSearchDescriptor, SearchResult

setCustomUserInfoValue

CustomUserInfoValue setCustomUserInfoValue(long definitionId,
                                           long userId,
                                           String value)
                                    throws UpdateException

Defines the value of a CustomUserInfoDefinition for a given User.

Parameters:

definitionId - The identifier of the CustomUserInfoDefinition

userId - The identifier of the User

value - The Custom User Information value

Returns:

a CustomUserInfoValue representing the value of the given CustomUserInfoDefinition for the given User

Throws:

UpdateException - When an error occurs during the update.

Since:

6.3

See Also:

CustomUserInfoDefinition.getId(), User.getId(), CustomUserInfoValue