Package de.espirit.firstspirit.access.store.templatestore

Interface Workflow

All Superinterfaces:
Comparable<StoreElement>, GomSourceProvider, HistoryProvider, IDProvider, PackagePoolItem, StoreElement, TemplateStoreElement, Workflowable
@NonExtendable public interface Workflow extends IDProvider, GomSourceProvider, PackagePoolItem, TemplateStoreElement
Definition of a workflow element.
Since:
3.0

  • Field Details

    • UID_TYPE

      static final IDProvider.UidType UID_TYPE
      The workflow's UID type.
      Since:
      4.1.10

  • Method Details

    • getWorkflowModel

      Workflow getWorkflowModel()
      Provides the workflow model as defined for this workflow.
      Returns:
      The workflow model.
      Since:
      3.0

    • setWorkflowModel

      void setWorkflowModel(Workflow workflowModel)
      Defines the workflow model for this workflow.
      Parameters:
      workflowModel - The workflow model.
      Since:
      3.0

    • getWorkflowId

      long getWorkflowId()
      Returns the workflow id of this workflow. The workflow id is an id which is distinct within the project of this workflow and not to confuse with the element id which is distinct on the whole server.
      Returns:
      workflow id
      Since:
      3.0

    • isWebedit

      boolean isWebedit()
      Returns true if this workflow is an webedit workflow, false otherwise.
      Since:
      3.1.186

    • setWebedit

      void setWebedit(boolean webedit)
      Use true to mark this workflow as a webedit workflow.
      Since:
      3.1.186

    • isContextFree

      boolean isContextFree()
      Indicates this workflow to operate context free.
      Returns:
      true, if context free.
      Since:
      3.1.186

    • setContextFree

      void setContextFree(boolean contextFree)
      Defines this workflow to operate context free.
      Parameters:
      contextFree - true, to mark this workflow context free.
      Since:
      3.1.186

    • getAlwaysActive

      @Deprecated(forRemoval=true) boolean getAlwaysActive()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 5.1.32 use isAlwaysActive()
      Is this Workflow always active or should a view script be executed.
      Since:
      4.0.120

    • isAlwaysActive

      boolean isAlwaysActive()
      Indicates whether this Workflow is always active (true). In this case a defined view script will be ignored. If false the view script will be executed if there is one.
      Returns:
      true if this workflow is always active, ignoring the view script
      Since:
      5.1.32
      See Also:

    • setAlwaysActive

      void setAlwaysActive(boolean alwaysActive)
      Set always active parameter.
      Since:
      4.0.120

    • getViewScript

      String getViewScript()
      Get the view script.
      Since:
      4.0.120

    • getViewScriptExecutable

      Executable getViewScriptExecutable()
      Get view script executable.
      Since:
      4.0.120

    • setViewScript

      void setViewScript(String script)
      Set view script.
      Since:
      4.0.120