ca.bc.gov.webade.preferences.util
Interface WebADEPreferenceIterator


public interface WebADEPreferenceIterator

Used to iterate through a set of preferences from some source, like a database or XML file, for the purposes of loading into memory.

Author:
jross

Field Summary
static java.lang.String PREFERENCE_APPLICATION_ACRONYM_ATTR
          Reserved name for the preference application acronym attribute, for use in the WebADEPreferenceIterator.getAttribute() method.
static java.lang.String PREFERENCE_EUSER_ID_ATTR
          Reserved name for the preference EUser ID attribute, for use in the WebADEPreferenceIterator.getAttribute() method.
static java.lang.String PREFERENCE_NAME_ATTR
          Reserved name for the preference name attribute, for use in the WebADEPreferenceIterator.getAttribute() method.
static java.lang.String PREFERENCE_SET_NAME_ATTR
          Reserved name for the preference set name attribute, for use in the WebADEPreferenceIterator.getAttribute() method.
static java.lang.String PREFERENCE_SUB_TYPE_ATTR
          Reserved name for the preference sub type attribute, for use in the WebADEPreferenceIterator.getAttribute() method.
static java.lang.String PREFERENCE_TYPE_CODE_ATTR
          Reserved name for the preference type code attribute, for use in the WebADEPreferenceIterator.getAttribute() method.
static java.lang.String PREFERENCE_VALUE_ATTR
          Reserved name for the preference value attribute, for use in the WebADEPreferenceIterator.getAttribute() method.
 
Method Summary
 java.lang.Object getAttribute(java.lang.String attributeName)
          Returns the current preference's attribute value for the given attribute name.
 boolean next()
          Tells the iterator to move on to the next record in the set.
 

Field Detail

PREFERENCE_TYPE_CODE_ATTR

public static final java.lang.String PREFERENCE_TYPE_CODE_ATTR
Reserved name for the preference type code attribute, for use in the WebADEPreferenceIterator.getAttribute() method.

See Also:
Constant Field Values

PREFERENCE_SUB_TYPE_ATTR

public static final java.lang.String PREFERENCE_SUB_TYPE_ATTR
Reserved name for the preference sub type attribute, for use in the WebADEPreferenceIterator.getAttribute() method.

See Also:
Constant Field Values

PREFERENCE_SET_NAME_ATTR

public static final java.lang.String PREFERENCE_SET_NAME_ATTR
Reserved name for the preference set name attribute, for use in the WebADEPreferenceIterator.getAttribute() method.

See Also:
Constant Field Values

PREFERENCE_NAME_ATTR

public static final java.lang.String PREFERENCE_NAME_ATTR
Reserved name for the preference name attribute, for use in the WebADEPreferenceIterator.getAttribute() method.

See Also:
Constant Field Values

PREFERENCE_VALUE_ATTR

public static final java.lang.String PREFERENCE_VALUE_ATTR
Reserved name for the preference value attribute, for use in the WebADEPreferenceIterator.getAttribute() method.

See Also:
Constant Field Values

PREFERENCE_APPLICATION_ACRONYM_ATTR

public static final java.lang.String PREFERENCE_APPLICATION_ACRONYM_ATTR
Reserved name for the preference application acronym attribute, for use in the WebADEPreferenceIterator.getAttribute() method.

See Also:
Constant Field Values

PREFERENCE_EUSER_ID_ATTR

public static final java.lang.String PREFERENCE_EUSER_ID_ATTR
Reserved name for the preference EUser ID attribute, for use in the WebADEPreferenceIterator.getAttribute() method.

See Also:
Constant Field Values
Method Detail

next

public boolean next()
             throws WebADEException
Tells the iterator to move on to the next record in the set.

Returns:
True if there are more records in this set of preferences.
Throws:
WebADEException - Thrown if an error occurs while performing this operation.

getAttribute

public java.lang.Object getAttribute(java.lang.String attributeName)
                              throws WebADEException
Returns the current preference's attribute value for the given attribute name.

Parameters:
attributeName - The name of the attribute.
Returns:
The preference value, or null if not set for this preference.
Throws:
WebADEException - Thrown if an error occurs while performing this operation.