Package com.aquima.interactions.foundation

Interface IParameters

All Superinterfaces:
Serializable
All Known Subinterfaces:
ITypedParameters
All Known Implementing Classes:
Parameters, TypedParameters
public interface IParameters extends Serializable
Interface to allow objects to expose parameters. The parameter keys are not case sensitive.
Since:
5.0
Author:
O. Kerpershoek

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getParameter(String key)
    This method will return the value for the specified parameter key.
    String[]
    getParameterKeys()
    This method returns an array containing all the parameter keys that are defined.
    boolean
    hasParameter(String key)
    This method will return a boolean indicating if a parameter with the specified key is present.
    boolean
    isEmpty()
    This method returns a boolean indicating whether the parameter map is empty (contains no parameters).

  • Method Details

    • isEmpty

      boolean isEmpty()
      This method returns a boolean indicating whether the parameter map is empty (contains no parameters).
      Returns:
      true when this object hold no parameters, false when one or more parameters are present.

    • hasParameter

      boolean hasParameter(String key)
      This method will return a boolean indicating if a parameter with the specified key is present. The parameter key is not case sensitive.
      Note: When this method returns true for a specified parameter key, the value of that parameter may still be empty.
      Parameters:
      key - String containing the parameter key.
      Returns:
      boolean indicating if the parameter is defined.

    • getParameter

      String getParameter(String key)
      This method will return the value for the specified parameter key. The returned value may be null when either the parameter key was unknown, or when the value for that parameter key was specifically defined as empty. When a null is returned, the hasParameter method may be used to check if the parameter was present (intended null) or unknown.
      Parameters:
      key - The parameter key for which the value is requested.
      Returns:
      The value for the specified parameter key.

    • getParameterKeys

      String[] getParameterKeys()
      This method returns an array containing all the parameter keys that are defined. When no parameters are present (isEmpty method return true), an empty array will be returned.
      Returns:
      Array containing all parameter keys.