org.sakaiproject.component.legacy.preference
Interface BasePreferencesService.Storage

All Known Implementing Classes:
DbPreferencesService.DbStorage
Enclosing interface:
BasePreferencesService

protected static interface BasePreferencesService.Storage

Storage


Method Summary
 void cancel(PreferencesEdit edit)
          Cancel the changes and release the lock.
 boolean check(String id)
          Check if a preferences by this id exists.
 void close()
          Close.
 void commit(PreferencesEdit edit)
          Commit the changes and release the lock.
 PreferencesEdit edit(String id)
          Get a lock on the preferences with this id, or null if a lock cannot be gotten.
 Preferences get(String id)
          Get the preferences with this id, or null if not found.
 void open()
          Open.
 PreferencesEdit put(String id)
          Add a new preferences with this id.
 void remove(PreferencesEdit edit)
          Remove this edit and release the lock.
 

Method Detail

open

public void open()
Open.


close

public void close()
Close.


check

public boolean check(String id)
Check if a preferences by this id exists.

Parameters:
id - The user id.
Returns:
true if a preferences for this id exists, false if not.

get

public Preferences get(String id)
Get the preferences with this id, or null if not found.

Parameters:
id - The preferences id.
Returns:
The preferences with this id, or null if not found.

put

public PreferencesEdit put(String id)
Add a new preferences with this id.

Parameters:
id - The preferences id.
Returns:
The locked Preferences object with this id, or null if the id is in use.

edit

public PreferencesEdit edit(String id)
Get a lock on the preferences with this id, or null if a lock cannot be gotten.

Parameters:
id - The preferences id.
Returns:
The locked Preferences with this id, or null if this records cannot be locked.

commit

public void commit(PreferencesEdit edit)
Commit the changes and release the lock.


cancel

public void cancel(PreferencesEdit edit)
Cancel the changes and release the lock.


remove

public void remove(PreferencesEdit edit)
Remove this edit and release the lock.