plugins/org.eclipse.uml2.uml/src/org/eclipse/uml2/uml/ProtocolTransition.java - uml2/org.eclipse.uml2 - Git at Google

 /*
  * Copyright (c) 2005, 2015 IBM Corporation, CEA, and others.
  * All rights reserved.   This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v1.0
  * which accompanies this distribution, and is available at
  * http://www.eclipse.org/legal/epl-v10.html
  *
  * Contributors:
  *   IBM - initial API and implementation
  *   Kenn Hussey (CEA) - 327039, 418466, 451350
  *   Christian W. Damus (CEA) - 251963
  *
  */
 package org.eclipse.uml2.uml;

 import java.util.Map;

 import org.eclipse.emf.common.util.DiagnosticChain;

 import org.eclipse.emf.common.util.EList;

 import org.eclipse.emf.ecore.EClass;

 /**
  * <!-- begin-user-doc -->
  * A representation of the model object '<em><b>Protocol Transition</b></em>'.
  * <!-- end-user-doc -->
  *
  * <!-- begin-model-doc -->
  * A ProtocolTransition specifies a legal Transition for an Operation. Transitions of ProtocolStateMachines have the following information: a pre-condition (guard), a Trigger, and a post-condition. Every ProtocolTransition is associated with at most one BehavioralFeature belonging to the context Classifier of the ProtocolStateMachine.
  * <p>From package UML::StateMachines.</p>
  * <!-- end-model-doc -->
  *
  * <p>
  * The following features are supported:
  * </p>
  * <ul>
  *   <li>{@link org.eclipse.uml2.uml.ProtocolTransition#getPostCondition <em>Post Condition</em>}</li>
  *   <li>{@link org.eclipse.uml2.uml.ProtocolTransition#getPreCondition <em>Pre Condition</em>}</li>
  *   <li>{@link org.eclipse.uml2.uml.ProtocolTransition#getReferreds <em>Referred</em>}</li>
  * </ul>
  *
  * @see org.eclipse.uml2.uml.UMLPackage#getProtocolTransition()
  * @model
  * @generated
  */
 public interface ProtocolTransition
 		extends Transition {

 	/**
 	 * Returns the value of the '<em><b>Post Condition</b></em>' reference.
 	 * <p>
 	 * This feature subsets the following features:
 	 * </p>
 	 * <ul>
 	 *   <li>'{@link org.eclipse.uml2.uml.Namespace#getOwnedRules() <em>Owned Rule</em>}'</li>
 	 * </ul>
 	 * <!-- begin-user-doc -->
 	 * <!-- end-user-doc -->
 	 * <!-- begin-model-doc -->
 	 * Specifies the post condition of the Transition which is the Condition that should be obtained once the Transition is triggered. This post condition is part of the post condition of the Operation connected to the Transition.
 	 * <p>From package UML::StateMachines.</p>
 	 * <!-- end-model-doc -->
 	 * @return the value of the '<em>Post Condition</em>' reference.
 	 * @see #setPostCondition(Constraint)
 	 * @see org.eclipse.uml2.uml.UMLPackage#getProtocolTransition_PostCondition()
 	 * @model ordered="false"
 	 * @generated
 	 */
 	Constraint getPostCondition();

 	/**
 	 * Sets the value of the '{@link org.eclipse.uml2.uml.ProtocolTransition#getPostCondition <em>Post Condition</em>}' reference.
 	 * <!-- begin-user-doc -->
 	 * <!-- end-user-doc -->
 	 * @param value the new value of the '<em>Post Condition</em>' reference.
 	 * @see #getPostCondition()
 	 * @generated
 	 */
 	void setPostCondition(Constraint value);

 	/**
 	 * Creates a new {@link org.eclipse.uml2.uml.Constraint}, with the specified '<em><b>Name</b></em>', and sets the '<em><b>Post Condition</b></em>' reference.
 	 * <!-- begin-user-doc -->
 	 * <!-- end-user-doc -->
 	 * @param name The '<em><b>Name</b></em>' for the new {@link org.eclipse.uml2.uml.Constraint}, or <code>null</code>.
 	 * @param eClass The Ecore class of the {@link org.eclipse.uml2.uml.Constraint} to create.
 	 * @return The new {@link org.eclipse.uml2.uml.Constraint}.
 	 * @see #getPostCondition()
 	 * @generated
 	 */
 	Constraint createPostCondition(String name, EClass eClass);

 	/**
 	 * Creates a new {@link org.eclipse.uml2.uml.Constraint},with the specified '<em><b>Name</b></em>', and sets the '<em><b>Post Condition</b></em>' reference.
 	 * <!-- begin-user-doc -->
 	 * <!-- end-user-doc -->
 	 * @param name The '<em><b>Name</b></em>' for the new {@link org.eclipse.uml2.uml.Constraint}, or <code>null</code>.
 	 * @return The new {@link org.eclipse.uml2.uml.Constraint}.
 	 * @see #getPostCondition()
 	 * @generated
 	 */
 	Constraint createPostCondition(String name);

 	/**
 	 * Returns the value of the '<em><b>Referred</b></em>' reference list.
 	 * The list contents are of type {@link org.eclipse.uml2.uml.Operation}.
 	 * <!-- begin-user-doc -->
 	 * <!-- end-user-doc -->
 	 * <!-- begin-model-doc -->
 	 * This association refers to the associated Operation. It is derived from the Operation of the CallEvent Trigger when applicable.
 	 * <p>From package UML::StateMachines.</p>
 	 * <!-- end-model-doc -->
 	 * @return the value of the '<em>Referred</em>' reference list.
 	 * @see org.eclipse.uml2.uml.UMLPackage#getProtocolTransition_Referred()
 	 * @model transient="true" changeable="false" volatile="true" derived="true" ordered="false"
 	 * @generated
 	 */
 	EList<Operation> getReferreds();

 	/**
 	 * Retrieves the first {@link org.eclipse.uml2.uml.Operation} with the specified '<em><b>Name</b></em>', '<em><b>Owned Parameter Names</b></em>', and '<em><b>Owned Parameter Types</b></em>' from the '<em><b>Referred</b></em>' reference list.
 	 * <!-- begin-user-doc -->
 	 * <!-- end-user-doc -->
 	 * @param name The '<em><b>Name</b></em>' of the {@link org.eclipse.uml2.uml.Operation} to retrieve, or <code>null</code>.
 	 * @param ownedParameterNames The '<em><b>Owned Parameter Names</b></em>' of the {@link org.eclipse.uml2.uml.Operation} to retrieve, or <code>null</code>.
 	 * @param ownedParameterTypes The '<em><b>Owned Parameter Types</b></em>' of the {@link org.eclipse.uml2.uml.Operation} to retrieve, or <code>null</code>.
 	 * @return The first {@link org.eclipse.uml2.uml.Operation} with the specified '<em><b>Name</b></em>', '<em><b>Owned Parameter Names</b></em>', and '<em><b>Owned Parameter Types</b></em>', or <code>null</code>.
 	 * @see #getReferreds()
 	 * @generated
 	 */
 	Operation getReferred(String name, EList<String> ownedParameterNames,
 			EList<Type> ownedParameterTypes);

 	/**
 	 * Retrieves the first {@link org.eclipse.uml2.uml.Operation} with the specified '<em><b>Name</b></em>', '<em><b>Owned Parameter Names</b></em>', and '<em><b>Owned Parameter Types</b></em>' from the '<em><b>Referred</b></em>' reference list.
 	 * <!-- begin-user-doc -->
 	 * <!-- end-user-doc -->
 	 * @param name The '<em><b>Name</b></em>' of the {@link org.eclipse.uml2.uml.Operation} to retrieve, or <code>null</code>.
 	 * @param ownedParameterNames The '<em><b>Owned Parameter Names</b></em>' of the {@link org.eclipse.uml2.uml.Operation} to retrieve, or <code>null</code>.
 	 * @param ownedParameterTypes The '<em><b>Owned Parameter Types</b></em>' of the {@link org.eclipse.uml2.uml.Operation} to retrieve, or <code>null</code>.
 	 * @param ignoreCase Whether to ignore case in {@link java.lang.String} comparisons.
 	 * @return The first {@link org.eclipse.uml2.uml.Operation} with the specified '<em><b>Name</b></em>', '<em><b>Owned Parameter Names</b></em>', and '<em><b>Owned Parameter Types</b></em>', or <code>null</code>.
 	 * @see #getReferreds()
 	 * @generated
 	 */
 	Operation getReferred(String name, EList<String> ownedParameterNames,
 			EList<Type> ownedParameterTypes, boolean ignoreCase);

 	/**
 	 * Returns the value of the '<em><b>Pre Condition</b></em>' reference.
 	 * <p>
 	 * This feature subsets the following features:
 	 * </p>
 	 * <ul>
 	 *   <li>'{@link org.eclipse.uml2.uml.Transition#getGuard() <em>Guard</em>}'</li>
 	 * </ul>
 	 * <!-- begin-user-doc -->
 	 * <!-- end-user-doc -->
 	 * <!-- begin-model-doc -->
 	 * Specifies the precondition of the Transition. It specifies the Condition that should be verified before triggering the Transition. This guard condition added to the source State will be evaluated as part of the precondition of the Operation referred by the Transition if any.
 	 * <p>From package UML::StateMachines.</p>
 	 * <!-- end-model-doc -->
 	 * @return the value of the '<em>Pre Condition</em>' reference.
 	 * @see #setPreCondition(Constraint)
 	 * @see org.eclipse.uml2.uml.UMLPackage#getProtocolTransition_PreCondition()
 	 * @model ordered="false"
 	 * @generated
 	 */
 	Constraint getPreCondition();

 	/**
 	 * Sets the value of the '{@link org.eclipse.uml2.uml.ProtocolTransition#getPreCondition <em>Pre Condition</em>}' reference.
 	 * <!-- begin-user-doc -->
 	 * <!-- end-user-doc -->
 	 * @param value the new value of the '<em>Pre Condition</em>' reference.
 	 * @see #getPreCondition()
 	 * @generated
 	 */
 	void setPreCondition(Constraint value);

 	/**
 	 * <!-- begin-user-doc -->
 	 * <!-- end-user-doc -->
 	 * <!-- begin-model-doc -->
 	 * A ProtocolTransition always belongs to a ProtocolStateMachine.
 	 * container.belongsToPSM()
 	 * @param diagnostics The chain of diagnostics to which problems are to be appended.
 	 * @param context The cache of context-specific information.
 	 * <!-- end-model-doc -->
 	 * @model
 	 * @generated
 	 */
 	boolean validateBelongsToPsm(DiagnosticChain diagnostics,
 			Map<Object, Object> context);

 	/**
 	 * <!-- begin-user-doc -->
 	 * <!-- end-user-doc -->
 	 * <!-- begin-model-doc -->
 	 * A ProtocolTransition never has associated Behaviors.
 	 * effect = null
 	 * @param diagnostics The chain of diagnostics to which problems are to be appended.
 	 * @param context The cache of context-specific information.
 	 * <!-- end-model-doc -->
 	 * @model
 	 * @generated
 	 */
 	boolean validateAssociatedActions(DiagnosticChain diagnostics,
 			Map<Object, Object> context);

 	/**
 	 * <!-- begin-user-doc -->
 	 * <!-- end-user-doc -->
 	 * <!-- begin-model-doc -->
 	 * If a ProtocolTransition refers to an Operation (i.e., has a CallEvent trigger corresponding to an Operation), then that Operation should apply to the context Classifier of the StateMachine of the ProtocolTransition.
 	 * if (referred()->notEmpty() and containingStateMachine()._'context'->notEmpty()) then
 	 *     containingStateMachine()._'context'.oclAsType(BehavioredClassifier).allFeatures()->includesAll(referred())
 	 * else true endif
 	 * @param diagnostics The chain of diagnostics to which problems are to be appended.
 	 * @param context The cache of context-specific information.
 	 * <!-- end-model-doc -->
 	 * @model
 	 * @generated
 	 */
 	boolean validateRefersToOperation(DiagnosticChain diagnostics,
 			Map<Object, Object> context);

 } // ProtocolTransition
	/*
	* Copyright (c) 2005, 2015 IBM Corporation, CEA, and others.
	* All rights reserved. This program and the accompanying materials
	* are made available under the terms of the Eclipse Public License v1.0
	* which accompanies this distribution, and is available at
	* http://www.eclipse.org/legal/epl-v10.html
	*
	* Contributors:
	* IBM - initial API and implementation
	* Kenn Hussey (CEA) - 327039, 418466, 451350
	* Christian W. Damus (CEA) - 251963
	*
	*/
	package org.eclipse.uml2.uml;

	import java.util.Map;

	import org.eclipse.emf.common.util.DiagnosticChain;

	import org.eclipse.emf.common.util.EList;

	import org.eclipse.emf.ecore.EClass;

	/**
	* <!-- begin-user-doc -->
	* A representation of the model object '<em><b>Protocol Transition</b></em>'.
	* <!-- end-user-doc -->
	*
	* <!-- begin-model-doc -->
	* A ProtocolTransition specifies a legal Transition for an Operation. Transitions of ProtocolStateMachines have the following information: a pre-condition (guard), a Trigger, and a post-condition. Every ProtocolTransition is associated with at most one BehavioralFeature belonging to the context Classifier of the ProtocolStateMachine.
	* <p>From package UML::StateMachines.</p>
	* <!-- end-model-doc -->
	*
	* <p>
	* The following features are supported:
	* </p>
	* <ul>
	* <li>{@link org.eclipse.uml2.uml.ProtocolTransition#getPostCondition <em>Post Condition</em>}</li>
	* <li>{@link org.eclipse.uml2.uml.ProtocolTransition#getPreCondition <em>Pre Condition</em>}</li>
	* <li>{@link org.eclipse.uml2.uml.ProtocolTransition#getReferreds <em>Referred</em>}</li>
	* </ul>
	*
	* @see org.eclipse.uml2.uml.UMLPackage#getProtocolTransition()
	* @model
	* @generated
	*/
	public interface ProtocolTransition
	extends Transition {

	/**
	* Returns the value of the '<em><b>Post Condition</b></em>' reference.
	* <p>
	* This feature subsets the following features:
	* </p>
	* <ul>
	* <li>'{@link org.eclipse.uml2.uml.Namespace#getOwnedRules() <em>Owned Rule</em>}'</li>
	* </ul>
	* <!-- begin-user-doc -->
	* <!-- end-user-doc -->
	* <!-- begin-model-doc -->
	* Specifies the post condition of the Transition which is the Condition that should be obtained once the Transition is triggered. This post condition is part of the post condition of the Operation connected to the Transition.
	* <p>From package UML::StateMachines.</p>
	* <!-- end-model-doc -->
	* @return the value of the '<em>Post Condition</em>' reference.
	* @see #setPostCondition(Constraint)
	* @see org.eclipse.uml2.uml.UMLPackage#getProtocolTransition_PostCondition()
	* @model ordered="false"
	* @generated
	*/
	Constraint getPostCondition();

	/**
	* Sets the value of the '{@link org.eclipse.uml2.uml.ProtocolTransition#getPostCondition <em>Post Condition</em>}' reference.
	* <!-- begin-user-doc -->
	* <!-- end-user-doc -->
	* @param value the new value of the '<em>Post Condition</em>' reference.
	* @see #getPostCondition()
	* @generated
	*/
	void setPostCondition(Constraint value);

	/**
	* Creates a new {@link org.eclipse.uml2.uml.Constraint}, with the specified '<em><b>Name</b></em>', and sets the '<em><b>Post Condition</b></em>' reference.
	* <!-- begin-user-doc -->
	* <!-- end-user-doc -->
	* @param name The '<em><b>Name</b></em>' for the new {@link org.eclipse.uml2.uml.Constraint}, or <code>null</code>.
	* @param eClass The Ecore class of the {@link org.eclipse.uml2.uml.Constraint} to create.
	* @return The new {@link org.eclipse.uml2.uml.Constraint}.
	* @see #getPostCondition()
	* @generated
	*/
	Constraint createPostCondition(String name, EClass eClass);

	/**
	* Creates a new {@link org.eclipse.uml2.uml.Constraint},with the specified '<em><b>Name</b></em>', and sets the '<em><b>Post Condition</b></em>' reference.
	* <!-- begin-user-doc -->
	* <!-- end-user-doc -->
	* @param name The '<em><b>Name</b></em>' for the new {@link org.eclipse.uml2.uml.Constraint}, or <code>null</code>.
	* @return The new {@link org.eclipse.uml2.uml.Constraint}.
	* @see #getPostCondition()
	* @generated
	*/
	Constraint createPostCondition(String name);

	/**
	* Returns the value of the '<em><b>Referred</b></em>' reference list.
	* The list contents are of type {@link org.eclipse.uml2.uml.Operation}.
	* <!-- begin-user-doc -->
	* <!-- end-user-doc -->
	* <!-- begin-model-doc -->
	* This association refers to the associated Operation. It is derived from the Operation of the CallEvent Trigger when applicable.
	* <p>From package UML::StateMachines.</p>
	* <!-- end-model-doc -->
	* @return the value of the '<em>Referred</em>' reference list.
	* @see org.eclipse.uml2.uml.UMLPackage#getProtocolTransition_Referred()
	* @model transient="true" changeable="false" volatile="true" derived="true" ordered="false"
	* @generated
	*/
	EList<Operation> getReferreds();

	/**
	* Retrieves the first {@link org.eclipse.uml2.uml.Operation} with the specified '<em><b>Name</b></em>', '<em><b>Owned Parameter Names</b></em>', and '<em><b>Owned Parameter Types</b></em>' from the '<em><b>Referred</b></em>' reference list.
	* <!-- begin-user-doc -->
	* <!-- end-user-doc -->
	* @param name The '<em><b>Name</b></em>' of the {@link org.eclipse.uml2.uml.Operation} to retrieve, or <code>null</code>.
	* @param ownedParameterNames The '<em><b>Owned Parameter Names</b></em>' of the {@link org.eclipse.uml2.uml.Operation} to retrieve, or <code>null</code>.
	* @param ownedParameterTypes The '<em><b>Owned Parameter Types</b></em>' of the {@link org.eclipse.uml2.uml.Operation} to retrieve, or <code>null</code>.
	* @return The first {@link org.eclipse.uml2.uml.Operation} with the specified '<em><b>Name</b></em>', '<em><b>Owned Parameter Names</b></em>', and '<em><b>Owned Parameter Types</b></em>', or <code>null</code>.
	* @see #getReferreds()
	* @generated
	*/
	Operation getReferred(String name, EList<String> ownedParameterNames,
	EList<Type> ownedParameterTypes);

	/**
	* Retrieves the first {@link org.eclipse.uml2.uml.Operation} with the specified '<em><b>Name</b></em>', '<em><b>Owned Parameter Names</b></em>', and '<em><b>Owned Parameter Types</b></em>' from the '<em><b>Referred</b></em>' reference list.
	* <!-- begin-user-doc -->
	* <!-- end-user-doc -->
	* @param name The '<em><b>Name</b></em>' of the {@link org.eclipse.uml2.uml.Operation} to retrieve, or <code>null</code>.
	* @param ownedParameterNames The '<em><b>Owned Parameter Names</b></em>' of the {@link org.eclipse.uml2.uml.Operation} to retrieve, or <code>null</code>.
	* @param ownedParameterTypes The '<em><b>Owned Parameter Types</b></em>' of the {@link org.eclipse.uml2.uml.Operation} to retrieve, or <code>null</code>.
	* @param ignoreCase Whether to ignore case in {@link java.lang.String} comparisons.
	* @return The first {@link org.eclipse.uml2.uml.Operation} with the specified '<em><b>Name</b></em>', '<em><b>Owned Parameter Names</b></em>', and '<em><b>Owned Parameter Types</b></em>', or <code>null</code>.
	* @see #getReferreds()
	* @generated
	*/
	Operation getReferred(String name, EList<String> ownedParameterNames,
	EList<Type> ownedParameterTypes, boolean ignoreCase);

	/**
	* Returns the value of the '<em><b>Pre Condition</b></em>' reference.
	* <p>
	* This feature subsets the following features:
	* </p>
	* <ul>
	* <li>'{@link org.eclipse.uml2.uml.Transition#getGuard() <em>Guard</em>}'</li>
	* </ul>
	* <!-- begin-user-doc -->
	* <!-- end-user-doc -->
	* <!-- begin-model-doc -->
	* Specifies the precondition of the Transition. It specifies the Condition that should be verified before triggering the Transition. This guard condition added to the source State will be evaluated as part of the precondition of the Operation referred by the Transition if any.
	* <p>From package UML::StateMachines.</p>
	* <!-- end-model-doc -->
	* @return the value of the '<em>Pre Condition</em>' reference.
	* @see #setPreCondition(Constraint)
	* @see org.eclipse.uml2.uml.UMLPackage#getProtocolTransition_PreCondition()
	* @model ordered="false"
	* @generated
	*/
	Constraint getPreCondition();

	/**
	* Sets the value of the '{@link org.eclipse.uml2.uml.ProtocolTransition#getPreCondition <em>Pre Condition</em>}' reference.
	* <!-- begin-user-doc -->
	* <!-- end-user-doc -->
	* @param value the new value of the '<em>Pre Condition</em>' reference.
	* @see #getPreCondition()
	* @generated
	*/
	void setPreCondition(Constraint value);

	/**
	* <!-- begin-user-doc -->
	* <!-- end-user-doc -->
	* <!-- begin-model-doc -->
	* A ProtocolTransition always belongs to a ProtocolStateMachine.
	* container.belongsToPSM()
	* @param diagnostics The chain of diagnostics to which problems are to be appended.
	* @param context The cache of context-specific information.
	* <!-- end-model-doc -->
	* @model
	* @generated
	*/
	boolean validateBelongsToPsm(DiagnosticChain diagnostics,
	Map<Object, Object> context);

	/**
	* <!-- begin-user-doc -->
	* <!-- end-user-doc -->
	* <!-- begin-model-doc -->
	* A ProtocolTransition never has associated Behaviors.
	* effect = null
	* @param diagnostics The chain of diagnostics to which problems are to be appended.
	* @param context The cache of context-specific information.
	* <!-- end-model-doc -->
	* @model
	* @generated
	*/
	boolean validateAssociatedActions(DiagnosticChain diagnostics,
	Map<Object, Object> context);

	/**
	* <!-- begin-user-doc -->
	* <!-- end-user-doc -->
	* <!-- begin-model-doc -->
	* If a ProtocolTransition refers to an Operation (i.e., has a CallEvent trigger corresponding to an Operation), then that Operation should apply to the context Classifier of the StateMachine of the ProtocolTransition.
	* if (referred()->notEmpty() and containingStateMachine()._'context'->notEmpty()) then
	* containingStateMachine()._'context'.oclAsType(BehavioredClassifier).allFeatures()->includesAll(referred())
	* else true endif
	* @param diagnostics The chain of diagnostics to which problems are to be appended.
	* @param context The cache of context-specific information.
	* <!-- end-model-doc -->
	* @model
	* @generated
	*/
	boolean validateRefersToOperation(DiagnosticChain diagnostics,
	Map<Object, Object> context);

	} // ProtocolTransition