Package com.aquima.interactions.process

Interface IProcessCaseView

All Known Implementing Classes:
ProcessCaseView
public interface IProcessCaseView
This interface defines a readonly view of a process case
Since:
9.2
Author:
N. van Noorloos

  • Method Summary

    Modifier and Type
    Method
    Description
    AttributeReference[]
    getAttributes()
    this method returns the attributes from the case for which a value is set
    IValue
    getAttributeValue(String entityName, String attributeName)
    this method returns the value of the attribute from the case the task is defined for.
    DateTimeValue
    getCreationDate()
    This method returns the date at which the case is started.
    IMultilingualText
    getDisplayName()
    This method returns the display name of the task as present in the case definition.
    long
    getId()
    This method returns the unique ID of this case.
    String
    getName()
    This method returns the name of the case as present in the task definition.
    CaseStatusType
    getStatus()
    This method returns the current status of the case.
    boolean
    isCaseLocked()
    This method returns if the case the task is defined for is locked.

  • Method Details

    • getId

      long getId()
      This method returns the unique ID of this case.
      Returns:
      the unique ID of this process step.

    • isCaseLocked

      boolean isCaseLocked()
      This method returns if the case the task is defined for is locked.
      Returns:
      a boolean indicating if the case the task is defined for is locked

    • getName

      String getName()
      This method returns the name of the case as present in the task definition.
      Returns:
      The name of the case.

    • getDisplayName

      IMultilingualText getDisplayName()
      This method returns the display name of the task as present in the case definition.
      Returns:
      The display name of the case.

    • getStatus

      CaseStatusType getStatus()
      This method returns the current status of the case.
      Returns:
      the current status of the case.

    • getCreationDate

      DateTimeValue getCreationDate()
      This method returns the date at which the case is started.
      Returns:
      The date at which the case is started.

    • getAttributeValue

      IValue getAttributeValue(String entityName, String attributeName)
      this method returns the value of the attribute from the case the task is defined for.
      Parameters:
      entityName - The entity where the attribute belongs to.
      attributeName - The name of the attribute.
      Returns:
      The value of the attribute from the case the task is defined for.

    • getAttributes

      AttributeReference[] getAttributes()
      this method returns the attributes from the case for which a value is set
      Returns:
      the attributes from the case for which a value is set