Package nz.org.riskscape.engine.function

Interface IdentifiedFunction

All Superinterfaces:
AutoCloseable, Identified, RiskscapeFunction, UntypedFunction
All Known Implementing Classes:
IdentifiedFunction.Wrapping, JavaFunction, MetadataBasedFunction, RealizableFunction.MetadataIdentifiedRealizableFunction
public interface IdentifiedFunction extends RiskscapeFunction, Identified

A RiskscapeFunction that is identified by its Identified.getId().

Being identified by the ID is required for the function to be called from other contexts.

  • Method Details

    • getDescription

      String getDescription()
      Returns:
      a human readable description of the function

    • getSource

      String getSource()
      Returns:
      a string indicating the source of function. file/uri etc.

    • getCategory

      IdentifiedFunction.Category getCategory()
      Returns:
      the category that this function belongs to

    • infoOutput

      default String infoOutput()

      Get information about this function.

    • toEntity

      default Map<String,Object> toEntity()

      Returns a map-view of this fragility function

    • isBuiltin

      default boolean isBuiltin()
      Returns:
      true if this is a built-in function provided by RiskScape