public interface CustomUserInfoAPI
OrganizationAPI
and gives access to all the Administration operations available on custom user info: creation,
deletion and retrieve methodsModifier and Type | Method and Description |
---|---|
CustomUserInfoDefinition |
createCustomUserInfoDefinition(CustomUserInfoDefinitionCreator creator)
Create a new CustomUserInfoDefinition that will be available for all
User s in the organization. |
void |
deleteCustomUserInfoDefinition(long id)
Delete the
CustomUserInfoDefinition related to the given id. |
List<CustomUserInfo> |
getCustomUserInfo(long userId,
int startIndex,
int maxResult)
Retrieve the list of
CustomUserInfo for the given user, ordered by custom user info definition name. |
List<CustomUserInfoDefinition> |
getCustomUserInfoDefinitions(int startIndex,
int maxResult)
Retrieves the list of
CustomUserInfoDefinition according to the given pagination criteria, ordered by name. |
long |
getNumberOfCustomInfoDefinitions()
Count the number of existing definitions.
|
SearchResult<CustomUserInfoValue> |
searchCustomUserInfoValues(SearchOptions options)
Searches custom user info values according to the criteria containing in the options.
|
CustomUserInfoValue |
setCustomUserInfoValue(long definitionId,
long userId,
String value)
Set value of a custom user info described by definitionId/userId.
|
CustomUserInfoDefinition createCustomUserInfoDefinition(CustomUserInfoDefinitionCreator creator) throws AlreadyExistsException, CreationException
User
s in the organization.creator
- describes all information for the new objectAlreadyExistsException
- if a CustomUserInfoDefinition already exists with the same name.CreationException
- if an error occurs during the creationList<CustomUserInfoDefinition> getCustomUserInfoDefinitions(int startIndex, int maxResult)
CustomUserInfoDefinition
according to the given pagination criteria, ordered by name.startIndex
- the index for the first element to be retrieved (starts from zero)maxResult
- the maximum number of elements to be retrieved.CustomUserInfoDefinition
according to the given pagination criteria, ordered by name.long getNumberOfCustomInfoDefinitions()
void deleteCustomUserInfoDefinition(long id) throws DeletionException
CustomUserInfoDefinition
related to the given id. All CustomUserInfoValue
related to this CustomUserInfoDefinition
will be deleted as well.id
- the identifier of the CustomUserInfoDefinition
DeletionException
- if an error occurs during deletionList<CustomUserInfo> getCustomUserInfo(long userId, int startIndex, int maxResult)
CustomUserInfo
for the given user, ordered by custom user info definition name. For CustomUserInfo
s which have
CustomUserInfoDefinition
without a related CustomUserInfoValue
, the field value will be null.userId
- the user identifierstartIndex
- the index of the first result to be retrieved (it starts from zero)maxResult
- the maximum elements to be retrieved.CustomUserInfo
for the given user, ordered by custom user info definition name.CustomUserInfoDefinition
,
CustomUserInfoValue
SearchResult<CustomUserInfoValue> searchCustomUserInfoValues(SearchOptions options)
options
- The search criteriaCustomUserInfoValue setCustomUserInfoValue(long definitionId, long userId, String value) throws UpdateException
definitionId
- the CustomUserInfoDefinition
identifieruserId
- the User
identifiervalue
- the new custom user info valueUpdateException
Copyright © 2014 Bonitasoft S.A.. All rights reserved.