```
public interface FunctionDefinition
```
A function declaration.
Instead of implementing this interface directly, we recommend creating instances of this interface with the builder API.

Since:

4.2.0

See Also:

onDataspace(String), onDataset(String), onTable(String), onField(String), onWorkflow(String), FunctionDefinitionRegistry.register(FunctionDefinition, ChartConfigForFunction)

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`AssetType`	`getAssetType()`	Returns the asset type.
`java.lang.String`	`getCode()`	Returns the unique code.
`com.onwbp.base.text.UserMessage`	`getDescription()`	Returns the description.
`FunctionExecution`	`getExecution()`	Returns the function execution.
`default java.util.List<InputDefinition>`	`getInputDefinitions()`	Returns the list of input definitions.
`com.onwbp.base.text.UserMessage`	`getLabel()`	Returns the label.
`java.util.List<OutputDefinition>`	`getOutputDefinitions()`	Returns the list of output definitions.
`default FunctionValidation`	`getValidation()`	Returns the function validation.
`default boolean`	`isAlertSupported()`	Returns `true` if alert is supported for this function.
`default boolean`	`isFilterSupported()`	Returns `true` if filter is supported for this function.
`default boolean`	`isLinkedRecordSupported()`	Returns `true` if linked record is supported for this function.
`static FunctionDefinitionOnDatasetBuilder`	`onDataset(java.lang.String code)`	Returns the builder for a function at the dataset level.
`static FunctionDefinitionOnDataspaceBuilder`	`onDataspace(java.lang.String code)`	Returns the builder for a function at the dataspace level.
`static FunctionDefinitionOnFieldBuilder`	`onField(java.lang.String code)`	Returns the builder for a function at the field level.
`static FunctionDefinitionOnTableBuilder`	`onTable(java.lang.String code)`	Returns the builder for a function at the table level.
`static FunctionDefinitionOnWorkflowBuilder`	`onWorkflow(java.lang.String code)`	Returns the builder for a function at the workflow level.

- Method Detail
  - onDataspace
```
static FunctionDefinitionOnDataspaceBuilder onDataspace(java.lang.String code)
```
    Returns the builder for a function at the dataspace level.
    
    Parameters:
    
    code - The unique code representing the function.
  - onDataset
```
static FunctionDefinitionOnDatasetBuilder onDataset(java.lang.String code)
```
    Returns the builder for a function at the dataset level.
    
    Parameters:
    
    code - The unique code representing the function.
  - onTable
```
static FunctionDefinitionOnTableBuilder onTable(java.lang.String code)
```
    Returns the builder for a function at the table level.
    
    Parameters:
    
    code - The unique code representing the function.
  - onField
```
static FunctionDefinitionOnFieldBuilder onField(java.lang.String code)
```
    Returns the builder for a function at the field level.
    
    Parameters:
    
    code - The unique code representing the function.
  - onWorkflow
```
static FunctionDefinitionOnWorkflowBuilder onWorkflow(java.lang.String code)
```
    Returns the builder for a function at the workflow level.
    
    Parameters:
    
    code - The unique code representing the function.
  - getCode
```
java.lang.String getCode()
```
    Returns the unique code.
    Must not be null or empty.
  - getLabel
```
com.onwbp.base.text.UserMessage getLabel()
```
    Returns the label.
  - getDescription
```
com.onwbp.base.text.UserMessage getDescription()
```
    Returns the description.
  - getAssetType
```
AssetType getAssetType()
```
    Returns the asset type.
    Must not be null.
  - getInputDefinitions
```
default java.util.List<InputDefinition> getInputDefinitions()
```
    Returns the list of input definitions.
    Returns an empty list by default.
  - getOutputDefinitions
```
java.util.List<OutputDefinition> getOutputDefinitions()
```
    Returns the list of output definitions.
    Must not be empty.
  - isFilterSupported
```
default boolean isFilterSupported()
```
    Returns true if filter is supported for this function.
    Returns false by default.
  - isLinkedRecordSupported
```
default boolean isLinkedRecordSupported()
```
    Returns true if linked record is supported for this function.
    Returns false by default.
  - isAlertSupported
```
default boolean isAlertSupported()
```
    Returns true if alert is supported for this function.
    Returns true by default.
  - getValidation
```
default FunctionValidation getValidation()
```
    Returns the function validation.
    Returns null by default.
  - getExecution
```
FunctionExecution getExecution()
```
    Returns the function execution.
    Must not be null.

Interface FunctionDefinition

Method Summary

Method Detail

onDataspace

onDataset

onTable

onField

onWorkflow

getCode

getLabel

getDescription

getAssetType

getInputDefinitions

getOutputDefinitions

isFilterSupported

isLinkedRecordSupported

isAlertSupported

getValidation

getExecution