Skip navigation links

oracle.imaging
Interface PreferenceService

public interface PreferenceService

The service for interacting with preferences. The methods on this service are related to storage and retrieval of state information that is needed for later user. Even though any string can be used in this manager it is preferable that this be XML data. Using XML will allow for later debugging of data and ease of correcting if needed. The information stored can be as much, as little, as specific, or as generic as the implementer requires. Storing and retrieval of this information is broken down into two different types: - The first is the system level preferences. These generic preferences that only system level configuration administrators be able to save but that all users can access. For instance, the perferred color scheme for the overall application. - The second is the user level preferences that only the current user of the system can save or access their specific preference information. For instance, saving the perferred view of a document.

Method Summary

java.lang.String	getSystemPreference(java.lang.String context) Loads the generic system level preferences specified.
java.lang.String	getUserPreference(java.lang.String context) Loads the user level preferences specified.
void	setSystemPreference(java.lang.String context, java.lang.String preferences) Saves the generic system level preferences specified.
void	setUserPreference(java.lang.String context, java.lang.String preferences) Saves the user level preferences specified.

Method Detail

setSystemPreference

void setSystemPreference(java.lang.String context,
                         java.lang.String preferences)
                         throws ImagingException

Saves the generic system level preferences specified.

Parameters:

context - The unique value used to save the system preferences. For example, this string could be 'System Colors'.

preferences - The persistent information to store. This should be an XML file that contains the persistent information, but can be any character based value(s) as well. Passing a null value will remove the preference file if one exist.

Throws:

ImagingException

getSystemPreference

java.lang.String getSystemPreference(java.lang.String context)
                                     throws ImagingException

Loads the generic system level preferences specified.

Parameters:

context - The unique value used to load the system preferences. This is the same value used during the setSystemPreference method.

Returns:

The persistent information to stored based of the context value specified.

Throws:

ImagingException

setUserPreference

void setUserPreference(java.lang.String context,
                       java.lang.String preferences)
                       throws ImagingException

Saves the user level preferences specified.

Parameters:

context - The unique value used to save the user preferences. For example, this string could be 'System Colors'.

preferences - The persistent information to store. This should be an XML file that contains the persistent information, but can be any character based value(s) as well. Passing a null value will remove the preference file if one exist.

Throws:

ImagingException

getUserPreference

java.lang.String getUserPreference(java.lang.String context)
                                   throws ImagingException

Loads the user level preferences specified.

Parameters:

context - The unique value used to load the user preferences. This is the same value used during the setSystemPreference method.

Returns:

The persistent information to stored based of the context value specified.

Throws:

ImagingException

Skip navigation links