Package ch.ivyteam.ivy.application

Interface IActivity

All Known Subinterfaces:
IApplication, IProcessModel, IProcessModelVersion, IWorkflowProcessModelVersion
public interface IActivity
The activity interface defines the state of activity of certain objects in the workflow engine
Version:
05.11.2003 created
API:
This is a public API.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    activate()
    Activates the object
    The object changes from inactive to active or from active_lock to active
    void
    deactivate()
    Deactivates the object
    The object changes from active or active and locked to deactivating and after a while to inactive
    ActivityOperationState
    getActivityOperationState()
    Gets the current activity operation state.
    ActivityState
    getActivityState()
    Returns the current activity state.
    void
    lock()
    Locks the object
    The object state changes from active to active and locked
    New cases can not be started and suspended task can not be resumed -> 503 error.

  • Method Details

    • getActivityState

      ActivityState getActivityState()
      Returns the current activity state. Note that the activity state immediatly changes after one of the activity state methods are called. But the object implementing the activity may have to do some operatations till the activity state is reached. Therefore the activity operation state indicates if those operations are still in progress or if the object already have reached the activity state.
      Returns:
      current activity state
      Throws:
      PersistencyException
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.

    • getActivityOperationState

      ActivityOperationState getActivityOperationState()
      Gets the current activity operation state. The activity operation state indicates if the activity state returned by getActivityState() is already reached, or if some operations are still in progress to reach the activity state.
      Returns:
      current activity operation state
      Throws:
      PersistencyException
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.

    • activate

      void activate()
      Activates the object
      The object changes from inactive to active or from active_lock to active
      Throws:
      PersistencyException - if db access fails
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.
      Security:
      Application: SESSION OWNS ApplicationActivate PERMISSION OR OWNS ApplicationActivate@SYSTEM PERMISSION
      ProcessModel: SESSION OWNS ProcessModelActivate PERMISSION OR OWNS ProcessModelActivate@SYSTEM PERMISSION
      ProcessModelVersion: SESSION OWNS ProcessModelVersionActivate PERMISSION OR OWNS ProcessModelVersionActivate@SYSTEM PERMISSION

    • deactivate

      void deactivate()
      Deactivates the object
      The object changes from active or active and locked to deactivating and after a while to inactive
      Throws:
      PersistencyException - if db access fails
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.
      Security:
      Application: SESSION OWNS ApplicationDeactivate PERMISSION OR OWNS ApplicationDeactivate@SYSTEM PERMISSION
      ProcessModel: SESSION OWNS ProcessModelDeactivate PERMISSION OR OWNS ProcessModelDeactivate@SYSTEM PERMISSION
      ProcessModelVersion: SESSION OWNS ProcessModelVersionDeactivate PERMISSION OR OWNS ProcessModelVersionDeactivate@SYSTEM PERMISSION

    • lock

      void lock()
      Locks the object
      The object state changes from active to active and locked
      New cases can not be started and suspended task can not be resumed -> 503 error.
      Requests to resumed task are allowed.
      Throws:
      PersistencyException - if db access fails
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.
      Security:
      Application: SESSION OWNS ApplicationLock PERMISSION OR OWNS ApplicationLock@SYSTEM PERMISSION
      ProcessModel: SESSION OWNS ProcessModelLock PERMISSION OR OWNS ProcessModelLock@SYSTEM PERMISSION
      ProcessModelVersion: SESSION OWNS ProcessModelVersionLock PERMISSION OR OWNS ProcessModelVersionLock@SYSTEM PERMISSION