Package org.pentaho.reporting.libraries.formula.function.datetime

Class TodayFunctionDescription

java.lang.Object

org.pentaho.reporting.libraries.formula.function.AbstractFunctionDescription

org.pentaho.reporting.libraries.formula.function.datetime.TodayFunctionDescription

All Implemented Interfaces:

java.io.Serializable, FunctionDescription

public class TodayFunctionDescription
extends AbstractFunctionDescription

Creation-Date: 04.11.2006, 18:59:11

Author:

Thomas Morgner

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
TodayFunctionDescription()

Method Summary

Modifier and Type	Method	Description
FunctionCategory	getCategory()
int	getParameterCount()
Type	getParameterType(int position)	Returns the parameter type at the given position using the function metadata.
Type	getValueType()
boolean	isParameterMandatory(int position)	Defines, whether the parameter at the given position is mandatory.
boolean	isVolatile()

Methods inherited from class org.pentaho.reporting.libraries.formula.function.AbstractFunctionDescription

getCanonicalName, getDefaultValue, getDescription, getDisplayName, getParameterDescription, getParameterDisplayName, isInfiniteParameterCount

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TodayFunctionDescription

public TodayFunctionDescription()

Method Detail

getValueType

public Type getValueType()

isVolatile

public boolean isVolatile()

Specified by:

isVolatile in interface FunctionDescription

Overrides:

isVolatile in class AbstractFunctionDescription

getParameterCount

public int getParameterCount()

getParameterType

public Type getParameterType(int position)

Description copied from interface: FunctionDescription

Returns the parameter type at the given position using the function metadata. The first parameter is at the position 0;

Parameters:

position - The parameter index.

Returns:

The parameter type.

isParameterMandatory

public boolean isParameterMandatory(int position)

Defines, whether the parameter at the given position is mandatory. A mandatory parameter must be filled in, while optional parameters need not to be filled in.

Returns:

getCategory

public FunctionCategory getCategory()