atg.portal.framework

Interface GearParameter

public interface GearParameter

Represents an gear parameter

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDefaultValue() The default value of the parameter
java.lang.String[]	getDefaultValues()
java.util.List	getDefaultValuesAsList()
java.lang.String	getDescription() The description of the parameter
java.lang.String	getName() The name of the parameter
boolean	isReadOnly()
boolean	isRequired() Returns true if this parameter is required
void	setDefaultValue(java.lang.String pValue) Sets the default value of the parameter
void	setDefaultValues(java.util.Collection pValues)
void	setDefaultValues(java.lang.String[] pValues)
void	setDescription(java.lang.String pDescription) Sets the description of the parameter
void	setReadOnly(java.lang.Boolean boolean1)

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

The name of the parameter

Returns:

a name

isRequired

boolean isRequired()

Returns true if this parameter is required

Returns:

true if is required, false otherwise

getDescription

java.lang.String getDescription()

The description of the parameter

Returns:

the description of the parameter

setDescription

void setDescription(java.lang.String pDescription)

Sets the description of the parameter

Parameters:

pValue - the description

getDefaultValue

java.lang.String getDefaultValue()

The default value of the parameter

Returns:

the default value of the parameter

getDefaultValues

java.lang.String[] getDefaultValues()

getDefaultValuesAsList

java.util.List getDefaultValuesAsList()

setDefaultValue

void setDefaultValue(java.lang.String pValue)

Sets the default value of the parameter

Parameters:

pValue - the default value

setDefaultValues

void setDefaultValues(java.lang.String[] pValues)

setDefaultValues

void setDefaultValues(java.util.Collection pValues)

isReadOnly

boolean isReadOnly()

Returns:

setReadOnly

void setReadOnly(java.lang.Boolean boolean1)

Parameters:

boolean1 -