Package lumis.content.workflow

Class WorkflowConfig

  • @StableMinor(version="17.0",
             sinceVersion="4.0")
public class WorkflowConfig
extends java.lang.Object
    Contains the definition information for a workflow.
    Since:
    4.0.0
    Version:
    $Revision: 26586 $ $Date: 2024-08-26 21:06:04 -0300 (Mon, 26 Aug 2024) $

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String LUMIS_STANDARDWORKFLOW_ID
      Lumis standard workflow identifier.

    • Constructor Summary

      Constructors 
      Constructor Description
      WorkflowConfig()  

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      java.util.List<IWorkflowActionHandler> getActionHandlers()
      Returns the action handlers for this workflow.
      java.lang.String getBaseUrl()
      Returns the relative path to this workflow's definition directory.
      java.lang.String getDefinition()
      Returns the definition for this workflow, as a string.
      org.w3c.dom.Node getDefinitionXmlNode()
      Deprecated.
      Since 4.0.11, this method is no longer used and may be removed in the future.
      java.lang.String getDescription()
      Returns the description for this workflow.
      java.lang.String getId()
      Returns this workflow's identifier.
      java.lang.String getName()
      Returns the name for this workflow.
      IResource getResource()
      Returns the localization resource for this workflow.
      java.util.List<WorkflowRoleConfig> getRoles()
      Returns the roles for this Workflow.
      WorkflowStateConfig getStartState()
      Returns the start state for this workflow.
      WorkflowStateConfig getState​(java.lang.String stateId)
      Returns the specified state of this workflow.
      java.util.List<WorkflowStateConfig> getStates()
      Returns all states of this workflow.
      java.lang.String getStringsUrlPrefix()
      Returns the first string resource path for this workflow.
      java.util.List<java.lang.String> getStringsUrlPrefixes()
      Returns this workflow's string resource paths.
      void setBaseUrl​(java.lang.String baseUrl)
      Sets the relative path to this workflow's definition directory.
      void setDefinition​(java.lang.String definition)
      Sets the definition for this workflow.
      void setDefinition​(org.w3c.dom.Node workflowNode)
      Sets the definition for this workflow.
      void setDescription​(java.lang.String description)
      Sets this workflow's description.
      void setId​(java.lang.String id)
      Sets this workflow's identifier.
      void setName​(java.lang.String name)
      Sets this workflow's name.
      void setStringsUrlPrefix​(java.lang.String stringsUrlPrefix)
      Sets the string resource path for this workflow.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • LUMIS_STANDARDWORKFLOW_ID

        public static final java.lang.String LUMIS_STANDARDWORKFLOW_ID
        Lumis standard workflow identifier.
        Since:
        8.1.0
        See Also:
        Constant Field Values

    • Constructor Detail

      • WorkflowConfig

        public WorkflowConfig()

    • Method Detail

      • getDefinition

        public java.lang.String getDefinition()
                               throws PortalException
        Returns the definition for this workflow, as a string.
        Returns:
        the definition for this workflow, as a string.
        Throws:
        PortalException

      • getDefinitionXmlNode

        @Deprecated
public org.w3c.dom.Node getDefinitionXmlNode()
        Deprecated.
        Since 4.0.11, this method is no longer used and may be removed in the future.
        Returns:
        the definition node.

      • setDefinition

        public void setDefinition​(java.lang.String definition)
                   throws PortalException
        Sets the definition for this workflow.
        Parameters:
        definition - the definition to set.
        Throws:
        PortalException

      • setDefinition

        public void setDefinition​(org.w3c.dom.Node workflowNode)
                   throws PortalException
        Sets the definition for this workflow.
        Parameters:
        workflowNode - the node containing the workflow's definition.
        Throws:
        PortalException

      • getId

        public java.lang.String getId()
        Returns this workflow's identifier.
        Returns:
        this workflow's identifier.

      • setId

        public void setId​(java.lang.String id)
        Sets this workflow's identifier.
        Parameters:
        id - the identifier to set.

      • getDescription

        public java.lang.String getDescription()
        Returns the description for this workflow.
        Returns:
        this workflow's description, localizable using its workflow's string resource, or null if not defined.
        See Also:
        getResource()

      • setDescription

        public void setDescription​(java.lang.String description)
        Sets this workflow's description.
        Parameters:
        description - the description to set.
        See Also:
        getDescription()

      • getName

        public java.lang.String getName()
        Returns the name for this workflow.
        Returns:
        this workflow's name, localizable using its workflow's string resource.
        See Also:
        getResource()

      • setName

        public void setName​(java.lang.String name)
        Sets this workflow's name.
        Parameters:
        name - the name to set.
        See Also:
        getName()

      • getBaseUrl

        public java.lang.String getBaseUrl()
        Returns the relative path to this workflow's definition directory.
        Returns:
        the relative path, relative to the definition directory, to this workflow's definition directory.

      • setBaseUrl

        public void setBaseUrl​(java.lang.String baseUrl)
        Sets the relative path to this workflow's definition directory.
        Parameters:
        baseUrl - the value to set.
        See Also:
        getBaseUrl()

      • getStringsUrlPrefix

        public java.lang.String getStringsUrlPrefix()
        Returns the first string resource path for this workflow.
        Returns:
        the first string resource path for this workflow or null if this workflow has no resource path.

      • setStringsUrlPrefix

        public void setStringsUrlPrefix​(java.lang.String stringsUrlPrefix)
        Sets the string resource path for this workflow. All current string resource paths for this workflow are discarded.
        Parameters:
        stringsUrlPrefix - the value to set.

      • getStringsUrlPrefixes

        public java.util.List<java.lang.String> getStringsUrlPrefixes()
        Returns this workflow's string resource paths.
        Returns:
        a list with this workflow's string resource paths, or null if none was specified.

      • getResource

        public IResource getResource()
                      throws PortalException
        Returns the localization resource for this workflow.
        Returns:
        the localization resource for this workflow.
        Throws:
        PortalException

      • getStates

        public java.util.List<WorkflowStateConfig> getStates()
        Returns all states of this workflow.
        Returns:
        all states of this workflow.

      • getStartState

        public WorkflowStateConfig getStartState()
        Returns the start state for this workflow.
        Returns:
        the start state for this workflow.

      • getRoles

        public java.util.List<WorkflowRoleConfig> getRoles()
        Returns the roles for this Workflow.
        Returns:
        the roles for this Workflow.

      • getActionHandlers

        public java.util.List<IWorkflowActionHandler> getActionHandlers()
        Returns the action handlers for this workflow.
        Returns:
        the action handlers for this workflow.
        Since:
        4.0.4