Package com.day.cq.wcm.workflow.api

Interface WcmWorkflowService

  • public interface WcmWorkflowService
    The WcmWorkflowService interface defines (util) methods that are used in the WCM system in cunjunction with the workflow engine.

    • Field Detail

      • EVENT_TOPIC

        static final java.lang.String EVENT_TOPIC
        Request for de/activation event topic
        See Also:
        Constant Field Values

    • Method Detail

      • isInWorkflow

        boolean isInWorkflow​(java.lang.String pagePath)
        Checks wether a Page is subject of a running Workflow instance.
        Parameters:
        pagePath - path of Page to check
        Returns:
        true if Page is subject of a running workflow

      • getRequestForReplicationWorkflowModel

        WorkflowModel getRequestForReplicationWorkflowModel​(ReplicationActionType replicationType)
        Returns the preconfigured WorkflowModel for the desired ReplicationActionType. This is used in case a user has no replication previlidges.
        Parameters:
        replicationType - replication type
        Returns:
        preconfigured WorkflowModel

      • getWorkflowInstance

        Workflow getWorkflowInstance​(java.lang.String pagePath)
        The Workflow instance is returned.
        Parameters:
        pagePath - page path
        Returns:
        the Workflow instance or null if not existing.

      • getWcmConfigPath

        java.lang.String getWcmConfigPath()
        Specifies the location where the wcm workflow specifx stuff is stored in repository
        Returns:
        path