| com.flexive.shared.interfaces.ResultPreferencesEngine
All known Subclasses: com.flexive.ejb.beans.search.ResultPreferencesEngineBean,
| ResultPreferencesEngine | | public interface ResultPreferencesEngine (Code) | | Interface for retrieving and updating the displayed result properties.
author:
Daniel Lichtenberger (daniel.lichtenberger@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at)
version:
$Rev: 181 $ |
| Method Summary | |
| boolean | isCustomized(long typeId, ResultViewType viewType, ResultLocation location)
Returns true when the user actually stored a configuration for the given parameters. | | ResultPreferences | load(long typeId, ResultViewType viewType, ResultLocation location)
Loads the result preferences for the given type for the current user. | | void | remove(long typeId, ResultViewType viewType, ResultLocation location)
Remove the current user's preferences for the given parameters. | | void | save(ResultPreferences preferences, long typeId, ResultViewType viewType, ResultLocation location)
Save the given result preferences for the current user. | | void | saveDefaultPreferences(ResultPreferences preferences, long typeId, ResultViewType viewType, ResultLocation location)
Save the given result preferences as the default settings for the given type, viewtype, and location. |
| isCustomized | | boolean isCustomized(long typeId, ResultViewType viewType, ResultLocation location) throws FxApplicationException(Code) | | Returns true when the user actually stored a configuration for the given parameters. Used to check
if fallbacks were used when loading preferences via
ResultPreferencesEngine.load .
Parameters:
typeId - the content type ID, or -1 for the "overall" properties
Parameters:
viewType - the view type (list, thumbs)
Parameters:
location - the "location" where the results will be displayed (e.g. the main admin result pages) true when the user actually stored a configuration for the given parameters
throws:
FxApplicationException - on errors |
| load | | ResultPreferences load(long typeId, ResultViewType viewType, ResultLocation location) throws FxApplicationException(Code) | | Loads the result preferences for the given type for the current user. When no preferences are
defined for the given parameters, the default preferences are returned.
Parameters:
typeId - the content type ID, or -1 for the "overall" properties
Parameters:
viewType - the view type (list, thumbs)
Parameters:
location - the "location" where the results will be displayed (e.g. the main admin result pages) the result preferences for the given type for the current user.
throws:
com.flexive.shared.exceptions.FxApplicationException - if the result preferences could not be loaded |
| remove | | void remove(long typeId, ResultViewType viewType, ResultLocation location) throws FxApplicationException(Code) | | Remove the current user's preferences for the given parameters. If no preferences exist
for the given parameters, no action is performed.
Parameters:
typeId - the content type ID, or -1 for the "overall" properties
Parameters:
viewType - the view type (list, thumbs)
Parameters:
location - the "location" where the results will be displayed (e.g. the main admin result pages)
throws:
FxApplicationException - if the user's preferences could not be removed |
| save | | void save(ResultPreferences preferences, long typeId, ResultViewType viewType, ResultLocation location) throws FxApplicationException(Code) | | Save the given result preferences for the current user.
Parameters:
preferences - the preferences to be saved
Parameters:
typeId - the content type ID
Parameters:
viewType - the view type (list, thumbs)
Parameters:
location - the "location" where the results will be displayed
throws:
FxApplicationException - if the result preferences could not be updated |
| saveDefaultPreferences | | void saveDefaultPreferences(ResultPreferences preferences, long typeId, ResultViewType viewType, ResultLocation location) throws FxApplicationException(Code) | | Save the given result preferences as the default settings for the given type, viewtype, and location.
Only the global supervisor can do this.
Parameters:
preferences - the preferences to be saved
Parameters:
typeId - the content type ID
Parameters:
viewType - the view type (list, thumbs)
Parameters:
location - the "location" where the results will be displayed
throws:
FxApplicationException - if the result preferences could not be updated |
|
|