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

import com.day.cq.workflow.WorkflowException;
import com.day.cq.workflow.WorkflowSession;
import com.day.cq.workflow.metadata.MetaDataMap;
import com.day.cq.workflow.model.WorkflowNode;

/**
 * JavaProcessNew is the interface to be used for automatic
 * workflow steps implemented in Java. Classes implementing this interface
 * define Java based processes that can be attached to a {@link WorkflowNode}
 * and executed by the workflow engine.
 * 
 * This interface replaces the deprecated {@link JavaProcess} and
 * {@link JavaProcessExt} interfaces.
 * 
 * @see JavaProcess
 * @see JavaProcessExt
 * @sinc 5.4
 */
public interface WorkflowProcess {
    /**
     * Executes a new Java process with the given {@link WorkItem}
     * and {@link com.day.cq.workflow.WorkflowSession}.
     * 
     * @param item
     *            The {@link WorkItem} that defines the newly
     *            started JavaProcessNew.
     * @param session
     *            The {@link com.day.cq.workflow.WorkflowSession}
     *            that is used for starting the JavaProcess.
     * @param args
     *            Process specific arguments can be passed here
     * @throws WorkflowException
     *             Thrown in case something goes wrong during execution.
     */
    void execute(WorkItem item, WorkflowSession session, MetaDataMap args) throws WorkflowException;
}