com.adobe.granite.workflow.model.WorkflowTransition Maven / Gradle / Ivy

/*************************************************************************
 *
 * ADOBE CONFIDENTIAL
 * __________________
 *
 *  Copyright 2012 Adobe Systems Incorporated
 *  All Rights Reserved.
 *
 * NOTICE:  All information contained herein is, and remains
 * the property of Adobe Systems Incorporated and its suppliers,
 * if any.  The intellectual and technical concepts contained
 * herein are proprietary to Adobe Systems Incorporated and its
 * suppliers and are protected by trade secret or copyright law.
 * Dissemination of this information or reproduction of this material
 * is strictly forbidden unless prior written permission is obtained
 * from Adobe Systems Incorporated.
 **************************************************************************/
package com.adobe.granite.workflow.model;

import com.adobe.granite.workflow.HasMetaData;

/**
 * WorkflowTransition represents a transition between two
 * {@link WorkflowNode}s of a {@link WorkflowModel}.
 */
public interface WorkflowTransition extends HasMetaData {
	/**
	 * Returns the {@link WorkflowNode} that is the source of
	 * this WorkflowTransition.
	 * 
	 * @return The {@link WorkflowNode} that is the source of
	 *         this WorkflowTransition.
	 */
	WorkflowNode getFrom();

	/**
	 * Sets the {@link WorkflowNode} that is the source of this
	 * WorkflowTransition.
	 * 
	 * @param from
	 *            The {@link WorkflowNode} that is the source of
	 *            this WorkflowTransition.
	 */
	void setFrom(WorkflowNode from);

	/**
	 * Returns the {@link WorkflowNode} that is the target of
	 * this WorkflowTransition.
	 * 
	 * @return The {@link WorkflowNode} that is the target of
	 *         this WorkflowTransition.
	 */
	WorkflowNode getTo();

	/**
	 * Sets the {@link WorkflowNode} that is the target of this
	 * WorkflowTransition.
	 * 
	 * @param to
	 *            The {@link WorkflowNode} that is the target of
	 *            this WorkflowTransition.
	 */
	void setTo(WorkflowNode to);

	/**
	 * Returns the rule that defines if this WorkflowTransition
	 * can be followed or not.
	 * 
	 * @return The execution rule of the WorkflowTransition.
	 */
	String getRule();

	/**
	 * Sets the rules that defines if this WorkflowTransition can
	 * be followed or not.
	 * 
	 * @param rule
	 *            The execution rule of the WorkflowTransition.
	 */
	void setRule(String rule);
}