org.ucmtwine.parameter
Interface IParameter

All Known Implementing Classes:

BooleanParameter, DateParameter, DoubleParameter, FloatParameter, InjectedParameter, IntegerParameter, LongParameter, Parameter, ProviderParameter, ResultSetParameter, StringParameter

public interface IParameter

Method Summary

Object	getArgumentValue(Object object, intradoc.server.Service service) Get the value from another object, casting if needed.
Object	getBinderValue(intradoc.server.Service service) Get the value from the binder, checking for type compatibility and mandatory requirements.
int	getGrammarElementType() Returns the GrammarElement type for use in idoc script function definitions.
String	getName()
Class<?>	getType() Returns the class of the binder variable after type coercion.
boolean	isRequired()
String	toActionString() Gets a parameter definition string for use in service actions.

Method Detail

getName

String getName()

isRequired

boolean isRequired()

getBinderValue

Object getBinderValue(intradoc.server.Service service)
                      throws IllegalAccessException

Get the value from the binder, checking for type compatibility and mandatory requirements.

Parameters:

service - The execution context.

Returns:

A type cast value or null

Throws:

IllegalAccessException

getArgumentValue

Object getArgumentValue(Object object,
                        intradoc.server.Service service)
                        throws ClassCastException

Get the value from another object, casting if needed.

Parameters:

object -

Returns:

Throws:

ClassCastException

getType

Class<?> getType()

Returns the class of the binder variable after type coercion.

Returns:

toActionString

String toActionString()

Gets a parameter definition string for use in service actions.

Returns:

getGrammarElementType

int getGrammarElementType()

Returns the GrammarElement type for use in idoc script function definitions.

Returns: