org.kuali.rice.kew.useroptions

Interface UserOptionsService

All Known Implementing Classes:

UserOptionsServiceImpl

public interface UserOptionsService

Sits on top of the UserOptionsTable and manages certain aspects of action list refresh behaviors. This service could probably be broken up and it's dao put somewhere else and injected in the appropriate places.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteUserOptions(UserOptions userOptions) Removes the given UserOptions from the underlining datasource.
UserOptions	findByOptionId(String optionId, String principalId) Find a UserOptions for the given option id and principal id.
List<UserOptions>	findByUserQualified(String principalId, String likeString) Finds a collection of UserOptions for the given principal id and search string.
Collection<UserOptions>	findByWorkflowUser(String principalId) Finds UserOptions for the given workflow id.
List<UserOptions>	retrieveEmailPreferenceUserOptions(String emailSetting) Finds a List of UserOptions for the given email setting.
void	save(String principalId, Map<String,String> optionsMap) This overridden method saves an option for each optionsMap entry, all for the given principalId.
void	save(String principalId, String optionId, String optionValue) Combines the given parameters into an UserOptions and persists the object to the datasource.
void	save(UserOptions userOptions) Persists the given UserOptions to the datasource.

Method Detail

findByWorkflowUser

Collection<UserOptions> findByWorkflowUser(String principalId)

Finds UserOptions for the given workflow id.

Parameters:

principalId - the workflow id to search by

Returns:

a collection of UserOptions or an empty collection if no results were found.

findByUserQualified

List<UserOptions> findByUserQualified(String principalId,
                                    String likeString)

Finds a collection of UserOptions for the given principal id and search string.

Parameters:

principalId - the workflow id.

likeString - the option id search string.

Returns:

A List of UserOptions or an empty collection if no results are found.

save

void save(UserOptions userOptions)

Persists the given UserOptions to the datasource.

Parameters:

userOptions - the UserOptions to persist to the datasource

save

void save(String principalId,
        Map<String,String> optionsMap)

This overridden method saves an option for each optionsMap entry, all for the given principalId.

Parameters:

principalId - the unique identifier

optionsMap - a Map of user options keyed with option ids

save

void save(String principalId,
        String optionId,
        String optionValue)

Combines the given parameters into an UserOptions and persists the object to the datasource.

Parameters:

principalId - the principal id to persist to the datasource

optionId - the option id to persist to the datasource

optionValue - the option value to persist to the datasource

deleteUserOptions

void deleteUserOptions(UserOptions userOptions)

Removes the given UserOptions from the underlining datasource.

Parameters:

userOptions - the UserOptions to delete

findByOptionId

UserOptions findByOptionId(String optionId,
                         String principalId)

Find a UserOptions for the given option id and principal id.

Parameters:

optionId - the option id to search by.

principalId - the workflow id to search by

Returns:

a UserOptions or null if no results are found.

retrieveEmailPreferenceUserOptions

List<UserOptions> retrieveEmailPreferenceUserOptions(String emailSetting)

Finds a List of UserOptions for the given email setting.

Parameters:

emailSetting - the option value to search by.

Returns:

a List of UserOptions or an empty collection if no results are found.