com.day.cq.wcm.workflow.api.WcmWorkflowService Maven / Gradle / Ivy
/*
* Copyright 1997-2008 Day Management AG
* Barfuesserplatz 6, 4001 Basel, Switzerland
* All Rights Reserved.
*
* This software is the confidential and proprietary information of
* Day Management AG, ("Confidential Information"). You shall not
* disclose such Confidential Information and shall use it only in
* accordance with the terms of the license agreement you entered into
* with Day.
*/
package com.day.cq.wcm.workflow.api;
import com.day.cq.replication.ReplicationActionType;
import com.day.cq.wcm.api.Page;
import com.day.cq.workflow.model.WorkflowModel;
import com.day.cq.workflow.exec.Workflow;
/**
* The WcmWorkflowService interface defines (util) methods that are
* used in the WCM system in cunjunction with the workflow engine.
*/
public interface WcmWorkflowService {
/**
* Request for de/activation event topic
*/
public static final String EVENT_TOPIC = "com/day/cq/wcm/workflow/req/for/activation";
/**
* Checks wether a {@link Page} is subject of a running
* {@link com.day.cq.workflow.exec.Workflow} instance.
*
* @param pagePath path of {@link Page} to check
* @return true if {@link Page} is subject of a
* running workflow
*/
boolean isInWorkflow(String pagePath);
/**
* Returns the preconfigured {@link com.day.cq.workflow.model.WorkflowModel}
* for the desired {@link ReplicationActionType}. This is used
* in case a user has no replication previlidges.
*
* @param replicationType replication type
* @return preconfigured WorkflowModel
*/
WorkflowModel getRequestForReplicationWorkflowModel(
ReplicationActionType replicationType);
/**
* The {@link com.day.cq.workflow.exec.Workflow} instance is
* returned.
*
* @param pagePath page path
* @return the {@link com.day.cq.workflow.exec.Workflow} instance
* or null if not existing.
*/
Workflow getWorkflowInstance(String pagePath);
/**
* Specifies the location where the wcm workflow specifx stuff is stored in
* repository
* @return path
*/
String getWcmConfigPath();
}