org.eclipse.uml2
Interface ProtocolTransition

All Superinterfaces:
Element, EModelElement, EObject, NamedElement, Notifier, RedefinableElement, TemplateableElement, Transition

public interface ProtocolTransition
extends Transition

A representation of the model object 'Protocol Transition'. A protocol transition (transition as specialized in the ProtocolStateMachines package) specifies a legal transition for an operation. Transitions of protocol state machines have the following information: a pre condition (guard), on trigger, and a post condition. Every protocol transition is associated to zero or one operation (referred BehavioralFeature) that belongs to the context classifier of the protocol state machine. The protocol transition specifies that the associated (referred) operation can be called for an instance in the origin state under the initial condition (guard), and that at the end of the transition, the destination state will be reached under the final condition (post).

The following features are supported:

See Also:
UML2Package.getProtocolTransition()

Field Summary
static String copyright
           
 
Fields inherited from interface org.eclipse.uml2.NamedElement
SEPARATOR
 
Method Summary
 Constraint createPostCondition(EClass eClass)
          Creates a Constraint and sets the 'Post Condition' containment reference
 EList getOwnedElements()
           
 Constraint getPostCondition()
          Returns the value of the 'Post Condition' containment reference
 Constraint getPreCondition()
          Returns the value of the 'Pre Condition' reference
 Operation getReferred(String unqualifiedName)
          Retrieves the Operation with the specified name from the 'Referred' reference list
 EList getReferreds()
          Returns the value of the 'Referred' reference list.
 void setGuard(Constraint value)
           
 void setPostCondition(Constraint value)
          Sets the value of the 'Post Condition' containment reference
 void setPreCondition(Constraint value)
          Sets the value of the 'Pre Condition' reference
 
Methods inherited from interface org.eclipse.uml2.Transition
createEffect, createGuard, getContainer, getEffect, getGuard, getKind, getOwner, getRedefinedElements, getRedefinedTransition, getRedefinitionContexts, getSource, getTarget, getTrigger, getTriggers, setContainer, setEffect, setKind, setRedefinedTransition, setSource, setTarget
 
Methods inherited from interface org.eclipse.uml2.RedefinableElement
getRedefinitionContext, isConsistentWith, isLeaf, isRedefinitionContextValid, setIsLeaf, validateRedefinitionConsistent, validateRedefinitionContextValid
 
Methods inherited from interface org.eclipse.uml2.NamedElement
allNamespaces, createNameExpression, getClientDependencies, getClientDependency, getName, getNameExpression, getNamespace, getQualifiedName, getVisibility, isDistinguishableFrom, qualifiedName, separator, setName, setNameExpression, setVisibility, validateNoName, validateQualifiedName, validateVisibilityNeedsOwnership
 
Methods inherited from interface org.eclipse.uml2.TemplateableElement
createOwnedTemplateSignature, createTemplateBinding, getOwnedTemplateSignature, getTemplateBindings, parameterableElements, setOwnedTemplateSignature
 
Methods inherited from interface org.eclipse.uml2.Element
addKeyword, allOwnedElements, apply, createEAnnotation, createOwnedComment, destroy, getApplicableStereotype, getApplicableStereotypes, getAppliedStereotype, getAppliedStereotypes, getAppliedVersion, getKeywords, getModel, getNearestPackage, getOwnedComments, getValue, hasKeyword, isApplied, isRequired, mustBeOwned, removeKeyword, setValue, unapply, validateHasOwner, validateNotOwnSelf
 
Methods inherited from interface org.eclipse.emf.ecore.EModelElement
getEAnnotation, getEAnnotations
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 

Field Detail

copyright

public static final String copyright

See Also:
Constant Field Values
Method Detail

getPostCondition

public Constraint getPostCondition()
Returns the value of the 'Post Condition' containment reference.

If the meaning of the 'Post Condition' containment reference isn't clear, there really should be more of a description here...

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.

Returns:
the value of the 'Post Condition' containment reference.
See Also:
setPostCondition(Constraint), UML2Package.getProtocolTransition_PostCondition()

setPostCondition

public void setPostCondition(Constraint value)
Sets the value of the 'Post Condition' containment reference.

Parameters:
value - the new value of the 'Post Condition' containment reference.
See Also:
getPostCondition()

createPostCondition

public Constraint createPostCondition(EClass eClass)
Creates a Constraint and sets the 'Post Condition' containment reference.

Parameters:
eClass - The Ecore class of the Constraint to create.
Returns:
The new Constraint.
See Also:
getPostCondition()

getReferreds

public EList getReferreds()
Returns the value of the 'Referred' reference list. The list contents are of type Operation.

If the meaning of the 'Referred' reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Referred' reference list.
See Also:
UML2Package.getProtocolTransition_Referred()

getReferred

public Operation getReferred(String unqualifiedName)
Retrieves the Operation with the specified name from the 'Referred' reference list.

Parameters:
unqualifiedName - The unqualified name of the Operation to retrieve.
Returns:
The Operation with the specified name, or null.
See Also:
getReferreds()

getPreCondition

public Constraint getPreCondition()
Returns the value of the 'Pre Condition' reference.

If the meaning of the 'Pre Condition' reference isn't clear, there really should be more of a description here...

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 refered by the transition if any.

Returns:
the value of the 'Pre Condition' reference.
See Also:
setPreCondition(Constraint), UML2Package.getProtocolTransition_PreCondition()

setPreCondition

public void setPreCondition(Constraint value)
Sets the value of the 'Pre Condition' reference.

Parameters:
value - the new value of the 'Pre Condition' reference.
See Also:
getPreCondition()

getOwnedElements

public EList getOwnedElements()

Specified by:
getOwnedElements in interface Transition

setGuard

public void setGuard(Constraint value)

Specified by:
setGuard in interface Transition
Parameters:
value - the new value of the 'Guard' containment reference.
See Also:
Transition.getGuard()

Copyright 2003, 2004 IBM Corporation and others.
All Rights Reserved.