Package lumis.content.workflow

Class WorkflowConfig

  • @StableMinor(version="14.1",
             sinceVersion="4.0")
public class WorkflowConfig
extends Object
    Contains the definition information for a workflow.
    Since:
    4.0.0
    Version:
    $Revision: 24684 $ $Date: 2021-08-23 18:58:35 -0300 (Mon, 23 Aug 2021) $

    • Field Detail

      • LUMIS_STANDARDWORKFLOW_ID

        public static final 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 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 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​(String definition)
                   throws PortalException
        Sets the definition for this workflow.
        Parameters:
        definition - the definition to set.
        Throws:
        PortalException

      • setDefinition

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

      • getId

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

      • setId

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

      • getDescription

        public 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​(String description)
        Sets this workflow's description.
        Parameters:
        description - the description to set.
        See Also:
        getDescription()

      • getName

        public 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​(String name)
        Sets this workflow's name.
        Parameters:
        name - the name to set.
        See Also:
        getName()

      • getBaseUrl

        public 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​(String baseUrl)
        Sets the relative path to this workflow's definition directory.
        Parameters:
        baseUrl - the value to set.
        See Also:
        getBaseUrl()

      • getStringsUrlPrefix

        public 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​(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 List<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 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 List<WorkflowRoleConfig> getRoles()
        Returns the roles for this Workflow.
        Returns:
        the roles for this Workflow.

      • getActionHandlers

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