Package com.orchestranetworks.addon.dpra.function

Interface FunctionDefinition

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:

  • Method Details

    • onDataspace

      static FunctionDefinitionOnDataspaceBuilder onDataspace(String code)
      Returns the builder for a function at the dataspace level.
      Parameters:
      code - The unique code representing the function.

    • onDataset

      static FunctionDefinitionOnDatasetBuilder onDataset(String code)
      Returns the builder for a function at the dataset level.
      Parameters:
      code - The unique code representing the function.

    • onTable

      static FunctionDefinitionOnTableBuilder onTable(String code)
      Returns the builder for a function at the table level.
      Parameters:
      code - The unique code representing the function.

    • onField

      static FunctionDefinitionOnFieldBuilder onField(String code)
      Returns the builder for a function at the field level.
      Parameters:
      code - The unique code representing the function.

    • onWorkflow

      static FunctionDefinitionOnWorkflowBuilder onWorkflow(String code)
      Returns the builder for a function at the workflow level.
      Parameters:
      code - The unique code representing the function.

    • getCode

      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 List<InputDefinition> getInputDefinitions()
      Returns the list of input definitions.

      Returns an empty list by default.

    • getOutputDefinitions

      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.