org.eclipse.uml2.uml
Interface AcceptEventAction

All Superinterfaces:

Action, ActivityContent, ActivityNode, Element, org.eclipse.emf.ecore.EModelElement, org.eclipse.emf.ecore.EObject, ExecutableNode, NamedElement, org.eclipse.emf.common.notify.Notifier, RedefinableElement

All Known Subinterfaces:

AcceptCallAction

public interface AcceptEventAction
extends Action

A representation of the model object 'Accept Event Action'. An AcceptEventAction is an Action that waits for the occurrence of one or more specific Events.

From package UML::Actions.

The following features are supported:

• Is Unmarshall
• Result
• Trigger

See Also:

UMLPackage.getAcceptEventAction()

Field Summary

Fields inherited from interface org.eclipse.uml2.uml.NamedElement

SEPARATOR

Method Summary

OutputPin	createResult(java.lang.String name, Type type) Creates a new OutputPin, with the specified 'Name', and 'Type', and appends it to the 'Result' containment reference list
Trigger	createTrigger(java.lang.String name) Creates a new Trigger, with the specified 'Name', and appends it to the 'Trigger' containment reference list
OutputPin	getResult(java.lang.String name, Type type) Retrieves the first OutputPin with the specified 'Name', and 'Type' from the 'Result' containment reference list
OutputPin	getResult(java.lang.String name, Type type, boolean ignoreCase) Retrieves the first OutputPin with the specified 'Name', and 'Type' from the 'Result' reference list
OutputPin	getResult(java.lang.String name, Type type, boolean ignoreCase, boolean createOnDemand) Retrieves the first OutputPin with the specified 'Name', and 'Type' from the 'Result' containment reference list
org.eclipse.emf.common.util.EList<OutputPin>	getResults() Returns the value of the 'Result' containment reference list.
Trigger	getTrigger(java.lang.String name) Retrieves the first Trigger with the specified 'Name' from the 'Trigger' containment reference list
Trigger	getTrigger(java.lang.String name, boolean ignoreCase, boolean createOnDemand) Retrieves the first Trigger with the specified 'Name' from the 'Trigger' containment reference list
org.eclipse.emf.common.util.EList<Trigger>	getTriggers() Returns the value of the 'Trigger' containment reference list.
boolean	isUnmarshall() Returns the value of the 'Is Unmarshall' attribute.
void	setIsUnmarshall(boolean value) Sets the value of the 'Is Unmarshall' attribute
boolean	validateConformingType(org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context) If isUnmarshall=false and all the triggers are for SignalEvents, then the type of the single result OutputPin must either be null or all the signals must conform to it.
boolean	validateNoInputPins(org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context) AcceptEventActions may have no input pins.
boolean	validateNoOutputPins(org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context) There are no OutputPins if the trigger events are only ChangeEvents and/or CallEvents when this action is an instance of AcceptEventAction and not an instance of a descendant of AcceptEventAction (such as AcceptCallAction).
boolean	validateOneOutputPin(org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context) If isUnmarshall=false and any of the triggers are for SignalEvents or TimeEvents, there must be exactly one result OutputPin with multiplicity 1..1.
boolean	validateUnmarshallSignalEvents(org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context) If isUnmarshall is true (and this is not an AcceptCallAction), there must be exactly one trigger, which is for a SignalEvent.

Methods inherited from interface org.eclipse.uml2.uml.Action

allActions, allOwnedNodes, containingBehavior, createLocalPostcondition, createLocalPostcondition, createLocalPrecondition, createLocalPrecondition, getContext, getInput, getInput, getInputs, getLocalPostcondition, getLocalPostcondition, getLocalPostconditions, getLocalPrecondition, getLocalPrecondition, getLocalPreconditions, getOutput, getOutput, getOutputs, isLocallyReentrant, setIsLocallyReentrant

Methods inherited from interface org.eclipse.uml2.uml.ExecutableNode

createHandler, getHandlers

Methods inherited from interface org.eclipse.uml2.uml.ActivityNode

getActivity, getIncoming, getIncoming, getIncomings, getInGroup, getInGroup, getInGroups, getInInterruptibleRegion, getInInterruptibleRegion, getInInterruptibleRegions, getInPartition, getInPartition, getInPartitions, getInStructuredNode, getOutgoing, getOutgoing, getOutgoings, getRedefinedNode, getRedefinedNode, getRedefinedNodes, setActivity, setInStructuredNode

Methods inherited from interface org.eclipse.uml2.uml.RedefinableElement

getRedefinedElement, getRedefinedElement, getRedefinedElements, getRedefinitionContext, getRedefinitionContext, getRedefinitionContexts, isConsistentWith, isLeaf, isRedefinitionContextValid, setIsLeaf, validateNonLeafRedefinition, validateRedefinitionConsistent, validateRedefinitionContextValid

Methods inherited from interface org.eclipse.uml2.uml.NamedElement

allNamespaces, allOwningPackages, createDependency, createNameExpression, createUsage, getClientDependencies, getClientDependency, getClientDependency, getLabel, getLabel, getName, getNameExpression, getNamespace, getQualifiedName, getVisibility, isDistinguishableFrom, isSetName, isSetVisibility, separator, setName, setNameExpression, setVisibility, unsetName, unsetVisibility, validateHasNoQualifiedName, validateHasQualifiedName, validateVisibilityNeedsOwnership

Methods inherited from interface org.eclipse.uml2.uml.Element

addKeyword, allOwnedElements, applyStereotype, createEAnnotation, createOwnedComment, destroy, getApplicableStereotype, getApplicableStereotypes, getAppliedStereotype, getAppliedStereotypes, getAppliedSubstereotype, getAppliedSubstereotypes, getKeywords, getModel, getNearestPackage, getOwnedComments, getOwnedElements, getOwner, getRelationships, getRelationships, getRequiredStereotype, getRequiredStereotypes, getSourceDirectedRelationships, getSourceDirectedRelationships, getStereotypeApplication, getStereotypeApplications, getTargetDirectedRelationships, getTargetDirectedRelationships, getValue, hasKeyword, hasValue, isStereotypeApplicable, isStereotypeApplied, isStereotypeRequired, mustBeOwned, removeKeyword, setValue, unapplyStereotype, 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, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Methods inherited from interface org.eclipse.uml2.uml.ActivityContent

containingActivity

Method Detail

isUnmarshall

boolean isUnmarshall()

Returns the value of the 'Is Unmarshall' attribute. The default value is "false". Indicates whether there is a single OutputPin for a SignalEvent occurrence, or multiple OutputPins for attribute values of the instance of the Signal associated with a SignalEvent occurrence.

From package UML::Actions.

Returns:

the value of the 'Is Unmarshall' attribute.

See Also:

setIsUnmarshall(boolean), UMLPackage.getAcceptEventAction_IsUnmarshall()

setIsUnmarshall

void setIsUnmarshall(boolean value)

Sets the value of the 'Is Unmarshall' attribute.

Parameters:

value - the new value of the 'Is Unmarshall' attribute.

See Also:

isUnmarshall()

getResults

org.eclipse.emf.common.util.EList<OutputPin> getResults()

Returns the value of the 'Result' containment reference list. The list contents are of type OutputPin.

This feature subsets the following features:

• 'Output'

OutputPins holding the values received from an Event occurrence.

From package UML::Actions.

Returns:

the value of the 'Result' containment reference list.

See Also:

UMLPackage.getAcceptEventAction_Result()

createResult

OutputPin createResult(java.lang.String name,
                       Type type)

Creates a new OutputPin, with the specified 'Name', and 'Type', and appends it to the 'Result' containment reference list.

Parameters:

name - The 'Name' for the new OutputPin, or null.

type - The 'Type' for the new OutputPin, or null.

Returns:

The new OutputPin.

See Also:

getResults()

getResult

OutputPin getResult(java.lang.String name,
                    Type type)

Retrieves the first OutputPin with the specified 'Name', and 'Type' from the 'Result' containment reference list.

Parameters:

name - The 'Name' of the OutputPin to retrieve, or null.

type - The 'Type' of the OutputPin to retrieve, or null.

Returns:

The first OutputPin with the specified 'Name', and 'Type', or null.

See Also:

getResults()

getResult

OutputPin getResult(java.lang.String name,
                    Type type,
                    boolean ignoreCase,
                    boolean createOnDemand)

Retrieves the first OutputPin with the specified 'Name', and 'Type' from the 'Result' containment reference list.

Parameters:

name - The 'Name' of the OutputPin to retrieve, or null.

type - The 'Type' of the OutputPin to retrieve, or null.

ignoreCase - Whether to ignore case in String comparisons.

createOnDemand - Whether to create a OutputPin on demand if not found.

Returns:

The first OutputPin with the specified 'Name', and 'Type', or null.

See Also:

getResults()

getResult

OutputPin getResult(java.lang.String name,
                    Type type,
                    boolean ignoreCase)

Retrieves the first OutputPin with the specified 'Name', and 'Type' from the 'Result' reference list.

Parameters:

name - The 'Name' of the OutputPin to retrieve, or null.

type - The 'Type' of the OutputPin to retrieve, or null.

ignoreCase - Whether to ignore case in String comparisons.

Returns:

The first OutputPin with the specified 'Name', and 'Type', or null.

See Also:

getResults()

getTriggers

org.eclipse.emf.common.util.EList<Trigger> getTriggers()

Returns the value of the 'Trigger' containment reference list. The list contents are of type Trigger.

This feature subsets the following features:

• 'Owned Element'

The Triggers specifying the Events of which the AcceptEventAction waits for occurrences.

From package UML::Actions.

Returns:

the value of the 'Trigger' containment reference list.

See Also:

UMLPackage.getAcceptEventAction_Trigger()

createTrigger

Trigger createTrigger(java.lang.String name)

Creates a new Trigger, with the specified 'Name', and appends it to the 'Trigger' containment reference list.

Parameters:

name - The 'Name' for the new Trigger, or null.

Returns:

The new Trigger.

See Also:

getTriggers()

getTrigger

Trigger getTrigger(java.lang.String name)

Retrieves the first Trigger with the specified 'Name' from the 'Trigger' containment reference list.

Parameters:

name - The 'Name' of the Trigger to retrieve, or null.

Returns:

The first Trigger with the specified 'Name', or null.

See Also:

getTriggers()

getTrigger

Trigger getTrigger(java.lang.String name,
                   boolean ignoreCase,
                   boolean createOnDemand)

Retrieves the first Trigger with the specified 'Name' from the 'Trigger' containment reference list.

Parameters:

name - The 'Name' of the Trigger to retrieve, or null.

ignoreCase - Whether to ignore case in String comparisons.

createOnDemand - Whether to create a Trigger on demand if not found.

Returns:

The first Trigger with the specified 'Name', or null.

See Also:

getTriggers()

validateOneOutputPin

boolean validateOneOutputPin(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
                             java.util.Map<java.lang.Object,java.lang.Object> context)

If isUnmarshall=false and any of the triggers are for SignalEvents or TimeEvents, there must be exactly one result OutputPin with multiplicity 1..1. not isUnmarshall and trigger->exists(event.oclIsKindOf(SignalEvent) or event.oclIsKindOf(TimeEvent)) implies output->size() = 1 and output->first().is(1,1)

Parameters:

diagnostics - The chain of diagnostics to which problems are to be appended.

context - The cache of context-specific information.

validateNoInputPins

boolean validateNoInputPins(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
                            java.util.Map<java.lang.Object,java.lang.Object> context)

AcceptEventActions may have no input pins. input->size() = 0

Parameters:

diagnostics - The chain of diagnostics to which problems are to be appended.

context - The cache of context-specific information.

validateNoOutputPins

boolean validateNoOutputPins(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
                             java.util.Map<java.lang.Object,java.lang.Object> context)

There are no OutputPins if the trigger events are only ChangeEvents and/or CallEvents when this action is an instance of AcceptEventAction and not an instance of a descendant of AcceptEventAction (such as AcceptCallAction). (self.oclIsTypeOf(AcceptEventAction) and (trigger->forAll(event.oclIsKindOf(ChangeEvent) or event.oclIsKindOf(CallEvent)))) implies output->size() = 0

Parameters:

diagnostics - The chain of diagnostics to which problems are to be appended.

context - The cache of context-specific information.

validateUnmarshallSignalEvents

boolean validateUnmarshallSignalEvents(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
                                       java.util.Map<java.lang.Object,java.lang.Object> context)

If isUnmarshall is true (and this is not an AcceptCallAction), there must be exactly one trigger, which is for a SignalEvent. The number of result output pins must be the same as the number of attributes of the signal. The type and ordering of each result output pin must be the same as the corresponding attribute of the signal. The multiplicity of each result output pin must be compatible with the multiplicity of the corresponding attribute. isUnmarshall and self.oclIsTypeOf(AcceptEventAction) implies trigger->size()=1 and trigger->asSequence()->first().event.oclIsKindOf(SignalEvent) and let attribute: OrderedSet(Property) = trigger->asSequence()->first().event.oclAsType(SignalEvent).signal.allAttributes() in attribute->size()>0 and result->size() = attribute->size() and Sequence{1..result->size()}->forAll(i | result->at(i).type = attribute->at(i).type and result->at(i).isOrdered = attribute->at(i).isOrdered and result->at(i).includesMultiplicity(attribute->at(i)))

Parameters:

diagnostics - The chain of diagnostics to which problems are to be appended.

context - The cache of context-specific information.

validateConformingType

boolean validateConformingType(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
                               java.util.Map<java.lang.Object,java.lang.Object> context)

If isUnmarshall=false and all the triggers are for SignalEvents, then the type of the single result OutputPin must either be null or all the signals must conform to it. not isUnmarshall implies result->isEmpty() or let type: Type = result->first().type in type=null or (trigger->forAll(event.oclIsKindOf(SignalEvent)) and trigger.event.oclAsType(SignalEvent).signal->forAll(s | s.conformsTo(type)))

Parameters:

diagnostics - The chain of diagnostics to which problems are to be appended.

context - The cache of context-specific information.