public interface FunctionDescription extends Serializable
Modifier and Type | Method and Description |
---|---|
String |
getCanonicalName() |
FunctionCategory |
getCategory() |
Object |
getDefaultValue(int position)
Returns the default value for an optional parameter.
|
String |
getDescription(Locale locale) |
String |
getDisplayName(Locale locale) |
int |
getParameterCount() |
String |
getParameterDescription(int position,
Locale locale) |
String |
getParameterDisplayName(int position,
Locale locale) |
Type |
getParameterType(int position)
Returns the parameter type at the given position using the function metadata.
|
Type |
getValueType() |
boolean |
isDeprecated() |
boolean |
isExperimental() |
boolean |
isInfiniteParameterCount() |
boolean |
isParameterMandatory(int position)
Defines, whether the parameter at the given position is mandatory.
|
boolean |
isVolatile() |
String getCanonicalName()
boolean isVolatile()
Type getValueType()
FunctionCategory getCategory()
boolean isDeprecated()
boolean isExperimental()
int getParameterCount()
boolean isInfiniteParameterCount()
Type getParameterType(int position)
position
- The parameter index.boolean isParameterMandatory(int position)
Object getDefaultValue(int position)
position
- Copyright © 2002–2017 Pentaho Corporation. All rights reserved.