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,v 1.3 2004/01/19 21:32:16 hlship Exp $
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

public String getType()
Returns the class name of the expected type of the parameter. The default value is java.lang.Object which matches anything.


isRequired

public boolean isRequired()
Returns true if the parameter is required by the component. The default is false, meaning the parameter is optional.


setRequired

public void setRequired(boolean value)

setType

public void setType(String value)
Sets the type of value expected for the parameter. This can be left blank to indicate any type.


getDescription

public String getDescription()
Returns the documentation for this parameter.

Since:
1.0.9

setDescription

public void setDescription(String description)
Sets the documentation for this parameter.

Since:
1.0.9

setPropertyName

public void setPropertyName(String propertyName)
Sets the property name (of the component class) to connect the parameter to.


getPropertyName

public String getPropertyName()
Returns the name of the JavaBeans property to connect the parameter to.


getDirection

public Direction getDirection()
Returns the parameter value direction, defaulting to Direction.CUSTOM if not otherwise specified.


setDirection

public void setDirection(Direction direction)

getDefaultValue

public String getDefaultValue()
Returns the default value of the JavaBeans property if no binding is provided or null if it has not been specified


setDefaultValue

public void setDefaultValue(String defaultValue)
Sets the default value of the JavaBeans property if no binding is provided