| edu.iu.uis.eden.user.UserService
All known Subclasses: edu.iu.uis.eden.user.PluginTestUserService, edu.iu.uis.eden.user.BaseUserService,
| UserService | | public interface UserService extends XmlLoader(Code) | | The UserService provides retrieval and search capibilities for WorkflowUsers.
It also provides the a factory method for creating blank users.
The UserService extends XmlLoader so it is possible to import users from XML
if the implementing class provides an xml loading implementation.
author:
bmcgough
author:
rkirkend
author:
ewestfal |
| copy | | public WorkflowUser copy(WorkflowUser user, boolean preserveKeys)(Code) | | Make a copy of the given WorkflowUser. If preserveKeys is true then the keys need to be preserved,
otherwise they should be set to null on the copy.
This code can assume that the user being passed in was produced by this service. Therefore, the user
instance passed in can be safely cast to the appropriate implementation class if necessary.
since:
2.2 |
| getBlankUser | | public WorkflowUser getBlankUser()(Code) | | Returns an empty WorkflowUser object. Since the WorkflowUser implementation is institution-specific
this method allows for the creation of a new WorkflowUser instance. This will typically be used
in conjuction with the search method.
an empty WorkflowUser object |
| getCapabilities | | public UserCapabilities getCapabilities()(Code) | | Retrieves the capabilities of this user service. This essentially provides the core with information
on the kinds of activities which the User service can perform such as reporting, editing, etc. This
is primarily used by the web-tier of the application to aid in delivery of web-based user services.
since:
2.2 |
| getWorkflowUser | | public WorkflowUser getWorkflowUser(UserId userId) throws EdenUserNotFoundException(Code) | | Retrieve the WorkflowUser who has the supplied UserId. If the user does
not have a WorkflowId assigned, assign the user a WorkflowId before
returning the WorkflowUser object
Parameters:
the - UserId of the user to lookup the user which matches the given id if no user could be found
throws:
EdenUserNotFoundException - if no user could be located for the given id or ifthe given UserId is of an invalid type |
| getWorkflowUser | | public WorkflowUser getWorkflowUser(UserIdVO userId) throws EdenUserNotFoundException(Code) | | Similar to getWorkflowUser(UserId) except that the id is represented as a UserIdVO
instead of a UserId.
Parameters:
the - UserIdVO of the user to lookup the user which matches the given id or null if no user could be found
throws:
EdenUserNotFoundException - if no user could be located for the given id or ifthe given UserId is of an invalid type |
| save | | public void save(WorkflowUser user)(Code) | | Saves the given WorkflowUser to the underlying data store. If this service does not support persistence
then an UnsupportedOperationException will be thrown.
since:
2.2 |
| search | | public List<WorkflowUser> search(WorkflowUser user, boolean useWildCards)(Code) | | Invokes a search for WorkflowUsers using an example user object as the search criteria.
Parameters:
user - a WorkflowUser object containing an example user to search for, this will usuallyconsist of a user object with some of the fields filled in
Parameters:
useWildCards - if true then wildcards should be used on the various WorkflowUser fields a List of WorkflowUsers which match the given criteria |
|
|