Package org.marketcetera.admin.service

Interface UserService

public interface UserService

Provides access to User objects.

Since:

2.4.2

Version:

$Id$

Author:

Colin DuPlantis

Method Summary

Modifier and Type	Method	Description
User	changeUserPassword(User inUser, String inOldRawPassword, String inNewRawPassword)	Change the password of the given user to the given value.
void	delete(User inUser)	Deletes the given user.
List<? extends User>	findAll()	Finds all current users.
CollectionPageResponse<User>	findAll(PageRequest inPageRequest)	Find a page of users.
User	findByName(String inUsername)	Gets the user with the given name.
User	findByUserId(UserID inUserId)	Find the user associated with the given user id.
User	findOne(long inValue)	Finds a single user with the given id.
List<? extends User>	listUsers(String inNameFilter, Boolean inActiveFilter)	Lists all users taking into account the given optional filters.
User	resetUserPassword(User inExistingUser, String inNewPassword)	Reset the password of the given user to the given value.
User	save(User inUser)	Saves the given user to the datastore.
void	updateUserActiveStatus(String inUsername, boolean inIsActive)	Updates the active/inactive status for the user with the given name.
void	updateUserDataByName(String inUsername, String inUserData)	Updates the user data for the user with the given name.

Method Detail

save

User save(User inUser)

Saves the given user to the datastore.

Parameters:

inUser - a User value

Returns:

a User value

findByName

User findByName(String inUsername)

Gets the user with the given name.

Parameters:

inUsername - a String value

Returns:

a User value

updateUserDataByName

void updateUserDataByName(String inUsername,
                          String inUserData)

Updates the user data for the user with the given name.

Parameters:

inUsername - a String value

inUserData - a String value

updateUserActiveStatus

void updateUserActiveStatus(String inUsername,
                            boolean inIsActive)

Updates the active/inactive status for the user with the given name.

Parameters:

inUsername - a String value

inIsActive - a boolean value

listUsers

List<? extends User> listUsers(String inNameFilter,
                               Boolean inActiveFilter)

Lists all users taking into account the given optional filters.

Parameters:

inNameFilter - a String value

inActiveFilter - a Boolean value

Returns:

a List<? extends User> value

delete

void delete(User inUser)

Deletes the given user.

Parameters:

inUser - a User value

findAll

List<? extends User> findAll()

Finds all current users.

Returns:

a List<? extends User> value

findAll

CollectionPageResponse<User> findAll(PageRequest inPageRequest)

Find a page of users.

Parameters:

inPageRequest - a PageRequest value

Returns:

a CollectionPageResponse<User> value

findOne

User findOne(long inValue)

Finds a single user with the given id.

Parameters:

inValue - a long value

Returns:

a User value or null

findByUserId

User findByUserId(UserID inUserId)

Find the user associated with the given user id.

Parameters:

inUserId - a UserID value

Returns:

a User value or null

changeUserPassword

User changeUserPassword(User inUser,
                        String inOldRawPassword,
                        String inNewRawPassword)

Change the password of the given user to the given value.

Parameters:

inUser - a User value

inOldRawPassword - a String value

inNewRawPassword - a String value

Returns:

a User value

resetUserPassword

User resetUserPassword(User inExistingUser,
                       String inNewPassword)

Reset the password of the given user to the given value.

Parameters:

inExistingUser - a User value

inNewPassword - a String value

Returns:

a User value