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, Serializable

public interface PreferenceComposite

extends org.apache.pluto.om.common.PreferenceCtrl, org.apache.pluto.om.common.Preference, Serializable

PreferenceComposite

Version:

$Id: PreferenceComposite.java,v 1.2 2004/06/18 20:46:21 weaver Exp $

Author:

Scott T. Weaver

Field Summary

static String	DEFAULT_PREFERENCE
static String	USER_PREFERENCE

Method Summary

void	addDescription(Locale locale, String Description)
void	addValue(String value) addValue
String[]	cloneValues()
org.apache.pluto.om.common.Description	getDescription(Locale locale)
Iterator	getDescriptions()
String	getType()
String[]	getValueArray()
String	getValueAt(int index)
void	removeValueAt(int index)
void	setType(String string)
void	setValueAt(int index, String value) setValueAt
void	setValues(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

public static final String DEFAULT_PREFERENCE

See Also:

Constant Field Values

USER_PREFERENCE

public static final String USER_PREFERENCE

See Also:

Constant Field Values

Method Detail

addDescription

public void addDescription(Locale locale,
                           String Description)

getDescription

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

getValueAt

public 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

public void removeValueAt(int index)

Parameters:

index -

setValueAt

public void setValueAt(int index,
                       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

public void addValue(String value)

addValue

Adds a new value to this Preference.

Parameters:

value - Vale to add to the preference

getValueArray

public String[] getValueArray()

Returns:

setValues

public void setValues(String[] stringValues)

setValues

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

Parameters:

stringValues -

getType

public String getType()

Returns:

setType

public void setType(String string)

Parameters:

string -

cloneValues

public String[] cloneValues()

getDescriptions

public Iterator getDescriptions()