atg.svc.repository.beans
Interface Option

All Known Subinterfaces:

SegmentedOption, SiteOption, UserOption

All Known Implementing Classes:

_SegmentedOption_BeanImpl, _SegmentedOption_Impl, _SegmentedOption_ReposImpl, _SiteOption_BeanImpl, _SiteOption_Impl, _SiteOption_ReposImpl, _UserOption_BeanImpl, _UserOption_Impl, _UserOption_ReposImpl

public interface Option

Defines a common interface for Option objects.

Version:

$Id: //application/service/version/2007.3/common/src/classes/atg/svc/repository/beans/Option.java#2 $$Change: 632007 $

Author:

dkenyon

Field Summary

static java.lang.String

CLASS_VERSION

Method Summary

java.lang.String[]	getAllowedValues() Gets the values allowed to be set on this option.
java.lang.String	getDefaultValue() Gets the default value of the option to use when the user input value is null.
java.lang.String	getName() Gets the name of the option.
java.lang.String	getRawValue() Gets the user input value of the option.
java.lang.String	getValue() Gets the value of the option, either the user input or the default in the user input is null.
void	setDefaultValue(java.lang.String pValue) Sets the default value of the option to use when the user input value is null.
void	setName(java.lang.String pValue) Sets the name of the option.
void	setRawValue(java.lang.String pValue) Sets the user input value of the option.
void	setValue(java.lang.String pValue) Sets the user input value of the option

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

See Also:

Constant Field Values

Method Detail

getDefaultValue

java.lang.String getDefaultValue()

Gets the default value of the option to use when the user input value is null.

Returns:

The String value of the option.

setDefaultValue

void setDefaultValue(java.lang.String pValue)

Sets the default value of the option to use when the user input value is null.

Parameters:

pValue - The String value of the option.

getName

java.lang.String getName()

Gets the name of the option.

Returns:

The name of the option.

setName

void setName(java.lang.String pValue)

Sets the name of the option.

Parameters:

pValue - The name of the option.

getRawValue

java.lang.String getRawValue()

Gets the user input value of the option.

Returns:

The user input value of the option.

setRawValue

void setRawValue(java.lang.String pValue)

Sets the user input value of the option.

Parameters:

pValue - The user input value of the option.

getValue

java.lang.String getValue()

Gets the value of the option, either the user input or the default in the user input is null.

Returns:

The String value of the option.

setValue

void setValue(java.lang.String pValue)

Sets the user input value of the option

Parameters:

pValue - The String value of the option.

getAllowedValues

java.lang.String[] getAllowedValues()

Gets the values allowed to be set on this option.

Returns:

A String array representation of values allowed to be set on this option.