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 Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EVENT_TOPIC Request for de/activation event topic

Method Summary

Modifier and Type	Method and Description
WorkflowModel	getRequestForReplicationWorkflowModel(ReplicationActionType replicationType) Returns the preconfigured com.day.cq.workflow.model.WorkflowModel for the desired ReplicationActionType.
java.lang.String	getWcmConfigPath() Specifies the location where the wcm workflow specifx stuff is stored in repository
Workflow	getWorkflowInstance(java.lang.String pagePath) The com.day.cq.workflow.exec.Workflow instance is returned.
boolean	isInWorkflow(java.lang.String pagePath) Checks wether a Page is subject of a running com.day.cq.workflow.exec.Workflow instance.

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 com.day.cq.workflow.exec.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 com.day.cq.workflow.model.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 com.day.cq.workflow.exec.Workflow instance is returned.

Parameters:

pagePath - page path

Returns:

the com.day.cq.workflow.exec.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