Package com.aquima.interactions.project

Interface IServiceDefinition

All Superinterfaces:
Serializable
All Known Implementing Classes:
ServiceDefinition
public interface IServiceDefinition extends Serializable
This interface defines a service that is available in a project.
Since:
7.1
Author:
O. Kerpershoek

  • Method Summary

    Modifier and Type
    Method
    Description
    String[]
    getExitEvents()
    This method returns an array containing the event type names that are supported by this service.
    String
    getName()
    This method returns the unique name of the service.
    IParameterDefinition
    getParameter(String name)
    This method returns the parameter definition for the specified name.
    String[]
    getParameterNames()
    This method returns an array containing all the parameter names.
    IParameterDefinition[]
    getParameters()
    This method returns an array containing the definitions of the parameters that are supported by this component.

  • Method Details

    • getName

      String getName()
      This method returns the unique name of the service. In service calls, this name will be referred to as the service type name.
      Returns:
      The unique name of the service.

    • getParameterNames

      String[] getParameterNames()
      This method returns an array containing all the parameter names.
      Returns:
      Array containing all the parameter names.

    • getParameter

      IParameterDefinition getParameter(String name)
      This method returns the parameter definition for the specified name.
      Parameters:
      name - The name of the requested parameter.
      Returns:
      The definition of the parameter for the specified name.
      Throws:
      UnknownParameterException - This exception is thrown when no parameter is available with the specified name.

    • getParameters

      IParameterDefinition[] getParameters()
      This method returns an array containing the definitions of the parameters that are supported by this component.
      Returns:
      Array containing the definitions of the parameters that are supported by this component.

    • getExitEvents

      String[] getExitEvents()
      This method returns an array containing the event type names that are supported by this service.
      Returns:
      Array containing all the exit event names, never null, but can be an empty array.