Package com.aquima.interactions.metamodel

Interface IInstanceReference

All Superinterfaces:
Serializable
All Known Implementing Classes:
ChildInstance, InstanceReference, NamedInstance
public interface IInstanceReference extends Serializable
The instance reference interface exposes methods that can be used to identify an instance definition. There are tow type of instance references possible, and depending on the type of reference, certain methods in this interface will be relevant.
  • Named reference
    A named reference is a reference that identifies the instance definition it refers to by name and type.
  • Direct reference
    A direct reference is a reference that directly includes the definition of the instance it refers to.
Since:
5.0
Author:
O. Kerpershoek

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getEntityName()
    This method returns the entity type of the instance this reference refers to.
    IInstanceDefinition
    getInstanceDefinition()
    This method returns the instance definition of the instance that this reference refers to.
    String
    getInstanceName()
    This method returns the name of the instance this reference refers to.
    boolean
    isDirectReference()
    This method can be used to determine if this reference is a direct reference.
    boolean
    isNamedReference()
    This method can be used to determine if this reference is a named reference.

  • Method Details

    • isNamedReference

      boolean isNamedReference()
      This method can be used to determine if this reference is a named reference. A reference is either a named reference or a direct reference, so either this method will return true or the isDirectReference method will return true, but never both.
      Returns:
      true when the reference refers to the definition by name and type.

    • isDirectReference

      boolean isDirectReference()
      This method can be used to determine if this reference is a direct reference. A reference is either a named reference or a direct reference, so either this method will return true or the isNamedReference method will return true, but never both.
      Returns:
      true when the reference contains the definition of the instance it refers to.

    • getEntityName

      String getEntityName()
      This method returns the entity type of the instance this reference refers to. This method is only applicable for named references. For a direct reference, this method will return a null value.
      Returns:
      The type of the instance that is referred to.

    • getInstanceName

      String getInstanceName()
      This method returns the name of the instance this reference refers to. This method is only applicable for named references. For a direct reference, this method will return a null value.
      Returns:
      The name of the instance that is referred to.

    • getInstanceDefinition

      IInstanceDefinition getInstanceDefinition()
      This method returns the instance definition of the instance that this reference refers to. This method is only applicable for direct references. For a named reference, this method will return a null value.
      Returns:
      The instance definition of the instance this reference refers.