com.silverpeas.workflow.api
Interface UserManager

All Known Implementing Classes:

UserManagerImpl

public interface UserManager

The workflow engine services relate to user management.

Method Summary

UserSettings	getEmptyUserSettings(String userId, String peasId) Get an empty user settings in database The full list of information is described in the process model
User	getRelatedUser(User user, String relation, String peasId) Get a user from a given user and relation
String[]	getRoleNames(User user, String processModelId) Returns all the roles of a given user relative to a processModel.
User	getUser(String userId) Returns the user with the given userId
String[]	getUserInfoNames() returns all the known info for an user; Each returned value can be used as a parameter to the User method getInfo().
User[]	getUsers(String[] userIds) Make a User[] from a userIds' String[].
UserSettings	getUserSettings(String userId, String peasId) Get the user settings in database The full list of information is described in the process model
User[]	getUsersInGroup(String groupId)
User[]	getUsersInRole(String roleName, String processModelId) Returns all the users having a given role relative to a processModel.
void	resetUserSettings(String userId, String peasId)

Method Detail

getUser

User getUser(String userId)
             throws WorkflowException

Returns the user with the given userId

Returns:

the user with the given userId.

Throws:

WorkflowException

getUsers

User[] getUsers(String[] userIds)
                throws WorkflowException

Make a User[] from a userIds' String[].

Throws:

WorkflowException

getRoleNames

String[] getRoleNames(User user,
                      String processModelId)
                      throws WorkflowException

Returns all the roles of a given user relative to a processModel.

Throws:

WorkflowException

getUsersInRole

User[] getUsersInRole(String roleName,
                      String processModelId)
                      throws WorkflowException

Returns all the users having a given role relative to a processModel.

Throws:

WorkflowException

getUsersInGroup

User[] getUsersInGroup(String groupId)

getUserInfoNames

String[] getUserInfoNames()

returns all the known info for an user; Each returned value can be used as a parameter to the User method getInfo().

getRelatedUser

User getRelatedUser(User user,
                    String relation,
                    String peasId)
                    throws WorkflowException

Get a user from a given user and relation

Parameters:

user - reference user

relation - relation between given user and searched user

peasId - the id of workflow peas associated to that information

Returns:

the user that has the given relation with given user

Throws:

WorkflowException

getUserSettings

UserSettings getUserSettings(String userId,
                             String peasId)
                             throws WorkflowException

Get the user settings in database The full list of information is described in the process model

Parameters:

userId - the user Id

peasId - the id of workflow peas associated to that information

Returns:

UserSettings

Throws:

WorkflowException

See Also:

ProcessModel

resetUserSettings

void resetUserSettings(String userId,
                       String peasId)
                       throws WorkflowException

Throws:

WorkflowException

getEmptyUserSettings

UserSettings getEmptyUserSettings(String userId,
                                  String peasId)

Get an empty user settings in database The full list of information is described in the process model

Parameters:

userId - the user Id

peasId - the id of workflow peas associated to that information

Returns:

UserSettings

See Also:

ProcessModel