org.talika.tarsis.command
Interface CommandParameter

All Known Implementing Classes:

CommandParameterImpl

public interface CommandParameter

Interface that defines a command parameter in Tarsis MVC Framework.

A command parameter represents a value to be passed to command in order to be executed correctly. Parameters can be required or optional and can have one or more values.

Version:

$Revision: 121 $

Author:

Jose M. Palomar

See Also:

Command

Method Summary

java.lang.Object	defaultValue() Returns the default value of parameter if no other is provided.
java.lang.String	getName() Returns the name of parameter.
java.lang.Class	getType() Returns the type of parameter.
boolean	isMultiple() Returns true if parameter can have multiple values.
boolean	isRequired() Returns true if parameter is required.

Method Detail

getName

public java.lang.String getName()

Returns the name of parameter.

Returns:

String name of parameter.

getType

public java.lang.Class getType()

Returns the type of parameter. The type is represented by a class instance. Supported types are:

• java.lang.String
• java.lang.Integer
• java.lang.Long
• java.lang.Double
• java.lang.Float
• java.lang.Boolean
• java.util.Date
• java.sql.Date
• java.sql.Time
• java.sql.Timestamp
• java.io.File

Returns:

Class type of parameter.

isRequired

public boolean isRequired()

Returns true if parameter is required.

Returns:

boolean true if parameter is required.

isMultiple

public boolean isMultiple()

Returns true if parameter can have multiple values.

Returns:

boolean true if parameter can have multiple values.

defaultValue

public java.lang.Object defaultValue()

Returns the default value of parameter if no other is provided.

Returns:

Object default value of parameter.