TrueFunctionDescription (LibFormula 9.3.0.0-424 API)

java.lang.Object
- org.pentaho.reporting.libraries.formula.function.AbstractFunctionDescription
- - org.pentaho.reporting.libraries.formula.function.logical.TrueFunctionDescription

All Implemented Interfaces:

Serializable, FunctionDescription
```
public class TrueFunctionDescription
extends AbstractFunctionDescription
```
Creation-Date: 04.11.2006, 18:28:55

Author:

Thomas Morgner

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

TrueFunctionDescription()

Method Summary

All Methods Instance Methods Concrete Methods
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.

Methods inherited from class org.pentaho.reporting.libraries.formula.function.AbstractFunctionDescription
getBundle, getCanonicalName, getDefaultValue, getDescription, getDisplayName, getParameterDescription, getParameterDisplayName, isDeprecated, isExperimental, isInfiniteParameterCount, isVolatile

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TrueFunctionDescription
```
public TrueFunctionDescription()
```
- Method Detail
  - 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.
  - getValueType
```
public Type getValueType()
```
  - 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()
```