edu.wisc.my.portlets.bookmarks.dao

Interface PreferencesStore

All Known Implementing Classes:

HibernatePreferencesStore

public interface PreferencesStore

The PreferencesStore provides the APIs to use for storing, retrieving and removing Preferences from a persitent store.

Version:

$Revision: 12161 $

Author:

Eric Dalquist eric.dalquist@doit.wisc.edu

Method Summary

Modifier and Type	Method and Description
Preferences	createPreferences(java.lang.String owner, java.lang.String name) Creates Preferences and stores it in the persistent store.
Preferences	getPreferences(java.lang.String owner, java.lang.String name) Gets the Preferences for the specified owner and name.
void	removePreferences(java.lang.String owner, java.lang.String name) Removes Preferences from the persistent store.
void	storePreferences(Preferences preferences) Stores new Preferences or updates existing Preferences.

Method Detail

getPreferences

Preferences getPreferences(java.lang.String owner,
                           java.lang.String name)

Gets the Preferences for the specified owner and name. If no Preferences can be found for the owner and name null is retuned.

Parameters:

owner - The owner of the Preferences to retreive.

name - The name of the Preferences to retrieve.

Returns:

The Preferences for the name and owner, null if one is not found for the owner and name.

storePreferences

void storePreferences(Preferences preferences)

Stores new Preferences or updates existing Preferences. Preferences are keyed uniquely using the name and owner fields.

Parameters:

preferences - The Preferences to persist.

removePreferences

void removePreferences(java.lang.String owner,
                       java.lang.String name)

Removes Preferences from the persistent store. If a Preferences matching the owner and name cannot be found this is a noop.

Parameters:

owner - The owner of the Preferences to remove.

name - The name of the Preferences to remove.

createPreferences

Preferences createPreferences(java.lang.String owner,
                              java.lang.String name)

Creates Preferences and stores it in the persistent store.

Parameters:

owner - The owner of the Preferences to create.

name - The name of the Preferences to create.

Returns:

The new Preferences.