|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectca.bc.gov.webade.Preferences
Contains the set of Preference objects and the set of PreferenceSet objects for a particular target(Global, Application, Extension, User).
| Constructor Summary | |
Preferences()
Default Constructor. |
|
Preferences(Preferences prefs)
Clone Constructor. |
|
| Method Summary | |
void |
addPreference(Preference pref)
Adds the given Preference object to the set of preferences. |
void |
addPreferenceSet(PreferenceSet prefSet)
Adds the given Preference object to the target set of preferences identified by the set name. |
void |
addPreferenceToSet(java.lang.String setName,
Preference pref)
Adds the given Preference object to the target set of preferences identified by the set name. |
static Preferences |
convertToPreferences(WebADEPreferences prefs)
|
static WebADEPreferences |
convertToWebADEPreferences(Preferences prefs)
|
Preference |
getPreference(java.lang.String preferenceSubType,
java.lang.String preferenceName)
Returns the target preference, identified by sub-type and name. |
java.util.Properties |
getPreferencePropertiesBySubType(java.lang.String preferenceSubType)
Returns the preferences that match the given subtype as name value pairs in a Properties object. |
java.util.Iterator |
getPreferences()
Returns the set of preferences. |
java.util.ArrayList |
getPreferencesBySubType(java.lang.String preferenceSubType)
Returns the preferences that match the given subtype. |
PreferenceSet |
getPreferenceSet(java.lang.String preferenceSubType,
java.lang.String preferenceSetName)
Returns the target preference set. |
java.util.Iterator |
getPreferenceSets()
Returns the preference sets. |
java.util.ArrayList |
getPreferenceSetsBySubType(java.lang.String preferenceSubType)
Returns the preference sets that match the given subtype. |
java.util.ArrayList |
getPreferenceSubTypes()
Returns all subtypes in the . |
| Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
public Preferences()
public Preferences(Preferences prefs)
prefs - The Preferences object to clone.| Method Detail |
public static final Preferences convertToPreferences(WebADEPreferences prefs)
prefs - The WebADEPreferences object to convert.
public static final WebADEPreferences convertToWebADEPreferences(Preferences prefs)
prefs - The Preferences object to convert.
public java.util.ArrayList getPreferenceSubTypes()
public Preference getPreference(java.lang.String preferenceSubType,
java.lang.String preferenceName)
preferenceSubType - The sub-type containing the preference.preferenceName - The target preference name.
public java.util.ArrayList getPreferencesBySubType(java.lang.String preferenceSubType)
preferenceSubType - The sub-type containing the preference.
public java.util.Properties getPreferencePropertiesBySubType(java.lang.String preferenceSubType)
throws WebADEException
preferenceSubType - The sub-type containing the preference.
WebADEException - Thrown if any of the Preference object with the given subtype
have more than one value assigned.public java.util.Iterator getPreferences()
public PreferenceSet getPreferenceSet(java.lang.String preferenceSubType,
java.lang.String preferenceSetName)
throws WebADEException
preferenceSubType - The sub-type containing the preference.preferenceSetName - The target preference set name.
WebADEException - Thrown if more than one preference set match is found.public java.util.ArrayList getPreferenceSetsBySubType(java.lang.String preferenceSubType)
preferenceSubType - The sub-type containing the preference.
public java.util.Iterator getPreferenceSets()
public final void addPreference(Preference pref)
throws WebADEException
pref - The target preference to add.
WebADEException - thrown if the preference-type does not match the Preferences
preference-type
public final void addPreferenceToSet(java.lang.String setName,
Preference pref)
throws WebADEException
setName - The preference set to add the preference to.pref - The target preference to add.
WebADEException - thrown if the preference-type does not match the Preferences
preference-type
public final void addPreferenceSet(PreferenceSet prefSet)
throws WebADEException
prefSet - The target preference set to add.
WebADEException - thrown if the preference-type does not match the Preferences
preference-type
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||