Interface InstanceReference

  • All Superinterfaces:
    PluginDataContainer, UserAttributeContainer

    public interface InstanceReference
    extends UserAttributeContainer, PluginDataContainer
    The lightweight representation of a process instance. This reference allows to return just the data necessary to display the process instance to the user. A full-fledged process instance is represented by a corresponding interface of the ADEPT2-processmodel.
    Author:
    Ulrich Kreher
    See Also:
    Instance
    • Method Detail

      • getID

        UUID getID()
        Returns the (logical) ID of the instance, which is system-wide unique.
        Returns:
        The (logical) instance ID.
      • getLogID

        UUID getLogID()
        Returns the (internal) ID of the instance, which is for internal and log use only.
        Returns:
        The (internal) instance ID for usage in logs and internally.
      • getName

        String getName()
        Returns the name of the instance.
        Returns:
        The name of the instance.
      • isModified

        boolean isModified()
        Returns true if the instance has been modified.
        Returns:
        true if the instance has been modified.
      • getTemplate

        TemplateReference getTemplate()
        Gets the process template which is referenced by this object. The returned object is the lightweight representation of the corresponding template.
        Returns:
        The de.aristaflow.adept2.model.processmodel.TemplateReference which represents the template of this instance.
      • getSupervisorAgent

        QualifiedAgent getSupervisorAgent()
        Returns the supervisor agent of the instance.
        Returns:
        The supervisor agent of the instance.
      • getInitiatorAgent

        QualifiedAgent getInitiatorAgent()
        Returns the qualified agent who initiated the instance.
        Returns:
        The initiating agent.
      • getCreationTime

        long getCreationTime()
        Gets the date (as long) this instance has been created.
        Returns:
        The date (as long) this instance has been created.
      • getParentInstanceID

        UUID getParentInstanceID()
        Returns the ID of the super-instance, if this instance is a sub-process.
        Returns:
        A reference to the super instance, in case this is a sub-process.
      • getExecutionStatus

        ProcessConstants.InstanceExecutionStatus getExecutionStatus()
        Returns the execution status of the instance. An instance can be running, suspended, aborted or finished.
        Returns:
        The execution status.