Package com.aquima.interactions.project

Interface IExpanderDefinition

All Superinterfaces:
Serializable
All Known Implementing Classes:
ExpanderDefinition
public interface IExpanderDefinition extends Serializable
This interface defines a single (container) expander type that can be used by the composers of the project modules.
Since:
7.1
Author:
O. Kerpershoek

  • Method Details

    • getName

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

    • getDescription

      String getDescription()
      This method returns a description of the container expander.
      Returns:
      A description of the container expander (maybe null).

    • 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.