Package org.alfresco.repo.workflow.jscript

Class JscriptWorkflowInstance

  • All Implemented Interfaces:
    java.io.Serializable
    public class JscriptWorkflowInstance
extends java.lang.Object
implements java.io.Serializable
    Class representing an active or in-flight workflow
    Author:
    glenj
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      JscriptWorkflowInstance​(java.lang.String id, java.lang.String description, java.util.Date startDate, ServiceRegistry serviceRegistry, org.mozilla.javascript.Scriptable scope)
      Creates a new instance of WorkflowInstance from scratch
      JscriptWorkflowInstance​(WorkflowInstance cmrWorkflowInstance, ServiceRegistry serviceRegistry, org.mozilla.javascript.Scriptable scope)
      Create a new instance of WorkflowInstance from a WorkflowInstance object from the CMR workflow object model

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      void cancel()
      Cancel workflow instance
      void delete()
      Deprecated.
      as 'delete' is a JavaScript reserved word and so is unusable.
      java.lang.String getDescription()
      Getter for description property
      org.mozilla.javascript.Scriptable getEndDate()
      Getter for endDate property
      java.lang.String getId()
      Getter for id property
      org.mozilla.javascript.Scriptable getPaths()
      Get all paths for the specified workflow instance
      org.mozilla.javascript.Scriptable getStartDate()
      Getter for startDate property
      boolean isActive()
      Get state for active property
      void remove()
      Deletes workflow instance.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • JscriptWorkflowInstance

        public JscriptWorkflowInstance​(java.lang.String id,
                               java.lang.String description,
                               java.util.Date startDate,
                               ServiceRegistry serviceRegistry,
                               org.mozilla.javascript.Scriptable scope)
        Creates a new instance of WorkflowInstance from scratch
        Parameters:
        id - ID of new workflow instance object
        description - Description of new workflow instance object
        startDate - Start Date of new workflow instance object
        serviceRegistry - Service Registry instance
        scope - the root scripting scope for this object

      • JscriptWorkflowInstance

        public JscriptWorkflowInstance​(WorkflowInstance cmrWorkflowInstance,
                               ServiceRegistry serviceRegistry,
                               org.mozilla.javascript.Scriptable scope)
        Create a new instance of WorkflowInstance from a WorkflowInstance object from the CMR workflow object model
        Parameters:
        cmrWorkflowInstance - CMR workflow instance
        serviceRegistry - Service Registry instance
        scope - the root scripting scope for this object

    • Method Detail

      • getPaths

        public org.mozilla.javascript.Scriptable getPaths()
        Get all paths for the specified workflow instance

      • getId

        public java.lang.String getId()
        Getter for id property
        Returns:
        the id

      • getDescription

        public java.lang.String getDescription()
        Getter for description property
        Returns:
        the description

      • isActive

        public boolean isActive()
        Get state for active property
        Returns:
        the active

      • getStartDate

        public org.mozilla.javascript.Scriptable getStartDate()
        Getter for startDate property
        Returns:
        the startDate

      • getEndDate

        public org.mozilla.javascript.Scriptable getEndDate()
        Getter for endDate property
        Returns:
        the endDate

      • cancel

        public void cancel()
        Cancel workflow instance

      • delete

        public void delete()
        Deprecated.
        as 'delete' is a JavaScript reserved word and so is unusable. Use remove() instead.
        Delete workflow instance

      • remove

        public void remove()
        Deletes workflow instance.
        Since:
        3.4.9