org.sakaiproject.service.legacy.preference
Interface Preferences

All Superinterfaces:
Comparable, Entity
All Known Subinterfaces:
PreferencesEdit
All Known Implementing Classes:
BasePreferencesService.BasePreferences

public interface Preferences
extends Entity, Comparable

Preferences stores keyed sets of properties for a given user (id).

Version:
$Revision: 2371 $
Author:
University of Michigan, Sakai Software Development Team

Field Summary
 
Fields inherited from interface org.sakaiproject.service.legacy.entity.Entity
SEPARATOR
 
Method Summary
 String getId()
          Access the user of the user who owns these Preferences.
 Collection getKeys()
          Access the keys defined in this Preferences
 ResourceProperties getProperties(String key)
          Access the properties keyed by the specified value.
 
Methods inherited from interface org.sakaiproject.service.legacy.entity.Entity
getProperties, getReference, getReference, getUrl, getUrl, toXml
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Method Detail

getId

public String getId()
Access the user of the user who owns these Preferences.

Specified by:
getId in interface Entity
Returns:
The user id for these preferences.

getProperties

public ResourceProperties getProperties(String key)
Access the properties keyed by the specified value.

Parameters:
key - The key to the properties.
Returns:
The properties keyed by the specified value (possibly empty)

getKeys

public Collection getKeys()
Access the keys defined in this Preferences

Returns:
A Collection of the keys (String) defined in this Preferences.