org.apache.tapestry.spec
Interface IParameterSpecification

All Superinterfaces:

ILocatable, ILocationHolder

All Known Implementing Classes:

ParameterSpecification

public interface IParameterSpecification
extends ILocationHolder

Defines a formal parameter to a component. An IParameterSpecification is contained by a IComponentSpecification.

TBD: Identify arrays in some way.

Version:

$Id: IParameterSpecification.java 243791 2004-02-19 17:38:13Z hlship $

Author:

glongman@intelligentworks.com

Method Summary

String	getDefaultValue() Returns the default value of the JavaBeans property if no binding is provided or null if it has not been specified
String	getDescription() Returns the documentation for this parameter.
Direction	getDirection() Returns the parameter value direction, defaulting to Direction.CUSTOM if not otherwise specified.
String	getPropertyName() Returns the name of the JavaBeans property to connect the parameter to.
String	getType() Returns the class name of the expected type of the parameter.
boolean	isRequired() Returns true if the parameter is required by the component.
void	setDefaultValue(String defaultValue) Sets the default value of the JavaBeans property if no binding is provided
void	setDescription(String description) Sets the documentation for this parameter.
void	setDirection(Direction direction)
void	setPropertyName(String propertyName) Sets the property name (of the component class) to connect the parameter to.
void	setRequired(boolean value)
void	setType(String value) Sets the type of value expected for the parameter.

Methods inherited from interface org.apache.tapestry.ILocationHolder

setLocation

Methods inherited from interface org.apache.tapestry.ILocatable

getLocation

Method Detail

getType

String getType()

Returns the class name of the expected type of the parameter. The default value is java.lang.Object which matches anything.

isRequired

boolean isRequired()

Returns true if the parameter is required by the component. The default is false, meaning the parameter is optional.

setRequired

void setRequired(boolean value)

setType

void setType(String value)

Sets the type of value expected for the parameter. This can be left blank to indicate any type.

getDescription

String getDescription()

Returns the documentation for this parameter.

Since:

1.0.9

setDescription

void setDescription(String description)

Sets the documentation for this parameter.

Since:

1.0.9

setPropertyName

void setPropertyName(String propertyName)

Sets the property name (of the component class) to connect the parameter to.

getPropertyName

String getPropertyName()

Returns the name of the JavaBeans property to connect the parameter to.

getDirection

Direction getDirection()

Returns the parameter value direction, defaulting to Direction.CUSTOM if not otherwise specified.

setDirection

void setDirection(Direction direction)

getDefaultValue

String getDefaultValue()

Returns the default value of the JavaBeans property if no binding is provided or null if it has not been specified

setDefaultValue

void setDefaultValue(String defaultValue)

Sets the default value of the JavaBeans property if no binding is provided