org.jasig.portlet.blackboardvcportlet.service

Interface UserService

public interface UserService

Directory of users that can use the service

Author:

Eric Dalquist

Method Summary

Methods

Modifier and Type	Method and Description
BasicUser	findUser(String uniqueId)
Set<BasicUser>	searchForUserByEmail(String email) Search for a set of users via BasicUser.getEmail().
Set<BasicUser>	searchForUserByName(String name) Search for a set of users via BasicUser.getDisplayName().

Method Detail

findUser

BasicUser findUser(String uniqueId)

Parameters:

uniqueId - The BasicUser.getUniqueId() for the user to find

Returns:

The user for the uniqueId

searchForUserByName

Set<BasicUser> searchForUserByName(String name)

Search for a set of users via BasicUser.getDisplayName(). It is up to the implementation to parse the name parameter to return the best result set based on the name or name fragment.

Parameters:

name - The name or name fragment to search on.

Returns:

Throws:

ToManyResultsException - If more results than the implementation's limit are found, used to prevent using this service to spider available users

searchForUserByEmail

Set<BasicUser> searchForUserByEmail(String email)

Search for a set of users via BasicUser.getEmail(). It is up to the implementation to parse the email parameter to return the best result set based on the email or email fragment.

Parameters:

email - The email or email fragment to search on.

Returns:

Throws:

ToManyResultsException - If more results than the implementation's limit are found, used to prevent using this service to spider available users