IInteraction Interface

 

A definition of behavior that focuses on the observable exchange of information between objects.

Namespace:   Microsoft.VisualStudio.Uml.Interactions
Assembly:  Microsoft.VisualStudio.Uml.Interfaces (in Microsoft.VisualStudio.Uml.Interfaces.dll)

public interface IInteraction : IInteractionFragment, INamedElement, 
	IElement, IBehavior, IClass, IBehavioredClassifier, IClassifier, 
	IType, IPackageableElement, IParameterableElement, INamespace, 
	IRedefinableElement, ITemplateableElement, IEncapsulatedClassifier, 
	IStructuredClassifier

NameDescription
System_CAPS_pubpropertyApplicableStereotypes

The set of stereotypes that could be applied to this element. (Inherited from IElement.)

System_CAPS_pubpropertyAppliedStereotypes

Each IStereotypeInstance denotes that a stereotype has been applied to this element.(Inherited from IElement.)

System_CAPS_pubpropertyClientDependencies

Gets the Dependency relationships for which this element is the Client. (Inherited from INamedElement.)

System_CAPS_pubpropertyContext

Gets the classifier that is the context for the execution of the behavior. (Inherited from IBehavior.)

System_CAPS_pubpropertyCoveredLifelines

For some types of fragment, gets the lifelines on which the fragment is situated. (Inherited from IInteractionFragment.)

System_CAPS_pubpropertyDescription

The description of this element. (Inherited from IElement.)

System_CAPS_pubpropertyEnclosingInteraction

Gets the Interaction that contains this Interaction Fragment. (Inherited from IInteractionFragment.)

System_CAPS_pubpropertyEnclosingOperand

Gets the Interaction Operand that contains a nested Combined Fragment. Applies to Combined Fragments. (Inherited from IInteractionFragment.)

System_CAPS_pubpropertyFeatures

Gets the Attributes, Operations and Receptions that are associated with every member of this class. A subset of Namespace::Member. (Inherited from IClassifier.)

System_CAPS_pubpropertyFragments

Gets the elements of the interaction, including top-level Combined Fragments and Interaction Uses. Also all message sends, behavior executions, and so on, including those contained in Combined Fragments.

System_CAPS_pubpropertyGeneralizations

Gets the Generalization relationships through which this Classifier inherits Features. (Inherited from IClassifier.)

System_CAPS_pubpropertyGenerals

Gets the Classifiers from which this Classifier inherits Members. (Inherited from IClassifier.)

System_CAPS_pubpropertyInheritedMembers

Gets the subset of Members that are inherited. (Inherited from IClassifier.)

System_CAPS_pubpropertyInteractionUses

Gets the Interaction Uses that reference this Interaction from other Interactions.

System_CAPS_pubpropertyInterfaceRealizations

Gets the Interfaces realized by this behavior. (Inherited from IBehavioredClassifier.)

System_CAPS_pubpropertyIsAbstract

True if this is a partial description intended to be extended or overridden in specializing classes. (Inherited from IClassifier.)

System_CAPS_pubpropertyIsActiveClass

True if each instance of this class is associated with a thread of control. (Inherited from IClass.)

System_CAPS_pubpropertyIsLeaf

True if this element should not be specialized. That is, it should not be the target of a Generalization relationship. (Inherited from IRedefinableElement.)

System_CAPS_pubpropertyIsReentrant

True if the behavior can be invoked while it is still executing from a previous invocation. (Inherited from IBehavior.)

System_CAPS_pubpropertyIsTemplate

True if this class is a template that can be bound to parameters. (Inherited from IClassifier.)

System_CAPS_pubpropertyLifelines

Gets all the lifelines that are described in this Interaction.

System_CAPS_pubpropertyMembers

Gets the elements that are part of this Namespace. (Inherited from INamespace.)

System_CAPS_pubpropertyMessages

Gets all the messages that are described in this interaction, including any that are inside Combined Fragments.

System_CAPS_pubpropertyName

The name of this element within the Namespace that contains it. In this Namespace, there should be no other element that has this Name. (Inherited from INamedElement.)

System_CAPS_pubpropertyNamespace

Gets the Namespace in which this element is defined. May be null. (Inherited from INamedElement.)

System_CAPS_pubpropertyNestedClassifiers

Gets the list of classes that are defined inside this class. (Inherited from IClass.)

System_CAPS_pubpropertyOwnedAttributes

Gets the list of attributes (properties) that are defined in this class. (Inherited from IClass.)

System_CAPS_pubpropertyOwnedBehaviors

Gets the Behaviors defined within the scope of this classifier. (Inherited from IBehavioredClassifier.)

System_CAPS_pubpropertyOwnedComments

Gets Comments contained in this element (not comments linked to it). (Inherited from IElement.)

System_CAPS_pubpropertyOwnedConnectors

Gets the connectors owned by the classifier, for example the Assembly and Delegate connectors in a Component. (Inherited from IStructuredClassifier.)

System_CAPS_pubpropertyOwnedElements

Gets Elements owned by this element. Every element has one owner, except the root IModel.(Inherited from IElement.)

System_CAPS_pubpropertyOwnedMembers

Gets the elements that are defined within this Namespace. (Inherited from INamespace.)

System_CAPS_pubpropertyOwnedOperations

Gets the list of operations that are defined in this class. (Inherited from IClass.)

System_CAPS_pubpropertyOwnedParameters

Gets the Parameters that are owned by the Behavior. (Inherited from IBehavior.)

System_CAPS_pubpropertyOwnedPorts

Gets the Ports through which instances of this type interact with other instances. (Inherited from IEncapsulatedClassifier.)

System_CAPS_pubpropertyOwnedRedefinableTemplateSignature

(Inherited from IClassifier.)

System_CAPS_pubpropertyOwner

Gets the Element that owns this element. Every element except the root IModel has one owner.(Inherited from IElement.)

System_CAPS_pubpropertyOwningPackage

Gets the package that contains this element. (Inherited from IPackageableElement.)

System_CAPS_pubpropertyOwningTemplateParameter

If not null, this element is defined as a parameter in a template. (Inherited from IParameterableElement.)

System_CAPS_pubpropertyPackage

Gets the package to which the type belongs. (Inherited from IType.)

System_CAPS_pubpropertyPackageImports

Gets the packages that are imported by this namespace. (Inherited from INamespace.)

System_CAPS_pubpropertyParts

Gets the Properties of which this classifier is composed. (Inherited from IStructuredClassifier.)

System_CAPS_pubpropertyQualifiedName

Gets the name of this element, prefixed with the Qualified Name of the Namespace that contains it. Empty if the Name is empty or if the Qualified Name of the Namespace is empty. (Inherited from INamedElement.)

System_CAPS_pubpropertySpecification

The behavioral feature that the Behavior implements. (Inherited from IBehavior.)

System_CAPS_pubpropertySuperClasses

Gets the Classes from which this class inherits features. (Inherited from IClass.)

System_CAPS_pubpropertyTemplateBindings

Gets the Bindings in which this element is used. (Inherited from ITemplateableElement.)

System_CAPS_pubpropertyTemplateParameter

If not null, this element is defined as a parameter in a template. (Inherited from IParameterableElement.)

System_CAPS_pubpropertyTypedElements

Gets the Typed elements that are constrained to contain values of this type. (Inherited from IType.)

System_CAPS_pubpropertyUseCases

Gets the Use Cases for which this Classifier is the Subject. (Inherited from IClassifier.)

System_CAPS_pubpropertyVisibility

Defines where the element can be referenced. Public = visible anywhere; private = visible only in the owning Namespace; protected = visible to elements that have a generalization relationship to the owning Namespace; package = visible only in the Package owning the Namespace, if there is one. Default = public. (Inherited from INamedElement.)

System_CAPS_pubpropertyVisibleAppliedStereotypes

(Inherited from IElement.)

NameDescription
System_CAPS_pubmethodAddReference(String, String, Boolean)

Links a string to an element, usually where the string is a reference such as a URI, modelbus reference, or work item ID. Use the name to indicate the type of reference. Returns an IReference object that represents the link.(Defined by UmlExtensions.)

System_CAPS_pubmethodApplyStereotype(IStereotype)

Applies the stereotype to element. Creates an IStereotypeInstance that represents the extension of the model element by the stereotype.(Defined by ProfileStereotypeExtensions.)

System_CAPS_pubmethodCreateAttribute()

Create a new IProperty object in the Class(Defined by ClassExtensions.)

System_CAPS_pubmethodCreateCombinedFragment(InteractionOperatorKind, IEnumerable<IInsertionPoint>)

Overloaded. Create a Combined Fragment containing one operand. You can add more operands later.(Defined by InteractionExtensions.)

System_CAPS_pubmethodCreateCombinedFragment(InteractionOperatorKind, IEnumerable<IMessage>)

Overloaded. Create a Combined Fragment containing one operand. You can add more operands later.(Defined by InteractionExtensions.)

System_CAPS_pubmethodCreateCombinedFragment(InteractionOperatorKind, IInteractionUse)

Overloaded. Create a Combined Fragment containing one operand. You can add more operands later.(Defined by InteractionExtensions.)

System_CAPS_pubmethodCreateComment()

Create a Comment.(Defined by InteractionExtensions.)

System_CAPS_pubmethodCreateConnector(IConnectableElement, IConnectableElement, IProperty, IProperty)

Connect the source element to a target element, such as a Part or Port. If the source or target is a Port located on a Part, specify both.(Defined by ConnectableElementExtensions.)

System_CAPS_pubmethodCreateGeneralization(IClassifier)

Create a new generalization of this classifier. An IGeneralization relationship is created between this and another given classifier.(Defined by ClassifierExtensions.)

System_CAPS_pubmethodCreateInteraction()

Create a new IInteraction object in the BehavioredClassifier(Defined by BehavioredClassifierExtensions.)

System_CAPS_pubmethodCreateInteractionUse(IEnumerable<IInsertionPoint>)

(Defined by InteractionExtensions.)

System_CAPS_pubmethodCreateLifeline()

Create a new ILifeline object in the Interaction(Defined by InteractionExtensions.)

System_CAPS_pubmethodCreateLostFoundMessage(MessageKind, IInsertionPoint)

Create a message that does not begin on a lifeline, or that does not end on a lifeline.(Defined by InteractionExtensions.)

System_CAPS_pubmethodCreateMessage(IInsertionPoint, IInsertionPoint, MessageKind, MessageSort)

Create a complete message, beginning and ending on specified lifelines.(Defined by InteractionExtensions.)

System_CAPS_pubmethodCreateNestedActivity()

Create an activity that describes the behavior of this element.(Defined by BehavioredClassifierExtensions.)

System_CAPS_pubmethodCreateOperation()

Create a new IOperation object in the Class(Defined by ClassExtensions.)

System_CAPS_pubmethodCreatePackageImport(IPackage)

Import a package into a namespace. Creates an IPackageImport link to the package.(Defined by NamespaceExtensions.)

System_CAPS_pubmethodCreateParameter()

Create a new IParameter object in the Behavior(Defined by BehaviorExtensions.)

System_CAPS_pubmethodCreatePart()

Overloaded. Create a new Part, with an unspecified type.(Defined by StructuredClassifierExtensions.)

System_CAPS_pubmethodCreatePart(IComponent)

Overloaded. Create a new Part, with a given type, or with a new type. Specify a null type to create a new Component as the type of the Part.(Defined by StructuredClassifierExtensions.)

System_CAPS_pubmethodCreateProperty()

Create a new IProperty object in the Interaction(Defined by InteractionExtensions.)

System_CAPS_pubmethodCreateTemplateBinding(IClassifier)

Bind the given classifier to given template classifier. If required, add parameter substitutions using CreateSubstitution.(Defined by TemplateBindingExtensions.)

System_CAPS_pubmethodCreateTemplateParameter(IParameterableElement)

Overloaded. Creates a template parameter that references given parameteredElement.(Defined by TemplateBindingExtensions.)

System_CAPS_pubmethodCreateTemplateParameter(TemplateParameterKind, String)

Overloaded. Creates a template parameter with the given name.(Defined by TemplateBindingExtensions.)

System_CAPS_pubmethodCreateTemplateSignature()

Creates a template signature on the given classifier.(Defined by TemplateBindingExtensions.)

System_CAPS_pubmethodDelete()

Deletes this element and any relationships, owned elements, and shapes.(Defined by UmlExtensions.)

System_CAPS_pubmethodDeleteAllReference(String)

Remove all the references of a given tag.(Defined by UmlExtensions.)

System_CAPS_pubmethodFindTemplateParameter(String)

Find a template parameter by name.(Defined by TemplateBindingExtensions.)

System_CAPS_pubmethodGetCombinedFragments()

All the combined fragments under the interaction.(Defined by InteractionExtensions.)

System_CAPS_pubmethodGetDependencyClients()

Return a collection of elements that are dependent on this.(Defined by NamedElementExtensions.)

System_CAPS_pubmethodGetDependencySuppliers()

Return a collection of elements on which this is dependent.(Defined by NamedElementExtensions.)

System_CAPS_pubmethodGetId()

Gets a GUID that identifies this element.(Defined by UmlExtensions.)

System_CAPS_pubmethodGetImportedPackages()

The imported packages of the namespace(Defined by PackageExtensions.)

System_CAPS_pubmethodGetModelStore()

Overloaded. Gets the IModelStore that contains this element.(Defined by UmlExtensions.)

System_CAPS_pubmethodGetOutgoingAssociationEnds()

The opposite ends of the associations that are linked to this classifier. From the association ends, you can get the linked classifier and its type.(Defined by ClassifierExtensions.)

System_CAPS_pubmethodGetRealizedInterfaces()

Returns a collection of the IInterfaces implemented by the given classifier.(Defined by BehavioredClassifierExtensions.)

System_CAPS_pubmethodGetReferences(String)

Get the IReferences of a given tag that are associated with this element.(Defined by UmlExtensions.)

System_CAPS_pubmethodGetRelatedElements<T>()

Gets elements related to this element by relationships of the specified type.(Defined by UmlExtensions.)

System_CAPS_pubmethodGetRelatedLinks<T>()

Gets relationships of a specified type from or to this element.(Defined by UmlExtensions.)

System_CAPS_pubmethodGetSpecifics()

Returns all the classifiers that specialize this classifier.(Defined by ClassifierExtensions.)

System_CAPS_pubmethodSetOwner(IClassifier)

Overloaded. Change the owner.(Defined by SetOwnerExtensions.)

System_CAPS_pubmethodSetOwner(IPackage)

Overloaded. Change the owner.(Defined by SetOwnerExtensions.)

System_CAPS_pubmethodShapes(IDiagram)

Overloaded. All the shapes that display the model element on any open diagram, or on a specified open diagram.(Defined by PresentationHelpers.)

For more information about using this type, see Edit UML sequence diagrams by using the UML API.

System_CAPS_noteNote

The methods defined on this type are extension methods. To use the methods, you must add a project reference to the .NET assembly Microsoft.VisualStudio.ArchitectureTools.Extensibility.dll, and you must include the directive using Microsoft.VisualStudio.ArchitectureTools.Extensibility.Uml; in your code.

Return to top
Show: