org.apache.jetspeed.om.common.preference
Interface PreferenceComposite

All Superinterfaces:
org.apache.pluto.om.Controller, org.apache.pluto.om.Model, org.apache.pluto.om.common.Preference, org.apache.pluto.om.common.PreferenceCtrl, java.io.Serializable
All Known Implementing Classes:
PrefsPreference

public interface PreferenceComposite
extends org.apache.pluto.om.common.PreferenceCtrl, org.apache.pluto.om.common.Preference, java.io.Serializable

PreferenceComposite

Version:
$Id: PreferenceComposite.java,v 1.2 2004/06/18 20:46:21 weaver Exp $
Author:
Scott T. Weaver

Field Summary
static java.lang.String DEFAULT_PREFERENCE
           
static java.lang.String USER_PREFERENCE
           
 
Method Summary
 void addDescription(java.util.Locale locale, java.lang.String Description)
           
 void addValue(java.lang.String value)
           addValue
 java.lang.String[] cloneValues()
           
 org.apache.pluto.om.common.Description getDescription(java.util.Locale locale)
           
 java.util.Iterator getDescriptions()
           
 java.lang.String getType()
           
 java.lang.String[] getValueArray()
           
 java.lang.String getValueAt(int index)
           
 void removeValueAt(int index)
           
 void setType(java.lang.String string)
           
 void setValueAt(int index, java.lang.String value)
           setValueAt
 void setValues(java.lang.String[] stringValues)
           setValues
 
Methods inherited from interface org.apache.pluto.om.common.PreferenceCtrl
setName, setReadOnly, setValues
 
Methods inherited from interface org.apache.pluto.om.common.Preference
getName, getValues, isReadOnly, isValueSet
 

Field Detail

DEFAULT_PREFERENCE

static final java.lang.String DEFAULT_PREFERENCE
See Also:
Constant Field Values

USER_PREFERENCE

static final java.lang.String USER_PREFERENCE
See Also:
Constant Field Values
Method Detail

addDescription

void addDescription(java.util.Locale locale,
                    java.lang.String Description)

getDescription

org.apache.pluto.om.common.Description getDescription(java.util.Locale locale)

getValueAt

java.lang.String getValueAt(int index)
Parameters:
index -
Returns:
The String value at the specified index or null if no values are present.
Throws:
java.lang.ArrayIndexOutofBounds - if index is outside the constraints

removeValueAt

void removeValueAt(int index)
Parameters:
index -

setValueAt

void setValueAt(int index,
                java.lang.String value)

setValueAt

Sets the current Preference's value at index to the specified value

Parameters:
index - Index hows value will be set.
value - Value to set

addValue

void addValue(java.lang.String value)

addValue

Adds a new value to this Preference.

Parameters:
value - Vale to add to the preference

getValueArray

java.lang.String[] getValueArray()
Returns:

setValues

void setValues(java.lang.String[] stringValues)

setValues

Replaces the current set of values of this preference with this one.

Parameters:
stringValues -

getType

java.lang.String getType()
Returns:

setType

void setType(java.lang.String string)
Parameters:
string -

cloneValues

java.lang.String[] cloneValues()

getDescriptions

java.util.Iterator getDescriptions()


Copyright © 1999-2009 Apache Software Foundation. All Rights Reserved.