Interface ServiceOperation

All Known Implementing Classes:
BaseServiceOperation

public interface ServiceOperation
  • Method Details

    • getKey

      String getKey()
    • getName

      String getName()
    • getDescription

      String getDescription()
    • getOutputType

      String getOutputType()
      An optional output type for the operation, which can be either an 'object' or an 'array'. If set, the caller of the service can be sure that specified type will be returned. For example, when 'array' is set, the runtime will wrap a non-array response into an array. If not set (default), the service response is determined based on the type the service returns at runtime.
      Returns:
      the configured output type for the operation. If left empty, the default behaviour is used to return based on the service implementation response.
    • getType

      String getType()
      See Also:
    • getConfig

      com.fasterxml.jackson.databind.JsonNode getConfig()
    • getInputParameters

      List<ServiceInputParameter> getInputParameters()
    • getOutputParameters

      List<ServiceOutputParameter> getOutputParameters()