com.day.cq.workflow.model.WorkflowTransition 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.model;

import com.day.cq.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);
}