Package com.axemble.vdoc.sdk.interfaces

Interface IWorkflowInstance

All Superinterfaces:
IDelegationSupport, IDeletionSupport, IElement, ILocalizationScope, ILockSupport, IProtocolSupport, IResource, ISearchSupport, ISecuritySupport, IUriSupport, Serializable
All Known Implementing Classes:
ProcessWorkflowInstance
public interface IWorkflowInstance extends IResource, IDeletionSupport, ISearchSupport, IUriSupport, IDelegationSupport, ILocalizationScope, ILockSupport
This class represents a process document.
Since:
1.0, 15/04/2008
Author:
vlygeros
See Also:

  • Method Details

    • getEndedDate

      Date getEndedDate()
      Gets the ended date.
      Returns:
      a Date object.

    • getWorkflow

      IWorkflow getWorkflow()
      Gets the associated workflow.
      Returns:
      a IWorkflow object.

    • getCatalog

      ICatalog getCatalog()
      Gets the catalog.
      Returns:
      a ICatalog object.

    • getCurrentTaskInstance

      ITaskInstance getCurrentTaskInstance(IContext context)
      Gets the current task instance.
      Parameters:
      context - The execution context.
      Returns:
      a ITaskInstance object.

    • getParentInstance

      IWorkflowInstance getParentInstance()
      Gets the parent instance.
      Returns:
      a IWorkflowInstance object.

    • getParentInstanceInFormulaContext

      IWorkflowInstance getParentInstanceInFormulaContext()
      Gets the parent instance with the rights of its creator. Is only used in the formulas
      Returns:
      a IWorkflowInstance object.

    • addLinkedWorkflowInstance

      boolean addLinkedWorkflowInstance(String propertyName, IWorkflowInstance linkedWorkflowInstance)
      Allows to add a workflow instance object to a linked table field.
      Parameters:
      propertyName - The system property of the field.
      linkedWorkflowInstance - The IWorkflowInstance to add.
      Returns:
      true if successful,
      invalid @link 
      {@link false
      } otherwise.

    • addLinkedWorkflowInstances

      boolean addLinkedWorkflowInstances(String propertyName, Collection<? extends IWorkflowInstance> linkedWorkflowInstances)
      Allows to add an association between a workflow instance object and a linked table field.
      Parameters:
      propertyName - The system property of the field.
      linkedWorkflowInstances - A collection of IWorkflowInstance objects to add.
      Returns:
      true if successful,
      invalid @link 
      {@link false
      } otherwise.

    • addLinkedWorkflowInstance

      boolean addLinkedWorkflowInstance(String propertyName, IWorkflowInstance linkedWorkflowInstance, boolean withSubscription)
      Allows to add a workflow instance object to a linked table field.
      Parameters:
      propertyName - The system property of the field.
      linkedWorkflowInstance - The IWorkflowInstance to add.
      withSubscription -
      invalid @link 
      {@link true
      } to apply inter-resources subscription rules.
      Returns:
      true if successful,
      invalid @link 
      {@link false
      } otherwise.

    • addLinkedWorkflowInstances

      boolean addLinkedWorkflowInstances(String propertyName, Collection<? extends IWorkflowInstance> linkedWorkflowInstances, boolean withSubscription)
      Allows to add an association between a workflow instance object and a linked table field.
      Parameters:
      propertyName - The system property of the field.
      linkedWorkflowInstances - A collection of IWorkflowInstance objects to add.
      withSubscription -
      invalid @link 
      {@link true
      } to apply inter-resources subscription rules.
      Returns:
      true if successful,
      invalid @link 
      {@link false
      } otherwise.

    • getLinkedWorkflowInstances

      Collection<? extends IWorkflowInstance> getLinkedWorkflowInstances(String propertyName)
      Retrieves all the linked workflow instance of a linked table field.
      Parameters:
      propertyName - The system property of the field.
      Returns:
      a collection of IWorkflowInstance objects.

    • deleteLinkedWorkflowInstance

      void deleteLinkedWorkflowInstance(String propertyName, IWorkflowInstance linkedWorkflowInstance)
      Allows to remove the association between a workflow instance object and a linked table field. Warning, unlinking a child with a strong link with the parent document will delete it permanently.
      Parameters:
      propertyName - The system property of the field.
      linkedWorkflowInstance - The IWorkflowInstance to remove.

    • deleteLinkedWorkflowInstances

      void deleteLinkedWorkflowInstances(String propertyName, Collection<? extends IWorkflowInstance> linkedWorkflowInstances)
      Allows to remove the associations between a collection of IWorkflowInstance objects and a linked table field. Warning, unlinking a child with a strong link with the parent document will delete it permanently.
      Parameters:
      propertyName - The system property of the field.
      linkedWorkflowInstances - The collection of IWorkflowInstance objects.

    • suspend

      @Deprecated void suspend()
      Deprecated.
      : use lock() method instead.
      Denies any cross-transition actions.

    • resume

      @Deprecated void resume()
      Deprecated.
      : use unlock() method instead.
      Allows cross-transition actions.

    • getStatus

      int getStatus()
      Gets the system status
      Returns:
      Returns one of the IWorkflowInstance.IStatus values.

    • getParentContainerWorkflowInstance

      IWorkflowInstance getParentContainerWorkflowInstance()
      In embedded workflow, return the parent workflow instance
      Returns:
      the parent workflowinstance that started the workflow

    • getEmbeddedWorkflowInstances

      Collection<? extends IWorkflowInstance> getEmbeddedWorkflowInstances()
      In embedded workflow, return all embedded workflow instances
      Returns:
      all embedded workflow instances