Package com.aquima.interactions.portal

Interface ITypedParameter

All Superinterfaces:
Serializable
All Known Implementing Classes:
EmptyTypedParameter, ReferenceParameter, TypedParameter, ValueParameter
public interface ITypedParameter extends Serializable
This interface is used to expose a single typed parameter of a service or container expander.
Since:
7.0
Author:
J. van Leuven

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    asString()
    This method returns the String representation of this typed parameter.
    Direction
    getDirection()
    This method returns the direction of this typed parameter.
    IExpression
    getExpression()
    This method returns the expression of this typed parameter when this is an expression parameter.
    String
    getReferenceName()
    This method returns the name of an object this parameter is referring to when this is an reference parameter I.e a button name
    String[]
    getReferenceNames()
    This method returns the names of an object this parameter is referring to when this is an reference parameter.
    ITypedParameterValue
    getSingleValue()
    This method return a single value contained in this parameter (the first in case of a multivalued parameter).
    ParameterType
    getType()
    This method returns the type of this typed parameter.
    IValue
    getValue()
    This method returns the value of this typed parameter when this is an value parameter For multivalued parameters this method wil return an IListValue.
    ITypedParameterValue[]
    getValues()
    This method return all the values contained in this parameter.
    boolean
    isEmpty()
    This method returns the true if this typed parameter contains a value.
    boolean
    isMultiValue()
    This method returns a boolean indicating if the parameter can have multiple values.

  • Method Details

    • getType

      ParameterType getType()
      This method returns the type of this typed parameter.
      Returns:
      The type of this typed parameter, never null.

    • getDirection

      Direction getDirection()
      This method returns the direction of this typed parameter.
      Returns:
      The direction of this typed parameter, never null.

    • getValues

      ITypedParameterValue[] getValues()
      This method return all the values contained in this parameter.
      Returns:
      The parameter values, never null (possibly an empty array).

    • getSingleValue

      ITypedParameterValue getSingleValue()
      This method return a single value contained in this parameter (the first in case of a multivalued parameter).
      Returns:
      The parameter value, may be null

    • getExpression

      IExpression getExpression()
      This method returns the expression of this typed parameter when this is an expression parameter.
      Returns:
      The expression, may be null.
      Throws:
      IllegalArgumentException - When this typed parameter is no expression parameter.

    • getValue

      IValue getValue()
      This method returns the value of this typed parameter when this is an value parameter For multivalued parameters this method wil return an IListValue.
      Returns:
      The value, may be null.
      Throws:
      IllegalArgumentException - When this typed parameter is no value parameter.

    • getReferenceName

      String getReferenceName()
      This method returns the name of an object this parameter is referring to when this is an reference parameter I.e a button name
      Returns:
      The name of the referring object, may be null.
      Throws:
      IllegalArgumentException - When this typed parameter is no reference parameter, or it is a multivalued reference attribute.

    • getReferenceNames

      String[] getReferenceNames()
      This method returns the names of an object this parameter is referring to when this is an reference parameter. I.e a button names.
      Returns:
      The names of the referring object, cannot be null, but can return an empty array..
      Throws:
      IllegalArgumentException - When this typed parameter is no reference parameter.

    • asString

      String asString()
      This method returns the String representation of this typed parameter.
      Returns:
      The string representation of this typed parameter, may be null.

    • isEmpty

      boolean isEmpty()
      This method returns the true if this typed parameter contains a value.
      Returns:
      True if this typed parameters contains no value.

    • isMultiValue

      boolean isMultiValue()
      This method returns a boolean indicating if the parameter can have multiple values.
      Returns:
      boolean indicating if the parameter can have multiple values.