Package de.mid.innovator.srv2api.icw2ac

Interface ANAcceptEvent

All Superinterfaces:

ACActivityNode, ACExecutableNode, ADClientAble, ADFindAble, ADHistoryAble, ADM2AttrModifyAble, ANAction, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELNamedElement, ELNamespaceAble, ELNamespaceAsgnAble, ELObject, ELRedefAble, ELUUIDAble, ELValueContainerAble, MECommentAble, MEConstraintAble, MEModelElement, MENamedElement, MENamespaceAsgnAble, MEStereotypeAble, METermAble, MMAttachmentAble, MMCommentContainerAble, MMLabelAble, MMLabelTextAttachmentAble, MMStereotypeAble, MMTextAble

All Known Subinterfaces:

ANAcceptCall

public interface ANAcceptEvent
extends ANAction

AcceptEventAction is an action that waits for the occurrence of an event meeting specified condition.

See Also:

• ANAcceptEventHelper

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	ANAcceptEvent.VAttr

Method Summary

Modifier and Type	Method	Description
<T extends BEEvent> List<T>	getAcceptedEvents(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	All events specified by the triggers which are accepted by the action.
<T extends BEEvent> List<T>	getAcceptedEvents(Class<T> returnType, MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)	The method calls getAcceptedEvents and filters its return values according to the given stereotype value.
List<BETrigger>	getAcceptedTrigger()	All triggers which are accepted by the action.
List<BETrigger>	getAcceptedTrigger(MMStereotype stereotype)	The method calls getAcceptedTrigger and filters its return values according to the given stereotype value.
<T extends METriggerReferenceAble> List<T>	getEventAsTrigger(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	All events, signals and operations which may serve as triggers of the action.
<T extends METriggerReferenceAble> List<T>	getEventAsTrigger(Class<T> returnType, MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)	The method calls getEventAsTrigger and filters its return values according to the given stereotype value.
List<ANOutputPin>	getResult(K_CONTROL_OPTION... behaviourFlags)	Pins that hold the received event objects or their attributes.
<T extends ANAction> List<T>	getSentBy(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	Returns all ANSendSignal/ANBroadcastSignal/ANSendObject actions that send signals accepted by this ANAcceptEvent.
<T extends ANAction> List<T>	getSentBy(Class<T> returnType, MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)	The method calls getSentBy and filters its return values according to the given stereotype value.
List<BETrigger>	getTrigger(K_CONTROL_OPTION... behaviourFlags)	The type of events accepted by the action, as specified by triggers.
boolean	isUnmarshall()	Indicates whether there is a single output pin for the event or multiple output pins for attributes of the event.
void	maintain()	The list of result output pins of the ANAcceptEvent is maintained with reference to its triggers.
void	setEventAsTrigger(List<? extends METriggerReferenceAble> values)	Set the value of View EventAsTrigger.
void	setUnmarshall(boolean value)	Set the value of Attribut IsUnmarshall.

Methods inherited from interface de.mid.innovator.srv2api.icw2ac.ACActivityNode

getActivity, getIncoming, getInGroup, getInGroup, getInGroupExplicit, getInGroupImplicit, getNodeCoord, getOutgoing, isInInterruptibleRegion, replaceInGroupExplicit, setInGroupExplicit, setInGroupImplicit, setNodeCoord

Methods inherited from interface de.mid.innovator.srv2api.icw2ac.ACExecutableNode

getExceptionHandler, getExceptionInput, getHandler, getHandlerBody, getHandlerBody, getProtectedNode

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADClientAble

getAnnotation, getEndAnalysisDia, getLogic, getLogic, getPresentationContext, getSection, getStartAnalysisDia

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADHistoryAble

getCreateTime, getCreator, getHistory, getModifier, getModifyTime, modifyHistory, setHistory

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADM2AttrModifyAble

getTabCell, getTabCellObjectList, getTabCreateTemplate, getTabCreateTemplateObjectList, getTabElement, getTabElementRelshipTypeList, getTabElementRowList, getTabElementRowTypeList, getTabRelshipList, getTabRowList, tabCellModify, tabCreateTemplate, tabElementModify

Methods inherited from interface de.mid.innovator.srv2api.icw2ac.ANAction

getControlPin, getControlPin, getExecution, getInput, getInteraction, getLocalPostcondition, getLocalPrecondition, getObjectPin, getObjectPin, getOutput, getOwnerPin, isMaintainAble

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELContainerAble

getClientDependency, getOwnedElement, getOwnedElementTransitiveDown, getOwnedElementTransitiveDown, getOwnedElementTransitiveDownAndUnresolved, getOwnedElementTransitiveDownAndUnresolved, getOwnedOrReferencedElementTransitiveDown, getOwnedOrReferencedElementTransitiveDown, getOwnedRelshipBinDirWithTarget, getOwnedRelshipBinDirWithTarget, getRedirectedModelContainer, getRelshipBinDirSource, getSelfAndOwnedElementTransitiveDown, getSelfAndOwnedElementTransitiveDown, getSortedContents, sortContents

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELContAsgnAble

getAsgnKind, getContSortOrder, getFirstOwnerWhichIsConformTo, getOwner, getOwnerTransitive, getOwnerTransitive, getSelfAndOwnerTransitive, getSelfAndOwnerTransitive, getVersionRoot, isTransitiveChildOf, setAsgnKind, setContSortOrder, setOwner

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELDeleteAble

delete

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELElement

duplicateElement, getAssignAbleToVattr, getAssignAbleToVattr, getClientId, getCreateTemplateOfInstance, getDisplayBitmap, getDisplayColor, getDisplayFont, getDisplayLine, getDisplayName, getDisplayNameShort, getDisplayNSName, getElementCache, getElementMappingInformation, getNotificationElement, getQualifiedNamespaceName, getRelshipBinDir, getRelshipBinDir, getRelshipBinDirTarget, getUnitToLock, getValSpecElement, isContainedInProfile, isUnresolved, lockUnit, setUnresolved, unlockUnit

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELNamedElement

getName, getNameKind, getQualifiedDisplayName, getQualifiedName, getQualifiedTLName, getSupplierDependency, rename, setName, setNameKind

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELNamespaceAble

getElementImport, getImportedElement, getImportedElement, getImportedPackage, getImportedPackage, getMember, getMember, getMemberByPattern, getMemberByPattern, getOwnedConstraint, getOwnedMember, getOwnedMemberByPath, getOwnedMemberByPattern, getOwnedMemberByPattern, getOwnedMemberTransitiveByPattern, getOwnedMemberTransitiveByPattern, getOwnedMemberTransitiveByPatternIgnoreCase, getOwnedMemberTransitiveByPatternIgnoreCase, getPackageImport

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELNamespaceAsgnAble

getMnClassicTREFName, getNamespace, getNamespaceName, getPath, getSeparator, getVisibility, setUniqueName, setVisibility

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELObject

getId, getLongId, getMetaClass, getMetaName, getOclClass, getSrvCon, hasRead

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELRedefAble

getRedefined, getRedefining, isLeaf, isRedefined, isRedefining, setLeaf, setRedefined

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELUUIDAble

getHyperlinkReferenceAble, getInnoRef, getNotToTranslateAttribute, getTranslatedValue, getUUID, setUUID

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELValueContainerAble

getValueReUseAble, setValueReUseAble

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MECommentAble

getAssignedComment, getAssignedComment, getCommentAssign

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEConstraintAble

getAssignedConstraint, getAssignedConstraint, getConstraintAssign

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEModelElement

buildProxyConnection, getActivityPartition, getConsider, getContentStereotypeByClass, getCreateTemplateByClass, getDataModel, getDataModelName, getElementColor, getFirstValidContentStereotype, getIgnore, getKnownTypeSystems, getMEModelName, getModelElement, getModelElement, getPresContext, getPresContext, getPresetMapping, getPRPresContent, setElementColor

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MENamedElement

getMappingSourceElement, getMappingSourceElement, getMESupplierDependency, getMESupplierMappingDependency

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MENamespaceAsgnAble

getMENamespace, getSignatureMessage

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEStereotypeAble

getApplicableAnalysisDia, getClientMappingDependency, getDecisionMade, getDecisionOwned, getKnowledgeSourceOfOwner, getMappingTargetElement, getMappingTargetElement, getProxyAsgProperty, getRepresentingArtifact, getRequirementOfStakeholder, getRequirementOfStakeholderOwner, isMapped, setMapped, setRequirementOfStakeholder

Methods inherited from interface de.mid.innovator.srv2api.icw2model.METermAble

getTerm, setTerm

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMAttachmentAble

getAssignedAttachment, getAttachmentAssign, getDefaultAttachment, getOwnedAttachment, setDefaultAttachment

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMCommentContainerAble

getOutgoingConceptRealization, getOwnedComment, getRealizedConcept, getRealizedConcept, replaceRealizedConcepts, setRealizedConcept

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMLabelAble

getLabel, getLabelBoolValue, getLabelColor, getLabelInfo, getLabelLongValue, getLabelNameValue, getLabelStringValue, getLabelValueByPattern, getLabelValueByPattern, getLabelValueList, getOwnedLabelValSpec, hasLabel, modifyLabelValuesByName, setLabelInfo

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMStereotypeAble

assignStereotypeDlg, cloneElement, completelySynchronizeOthers, completelySynchronizeThis, getAttrCnstrEffective, getCreateTemplate, getDisplayType, getOwnedFormat, getOwnedStereotypePropertyValSpec, getOwnedStereotypeTSOptionValSpec, getOwnedSyncedElement, getPropBoolValue, getPropLongValue, getPropStringValue, getPropValueList, getStereoPropValueByPattern, getStereoPropValueByPattern, getStereotype, getStereotypeName, getStereotypeProperty, getStereotypePropertyInfo, getStereotypePropertyNameValue, getStereotypeTSOption, getStereotypeTSOptionBoolValue, getStereotypeTSOptionInfo, getStereotypeTSOptionLongValue, getStereotypeTSOptionNameValue, getStereotypeTSOptionStringValue, getStereotypeTSOptionValueByPattern, getStereotypeTSOptionValueByPattern, getStereotypeTSOptionValueList, getSyncedElement, getSyncedStereotypeAble, getSyncedStereotypeAble, isCloneAbleElement, modifyStereotypePropertyValuesByName, modifyStereotypeTSOptionValuesByName, setStereotype, setStereotypePropertyInfo, setStereotypeTSOptionInfo, setSyncedStereotypeAble

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMTextAble

getFlowExpandedValue, getModifyFlowDocuments, getModifyTextValues, getModifyTextValuesDlgInit, getOwnedTextValue, getOwnedTextValueByPattern, getText, getTextExpandedValue, getTextStringValue, getURIList, modifyFlowDocuments, modifyTextValuesDlg

Method Details

isUnmarshall

boolean isUnmarshall()
              throws InoNetException,
SrvErrorException

Indicates whether there is a single output pin for the event or multiple output pins for attributes of the event.

Throws:

InoNetException

SrvErrorException

setUnmarshall

void setUnmarshall(boolean value)
            throws InoNetException,
SrvErrorException

Set the value of Attribut IsUnmarshall.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getAcceptedEvents

<T extends BEEvent> List<T> getAcceptedEvents(Class<T> returnType,
 K_CONTROL_OPTION... behaviourFlags)
                                       throws InoNetException,
SrvErrorException

All events specified by the triggers which are accepted by the action.

Parameters:

returnType - Specifies the type of elements to be returned.

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getAcceptedEvents

<T extends BEEvent> List<T> getAcceptedEvents(Class<T> returnType,
 MMStereotype stereotype,
 K_CONTROL_OPTION... behaviourFlags)
                                       throws InoNetException,
SrvErrorException

The method calls getAcceptedEvents and filters its return values according to the given stereotype value.

Parameters:

returnType - Specifies the type of elements to be returned.

stereotype - The stereotype used to filter the result list

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getAcceptedTrigger

List<BETrigger> getAcceptedTrigger()
                            throws InoNetException,
SrvErrorException

All triggers which are accepted by the action.

Throws:

InoNetException

SrvErrorException

getAcceptedTrigger

List<BETrigger> getAcceptedTrigger(MMStereotype stereotype)
                            throws InoNetException,
SrvErrorException

The method calls getAcceptedTrigger and filters its return values according to the given stereotype value.

Parameters:

stereotype - The stereotype used to filter the result list

Throws:

InoNetException

SrvErrorException

getSentBy

<T extends ANAction> List<T> getSentBy(Class<T> returnType,
 K_CONTROL_OPTION... behaviourFlags)
                                throws InoNetException,
SrvErrorException

Returns all ANSendSignal/ANBroadcastSignal/ANSendObject actions that send signals accepted by this ANAcceptEvent.

Parameters:

returnType - Specifies the type of elements to be returned.

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getSentBy

<T extends ANAction> List<T> getSentBy(Class<T> returnType,
 MMStereotype stereotype,
 K_CONTROL_OPTION... behaviourFlags)
                                throws InoNetException,
SrvErrorException

The method calls getSentBy and filters its return values according to the given stereotype value.

Parameters:

returnType - Specifies the type of elements to be returned.

stereotype - The stereotype used to filter the result list

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getEventAsTrigger

<T extends METriggerReferenceAble> List<T> getEventAsTrigger(Class<T> returnType,
 K_CONTROL_OPTION... behaviourFlags)
                                                      throws InoNetException,
SrvErrorException

All events, signals and operations which may serve as triggers of the action.

Parameters:

returnType - Specifies the type of elements to be returned.

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getEventAsTrigger

<T extends METriggerReferenceAble> List<T> getEventAsTrigger(Class<T> returnType,
 MMStereotype stereotype,
 K_CONTROL_OPTION... behaviourFlags)
                                                      throws InoNetException,
SrvErrorException

The method calls getEventAsTrigger and filters its return values according to the given stereotype value.

Parameters:

returnType - Specifies the type of elements to be returned.

stereotype - The stereotype used to filter the result list

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

setEventAsTrigger

void setEventAsTrigger(List<? extends METriggerReferenceAble> values)
                throws InoNetException,
SrvErrorException

Set the value of View EventAsTrigger.

Parameters:

values - The value to be set.

Throws:

InoNetException

SrvErrorException

maintain

void maintain()
       throws InoNetException,
SrvErrorException

The list of result output pins of the ANAcceptEvent is maintained with reference to its triggers. If the list of triggers is homogeneous there will be: 1) No result pin for change events/call events 2) 1 result pin for time events 3) 1 result pin for every CLSignal if the action is not unmarshalling 4) 1 result pin for every CLProperty of the first CLSignal if the action is unmarshalling. Existing pins that coincide with reference to order and name will remain. All other pins not fitting the order will be deleted and recreated. Redundant pins will be removed.

Throws:

InoNetException

SrvErrorException

getResult

List<ANOutputPin> getResult(K_CONTROL_OPTION... behaviourFlags)
                     throws InoNetException,
SrvErrorException

Pins that hold the received event objects or their attributes. Event objects may be copied in transmission which may cause loss of identity.

Parameters:

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

Sorted:

the result may be sorted.

getTrigger

List<BETrigger> getTrigger(K_CONTROL_OPTION... behaviourFlags)
                    throws InoNetException,
SrvErrorException

The type of events accepted by the action, as specified by triggers. For triggers with signal events, a signal of the specified type or any subtype of the specified signal type is accepted.

Parameters:

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

Sorted:

the result may be sorted.