Package com.aquima.interactions.foundation

Interface IPropertyContainer

All Known Subinterfaces:
IAttributeValue, IEntityInstance
All Known Implementing Classes:
AttributeState, ConcurrentEntityInstance, DependencyInstance, EntityInstance, InstanceDelegate, ReadonlyInstance, TmsAttributeState, TmsEntityInstance, TxAttributeValue, TxEntityInstance
public interface IPropertyContainer
Interface for objects supporting properties.
Since:
5.0
Author:
O. Kerpershoek

  • Method Summary

    Modifier and Type
    Method
    Description
    IValue
    getProperty(String name)
    This method will return the value of the specified property.
    String[]
    getPropertyNames()
    Returns the names of the properties.
    boolean
    hasProperty(String name)
    This method will return a boolean indicating if a property with the specified name is present.
    boolean
    setProperty(String name, IValue propertyValue)
    This method may be used to set the value of a property.

  • Method Details

    • getPropertyNames

      String[] getPropertyNames()
      Returns the names of the properties.
      Returns:
      All available properties.

    • hasProperty

      boolean hasProperty(String name)
      This method will return a boolean indicating if a property with the specified name is present.
      Parameters:
      name - The name of the property that should be checked.
      Returns:
      boolean indicating if a property with the specified name is present.

    • getProperty

      IValue getProperty(String name) throws UnknownPropertyException
      This method will return the value of the specified property.
      Parameters:
      name - The name of the property whose value is requested.
      Returns:
      The value of the property.
      Throws:
      UnknownPropertyException - This exception is thrown when no property was found for the specified name.

    • setProperty

      boolean setProperty(String name, IValue propertyValue) throws UnknownPropertyException
      This method may be used to set the value of a property.
      Parameters:
      name - The name of the property whose value should be set.
      propertyValue - The new value of the property.
      Returns:
      boolean indicating if the set operation was successful.
      Throws:
      UnknownPropertyException - This exception is thrown when no property was found for the specified name.