Package ch.ivyteam.ivy.workflow

Interface IWorkflowEvent

public interface IWorkflowEvent
Holds information about a event / operation that was done with a wf object (task or case)
Version:
ReW 24.4.2001 created
API:
This is a public API.

  • Method Details

    • getId

      long getId()
      The identifier of the workflow event
      Returns:
      id
      API:
      This public API is available in Java.

    • getEventKind

      WorkflowEventKind getEventKind()
      Gets the event kind
      Returns:
      event kind
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in Java.

    • getAdditionalInfo

      List<String> getAdditionalInfo()
      Gets the additional event information
      Returns:
      list with additional event information
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in Java.

    • getEventTimestamp

      Date getEventTimestamp()
      Gets the event timestamp
      Returns:
      event timestamp
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in Java.

    • getUser

      IUser getUser()
      Gets the user which is responsible for this event. If the user was deleted since this event happened this method returns null. Use method getUserName() to evaluate the name of the user even if the user was deleted.
      Returns:
      user or null
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in Java.

    • getUserName

      String getUserName()
      Gets the name of the user which is responsible for this event. This method will not return null even if the user was deleted since the event happened
      Returns:
      user name
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in Java.

    • getCaseId

      long getCaseId()
      Gets the case identifier
      Returns:
      case identifier
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in Java.

    • getTaskId

      Long getTaskId()
      Gets the task identifier. Returns null if this is a case specific event
      Returns:
      task identifier or null.
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in Java.

    • isTaskEvent

      boolean isTaskEvent()
      Returns true if this event belongs to a task, otherwise false
      Returns:
      true if event belongs to a task, otherwise false
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in Java.

    • getCaseState

      CaseState getCaseState()
      Gets the case state
      Returns:
      case state
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in Java.

    • getTaskState

      TaskState getTaskState()
      Gets the task state. Returns null if workflow event is case specific
      Returns:
      task state or null
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in Java.

    • getTask

      ITask getTask()
      Gets the task this event belongs to. Returns null if event does not belong to a task.
      Returns:
      task or null.
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in Java.

    • getCase

      ICase getCase()
      Gets the case this event belongs to.
      Returns:
      case
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in Java.