IUseCase Interface

The specification of an externally visible set of actions that a system can perform in collaboration with one or more actors.

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

Syntax

'Declaration
Public Interface IUseCase _
    Inherits IBehavioredClassifier, IClassifier, IType, IPackageableElement,  _
    IParameterableElement, INamespace, IRedefinableElement, INamedElement, ITemplateableElement,  _
    IElement

public interface IUseCase : IBehavioredClassifier, 
    IClassifier, IType, IPackageableElement, IParameterableElement, INamespace, 
    IRedefinableElement, INamedElement, ITemplateableElement, IElement

public interface class IUseCase : IBehavioredClassifier, 
    IClassifier, IType, IPackageableElement, IParameterableElement, INamespace, 
    IRedefinableElement, INamedElement, ITemplateableElement, IElement

type IUseCase =  
    interface 
        interface IBehavioredClassifier 
        interface IClassifier 
        interface IType 
        interface IPackageableElement 
        interface IParameterableElement 
        interface INamespace 
        interface IRedefinableElement 
        interface INamedElement 
        interface ITemplateableElement 
        interface IElement 
    end

public interface IUseCase extends IBehavioredClassifier, IClassifier, IType, IPackageableElement, IParameterableElement, INamespace, IRedefinableElement, INamedElement, ITemplateableElement, IElement

The IUseCase type exposes the following members.

Properties

	Name	Description
	ApplicableStereotypes	The set of stereotypes that could be applied to this element. (Inherited from IElement.)
	AppliedStereotypes	Each IStereotypeInstance denotes that a stereotype has been applied to this element. (Inherited from IElement.)
	ClientDependencies	Gets the Dependency relationships for which this element is the Client. (Inherited from INamedElement.)
	Description	The description of this element. (Inherited from IElement.)
	Extends	Gets the relationships to the Use Cases extended by this Use Case.
	Features	Gets the Attributes, Operations and Receptions that are associated with every member of this class. A subset of Namespace::Member. (Inherited from IClassifier.)
	Generalizations	Gets the Generalization relationships through which this Classifier inherits Features. (Inherited from IClassifier.)
	Generals	Gets the Classifiers from which this Classifier inherits Members. (Inherited from IClassifier.)
	Includes	Gets the relationships to the Use Cases included by this Use Case.
	InheritedMembers	Gets the subset of Members that are inherited. (Inherited from IClassifier.)
	InterfaceRealizations	Gets the Interfaces realized by this behavior. (Inherited from IBehavioredClassifier.)
	IsAbstract	True if this is a partial description intended to be extended or overridden in specializing classes. (Inherited from IClassifier.)
	IsLeaf	True if this element should not be specialized. That is, it should not be the target of a Generalization relationship. (Inherited from IRedefinableElement.)
	IsTemplate	True if this class is a template that can be bound to parameters. (Inherited from IClassifier.)
	Members	Gets the elements that are part of this Namespace. (Inherited from INamespace.)
	Name	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.)
	Namespace	Gets the Namespace in which this element is defined. May be null. (Inherited from INamedElement.)
	OwnedBehaviors	Gets the Behaviors defined within the scope of this classifier. (Inherited from IBehavioredClassifier.)
	OwnedComments	Gets Comments contained in this element (not comments linked to it). (Inherited from IElement.)
	OwnedElements	Gets Elements owned by this element. Every element has one owner, except the root IModel. (Inherited from IElement.)
	OwnedMembers	Gets the elements that are defined within this Namespace. (Inherited from INamespace.)
	OwnedRedefinableTemplateSignature	(Inherited from IClassifier.)
	Owner	Gets the Element that owns this element. Every element except the root IModel has one owner. (Inherited from IElement.)
	OwningPackage	Gets the package that contains this element. (Inherited from IPackageableElement.)
	OwningTemplateParameter	If not null, this element is defined as a parameter in a template. (Inherited from IParameterableElement.)
	Package	Gets the package to which the type belongs. (Inherited from IType.)
	PackageImports	Gets the packages that are imported by this namespace. (Inherited from INamespace.)
	QualifiedName	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.)
	Subjects	Gets the subsystem or subsystems that support the execution of this use case.
	TemplateBindings	Gets the Bindings in which this element is used. (Inherited from ITemplateableElement.)
	TemplateParameter	If not null, this element is defined as a parameter in a template. (Inherited from IParameterableElement.)
	TypedElements	Gets the Typed elements that are constrained to contain values of this type. (Inherited from IType.)
	UseCases	Gets the Use Cases for which this Classifier is the Subject. (Inherited from IClassifier.)
	Visibility	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.)
	VisibleAppliedStereotypes	(Inherited from IElement.)

Top

Extension Methods

	Name	Description
	AddReference	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.)
	ApplyStereotype	Applies the stereotype to element. Creates an IStereotypeInstance that represents the extension of the model element by the stereotype. (Defined by ProfileStereotypeExtensions.)
	CreateExtend	Create an IExtend link to show that this use case extends the definition of another. (Defined by UseCaseExtensions.)
	CreateGeneralization	Create a new generalization of this classifier. An IGeneralization relationship is created between this and another given classifier. (Defined by ClassifierExtensions.)
	CreateInclude	Create an IInclude link to show that this use case includes another. (Defined by UseCaseExtensions.)
	CreateInteraction	Create a new IInteraction object in the BehavioredClassifier (Defined by BehavioredClassifierExtensions.)
	CreateNestedActivity	Create an activity that describes the behavior of this element. (Defined by BehavioredClassifierExtensions.)
	CreatePackageImport	Import a package into a namespace. Creates an IPackageImport link to the package. (Defined by NamespaceExtensions.)
	CreateTemplateBinding	Bind the given classifier to given template classifier. If required, add parameter substitutions using CreateSubstitution. (Defined by TemplateBindingExtensions.)
	CreateTemplateParameter(IParameterableElement)	Overloaded. Creates a template parameter that references given parameteredElement. (Defined by TemplateBindingExtensions.)
	CreateTemplateParameter(TemplateParameterKind, String)	Overloaded. Creates a template parameter with the given name. (Defined by TemplateBindingExtensions.)
	CreateTemplateSignature	Creates a template signature on the given classifier. (Defined by TemplateBindingExtensions.)
	Delete	Deletes this element and any relationships, owned elements, and shapes. (Defined by UmlExtensions.)
	DeleteAllReference	Remove all the references of a given tag. (Defined by UmlExtensions.)
	FindTemplateParameter	Find a template parameter by name. (Defined by TemplateBindingExtensions.)
	GetDependencyClients	Return a collection of elements that are dependent on this. (Defined by NamedElementExtensions.)
	GetDependencySuppliers	Return a collection of elements on which this is dependent. (Defined by NamedElementExtensions.)
	GetExtendedCases	The use cases extended by this use case. (Defined by UseCaseExtensions.)
	GetExtendingCases	The use cases that extend this use case. (Defined by UseCaseExtensions.)
	GetId	Gets a GUID that identifies this element. (Defined by UmlExtensions.)
	GetImportedPackages	The imported packages of the namespace (Defined by PackageExtensions.)
	GetIncludedCases	The use cases that are included by this use case. (Defined by UseCaseExtensions.)
	GetIncludingCases	The use cases that include this use case. (Defined by UseCaseExtensions.)
	GetModelStore	Gets the IModelStore that contains this element. (Defined by UmlExtensions.)
	GetOutgoingAssociationEnds	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.)
	GetRealizedInterfaces	Returns a collection of the IInterfaces implemented by the given classifier. (Defined by BehavioredClassifierExtensions.)
	GetReferences	Get the IReferences of a given tag that are associated with this element. (Defined by UmlExtensions.)
	GetRelatedElements<T>	Gets elements related to this element by relationships of the specified type. (Defined by UmlExtensions.)
	GetRelatedLinks<T>	Gets relationships of a specified type from or to this element. (Defined by UmlExtensions.)
	GetSpecifics	Returns all the classifiers that specialize this classifier. (Defined by ClassifierExtensions.)
	SetOwner	Change the owner. (Defined by SetOwnerExtensions.)
	Shapes	All the shapes that display the model element on any open diagram, or on a specified open diagram. (Defined by PresentationHelpers.)

Top

Remarks

Note

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.

See Also

Reference

Microsoft.VisualStudio.Uml.UseCases Namespace