Package de.mid.innovator.srv2api.icw2ia

Interface IAInteraction

All Superinterfaces:

ADAccessAble, ADClientAble, ADFindAble, ADHistoryAble, ADLockAble, ADM2AttrModifyAble, ADOptionAble, ADReferenceAble, ADVersionAble, BEBehavior, CLBehavioredClassifier, CLClass, CLClassifier, CLDeclarationAble, CLDeclarationAbleClassifier, CLEncapsulatedClassifier, CLParameterAble, CLStructuredClassifier, CLTemplateAbleElement, CLTemplateParameterAbleElement, ELClassifier, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELNamedElement, ELNamespaceAble, ELNamespaceAsgnAble, ELObject, ELPackageAble, ELRedefAble, ELType, ELUUIDAble, ELValueContainerAble, IAFragment, MECommentAble, MEConstraintAble, MEModelElement, MENamedElement, MENamespaceAble, MENamespaceAsgnAble, MEPackageAble, MEStereotypeAble, METermAble, MMAttachmentAble, MMCommentContainerAble, MMFormatAble, MMLabelAble, MMLabelTextAttachmentAble, MMMenuAble, MMStereotypeAble, MMTextAble

public interface IAInteraction
extends BEBehavior, MMMenuAble, IAFragment

An interaction is a unit of behavior that focuses on the observable exchange of information between ConnectAbleElements.

See Also:

• IAInteractionHelper

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	IAInteraction.VAttr

Method Summary

Modifier and Type	Method	Description
<T extends ANAction> List<T>	getAction(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	Action of the interaction.
List<IALifeline>	getDecomposedLifeline()	All lifelines which are decomposed by this interaction.
SQDia	getDiagram()	The seqeuence diagram for this interaction.
List<IAGate>	getFormalGate(K_CONTROL_OPTION... behaviourFlags)	Specifies the gates that form the message interface between this IAInteraction and any IAUse that reference it.
<T extends IAFragment> List<T>	getFragment(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	The ordered set of fragments in the interaction.
List<IALifeline>	getLifeline(K_CONTROL_OPTION... behaviourFlags)	Specifies the participants in this interaction.
List<IALostAndFound>	getLostAndFound(K_CONTROL_OPTION... behaviourFlags)	The occurrences of lost or found messages contained in this interaction.
<T extends IAMessage> List<T>	getMessage(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	The messages contained in this interaction.
List<MEDurationConstraint>	getOwnedDurationConstraint(K_CONTROL_OPTION... behaviourFlags)
List<METimeConstraint>	getOwnedTimeConstraint(K_CONTROL_OPTION... behaviourFlags)
List<IAUse>	getUsedBy()	All usages of this IAInteraction.

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

getAccessRole, getReadRole, hasAccess, setAccessRole, setReadRole

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.ADLockAble

getLock, getLockableCache, getLockLogin, getLockName, hasClutch, hasLock, hasNoLock, hasOthLock, hasOwnLock, isLockable, lock, unlock

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.icw2meta.ADOptionAble

getOwnedOption, modifyOptionDlg

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

getReferenceContainer, setReferenceContainer

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

getVersionFile, getVersionList, getVersionListWithoutOpenInfo

Methods inherited from interface de.mid.innovator.srv2api.icw2be.BEBehavior

getBehavioredClassifier, getBehaviorExecSpec, getBehaviorOwnedRule, getCallBehaviorAction, getConnector, getDecisionNodeR, getDoActivityOwningState, getEntryOwningState, getExitOwningState, getModifyBehaviorDeclaration, getObjectFlowSelectionR, getObjectFlowWithSelection, getObjectFlowWithSelection, getObjectFlowWithTransformation, getObjectFlowWithTransformation, getObjectNodeR, getObjectNodeWithSelection, getObjectNodeWithSelection, getOwnedParameter, getOwningTransition, getPictureRawData, getPostcondition, getPrecondition, getSpecification, isClassifierBehavior, isReentrant, maintain, modifyBehaviorDeclaration, setClassifierBehavior, setReentrant, setSpecification

Methods inherited from interface de.mid.innovator.srv2api.icw2class.CLBehavioredClassifier

getClassifierBehavior, getInterfaceRealization, getOwnedBehavior, getOwnedProtocolStateMachine, getOwnedTrigger, getOwnedTrigger

Methods inherited from interface de.mid.innovator.srv2api.icw2class.CLClass

getNestedClassifier, getOwnedAttribute, getOwnedOperation, getOwnedReception, isActive, setActive

Methods inherited from interface de.mid.innovator.srv2api.icw2class.CLClassifier

dialogFolderRedefine, getAggregatedClassifier, getAggregatedClassifier, getAggregatedOrComposedClassifier, getAggregatedOrComposedClassifier, getAggregatingClassifier, getAggregatingClassifier, getAggregatingOrComposingClassifier, getAggregatingOrComposingClassifier, getClassifierInstance, getClassifierTemplateParameter, getComposedClassifier, getComposedClassifier, getComposingClassifier, getComposingClassifier, getContract, getContract, getContractSubstitution, getCreateObjectAction, getExceptionHandler, getInstSpec, getInterface, getOwnClass, getOwnedRule, getOwnedTemplateParameter, getOwnedUseCase, getProvidedInterface, getProvidedInterface, getProvidedInterfaceDirect, getProvidedInterfaceDirect, getRealizingClassifierRealization, getRequiredInterface, getRequiredInterface, getRequiredInterfaceDirect, getRequiredInterfaceDirect, getSubstitution, getTypedBCProperty, getTypedObjectNode, getTypedParameter, getTypedProperty, getTypedPropertyNotAssocEnd, getTypedVariable, getTypedVariableDRGElement, getTypedVariableDRGElement, getUnmarshallAction, getUseCase

Methods inherited from interface de.mid.innovator.srv2api.icw2class.CLEncapsulatedClassifier

getOwnedPort

Methods inherited from interface de.mid.innovator.srv2api.icw2class.CLParameterAble

getFormalParameter, getFormalParameter, getOwnedParam, getOwnedParameterSet, getReturnResult

Methods inherited from interface de.mid.innovator.srv2api.icw2class.CLStructuredClassifier

getCollaborationUse, getOwnedConnector, getOwnedProperty, getRepresentation

Methods inherited from interface de.mid.innovator.srv2api.icw2class.CLTemplateAbleElement

getActualTemplateParameter, getActualTemplateParameter, getOwnedTemplateParameter, getTemplateBindingSource, getTemplateBindingTarget, getTemplateParameter

Methods inherited from interface de.mid.innovator.srv2api.icw2class.CLTemplateParameterAbleElement

getActualParameterSubstitution, getOwningTemplateParameter, getTemplateParameter

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

getAssociation, getAssociation, getAssociationEndFirstTypedBySelf, getAssociationEndFirstTypedBySelf, getAssociationEndNavigableTypedBySelf, getAssociationEndNavigableTypedBySelf, getAssociationEndNavigableTypedBySelfOrGeneralTransitive, getAssociationEndNavigableTypedBySelfOrGeneralTransitive, getAssociationEndTypedBySelf, getAssociationEndTypedBySelf, getAssociationEndTypedBySelfOrGeneralTransitive, getAssociationEndTypedBySelfOrGeneralTransitive, getAssociationNavigableFrom, getAssociationNavigableFrom, getAssociationOfSelfOrGeneralTransitive, getAssociationOfSelfOrGeneralTransitive, getAssociationTypedBySelf, getAssociationTypedBySelf, getClassifierViewGroup, getEffectiveRedefinerOfAssocEnd, getEffectiveRedefinerOfAssocEnd, getEffectiveSubsetterOfAssocEnd, getEffectiveSubsetterOfAssocEnd, getGeneralDirect, getGeneralDirect, getGeneralGeneralizationSet, getGeneralGeneralizationSet, getGeneralization, getGeneralTransitive, getGeneralTransitive, getItemDefinition, getOwnedAndInheritedMember, getOwnedAndInheritedMember, getPropertyNavigableFrom, getPropertyNavigableFrom, getPropertyNavigableFromSelfOrGeneralTransitive, getPropertyNavigableFromSelfOrGeneralTransitive, getSelfAndGeneralTransitive, getSelfAndGeneralTransitive, getSelfAndSpecificTransitive, getSelfAndSpecificTransitive, getSelfAndSpecificTransitiveNotAbstract, getSelfAndSpecificTransitiveNotAbstract, getSpecialization, getSpecificDirect, getSpecificDirect, getSpecificGeneralization, getSpecificGeneralizationSet, getSpecificGeneralizationSet, getSpecificTransitive, getSpecificTransitive, getSpecificTransitiveNotAbstract, getSpecificTransitiveNotAbstract, getSpecificTransitiveNotAbstractRange, getSpecificTransitiveNotAbstractRange, getSpecificTransitiveNotAbstractTypesOfEffectiveSubsetterOfAssocEnd, getSpecificTransitiveNotAbstractTypesOfEffectiveSubsetterOfAssocEnd, getSpecificTransitiveNotAbstractTypesOfEffectiveSubsetterOfAssocEndIntersectedByInverseAssocEnd, getSpecificTransitiveNotAbstractTypesOfEffectiveSubsetterOfAssocEndIntersectedByInverseAssocEnd, getTypedCLStructureEntry, getTypedMaskField, getTypesOfEffectiveSubsetterOfAssocEnd, getTypesOfEffectiveSubsetterOfAssocEnd, getViewTransitive, getViewTransitive, isAbstract, isRoot, isSpecificTransitive, setAbstract

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.ELPackageAble

getElementImportingNamespace, getElementImportingNamespace, getImportedPackageAble, getOwningPackage

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.ELType

getRaisingAsException, getTypedElement, getTypedElementNotAssocEnd, getTypedElementNotAssocEnd, isTypeReuseable

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.icw2ia.IAFragment

getEnclosingInteraction, getEnclosingOperand, getGeneralOrdering

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.MENamespaceAble

getMEOwnedMember, getMEPackageImport

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

getMENamespace, getSignatureMessage

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

getComponent, getManifest

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.MMFormatAble

copyFormatDlg, copyFormatRule, getCopyFormatDlgInit, getFormat

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.MMMenuAble

getMenu, getMenuItem, getMenuItemsForTransform

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

getUsedBy

List<IAUse> getUsedBy()
               throws InoNetException,
SrvErrorException

All usages of this IAInteraction.

Throws:

InoNetException

SrvErrorException

getDecomposedLifeline

List<IALifeline> getDecomposedLifeline()
                                throws InoNetException,
SrvErrorException

All lifelines which are decomposed by this interaction.

Throws:

InoNetException

SrvErrorException

getDiagram

SQDia getDiagram()
          throws InoNetException,
SrvErrorException

The seqeuence diagram for this interaction.

Throws:

InoNetException

SrvErrorException

getFragment

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

The ordered set of fragments in the interaction.

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

Sorted:

the result may be sorted.

getAction

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

Action of the interaction.

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

Sorted:

the result may be sorted.

getLostAndFound

List<IALostAndFound> getLostAndFound(K_CONTROL_OPTION... behaviourFlags)
                              throws InoNetException,
SrvErrorException

The occurrences of lost or found messages contained in this interaction.

Parameters:

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

Throws:

InoNetException

SrvErrorException

Sorted:

the result may be sorted.

getFormalGate

List<IAGate> getFormalGate(K_CONTROL_OPTION... behaviourFlags)
                    throws InoNetException,
SrvErrorException

Specifies the gates that form the message interface between this IAInteraction and any IAUse that reference it.

Parameters:

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

Throws:

InoNetException

SrvErrorException

Sorted:

the result may be sorted.

getMessage

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

The messages contained in this interaction.

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

Sorted:

the result may be sorted.

getOwnedTimeConstraint

List<METimeConstraint> getOwnedTimeConstraint(K_CONTROL_OPTION... behaviourFlags)
                                       throws InoNetException,
SrvErrorException

Parameters:

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

Throws:

InoNetException

SrvErrorException

Sorted:

the result may be sorted.

getOwnedDurationConstraint

List<MEDurationConstraint> getOwnedDurationConstraint(K_CONTROL_OPTION... behaviourFlags)
                                               throws InoNetException,
SrvErrorException

Parameters:

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

Throws:

InoNetException

SrvErrorException

Sorted:

the result may be sorted.

getLifeline

List<IALifeline> getLifeline(K_CONTROL_OPTION... behaviourFlags)
                      throws InoNetException,
SrvErrorException

Specifies the participants in this interaction.

Parameters:

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

Throws:

InoNetException

SrvErrorException

Sorted:

the result may be sorted.