org.pentaho.aggdes.model

Interface Parameter

All Known Implementing Classes:

Algorithm.ParameterEnum

public interface Parameter

Definition of a parameter for a component of an aggregate designer algorithm.

Implementations of components typically declare the parameters that they accept using an enum that also implements this interface.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Parameter.Type

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription() Returns the description of this Parameter.
String	getName() Returns the name of this Parameter.
Parameter.Type	getType() Returns the of this Parameter.
boolean	isRequired() Returns whether the parameter is required.

Method Detail

isRequired

boolean isRequired()

Returns whether the parameter is required.

Returns:

whether Parameter is required

getType

Parameter.Type getType()

Returns the of this Parameter.

Returns:

type of this parameter.

getDescription

String getDescription()

Returns the description of this Parameter.

Returns:

description of Parameter

getName

String getName()

Returns the name of this Parameter.

Returns:

name of this Parameter