ITestPlan Interface

  • Article

Represents a test plan.

Namespace:  Microsoft.TeamFoundation.TestManagement.Client
Assembly:  Microsoft.TeamFoundation.TestManagement.Client (in Microsoft.TeamFoundation.TestManagement.Client.dll)

Syntax

'Declaration
Public Interface ITestPlan _
    Inherits ITestObject(Of Integer), IIdentifiable(Of Integer),  _
    IPropertyOwner, IDataErrorInfo, INotifyPropertyChanged

public interface ITestPlan : ITestObject<int>, 
    IIdentifiable<int>, IPropertyOwner, IDataErrorInfo, INotifyPropertyChanged

public interface class ITestPlan : ITestObject<int>, 
    IIdentifiable<int>, IPropertyOwner, IDataErrorInfo, INotifyPropertyChanged

type ITestPlan =  
    interface 
        interface ITestObject<int>
        interface IIdentifiable<int>
        interface IPropertyOwner 
        interface IDataErrorInfo 
        interface INotifyPropertyChanged 
    end

public interface ITestPlan extends ITestObject<int>, IIdentifiable<int>, IPropertyOwner, IDataErrorInfo, INotifyPropertyChanged

The ITestPlan type exposes the following members.

Properties

  Name Description
Public property AreaPath Gets or sets the area path of this test.
Public property AutomatedTestEnvironmentId Gets or sets the GUID of the environment for automated testing.
Public property AutomatedTestSettingsId Gets or sets the ID for the settings to use for automated testing.
Public property BuildDirectory Gets the name of the folder for the build that is currently associated with this plan.
Public property BuildFilter Gets the set of criteria that restricts the builds that can be associated with this test plan.
Public property BuildNumber Gets the name of the build that is currently associated with this test plan.
Public property BuildTakenDate Gets the date and time that the current build was associated with this test plan.
Public property BuildUri Gets or sets the uniform resource identifier (URI) for the build that is currently associated with this test plan.
Public property Description Gets or sets the description of this test plan.
Public property EndDate Gets or sets the end date for this test plan.
Public property Error Gets an error message indicating what is wrong with this object. (Inherited from IDataErrorInfo.)
Public property Id Gets the identifier. (Inherited from IIdentifiable<TKey>.)
Public property InvalidProperties Gets a list of property names that are invalid. (Inherited from IPropertyOwner.)
Public property IsDirty Gets a value that indicates whether any properties have changed since the last refresh, fetch, or save. (Inherited from IPropertyOwner.)
Public property Item Gets the error message for the property with the given name. (Inherited from IDataErrorInfo.)
Public property Iteration Gets or sets the iteration to which this test plan belongs.
Public property LastUpdated Gets the date and time that this test plan was last updated.
Public property LastUpdatedBy Gets the identity of the last person to update this test plan.
Public property LastUpdatedByName Last person to update plan
Public property Links Gets a collection of external links that is associated with this test plan.
Public property ManualTestEnvironmentId Gets or sets the GUID of the environment for manual testing.
Public property ManualTestSettingsId Gets or sets the ID for the manual test settings.
Public property Name Gets or sets the name of this test plan.
Public property NewBuildStatistics Gets a set of information about what has changed since the build that is currently associated with this plan was created.
Public property Owner Gets or sets the identity of the person who owns this test plan.
Public property OwnerName User who owns the plan.
Public property OwnerTeamFoundationId TeamFoundationId of the user who owns the plan.
Public property PreviousBuildUri Gets the URI of the previous build that was associated with this test plan.
Public property Project Gets the test project. (Inherited from ITestObject<T>.)
Public property Revision Gets the current revision number for this object. (Inherited from ITestObject<T>.)
Public property RootSuite Gets the root test suite for this test plan.
Public property StartDate Gets or sets the start date for this test plan.
Public property State Gets or sets the current state of this test plan.
Public property UserData Gets or sets an arbitrary object or value that is not persisted, but allows test management objects to be dynamically extended. (Inherited from ITestObject<T>.)

Top

Methods

  Name Description
Public method Clone Creates a copy of this test plan and returns it.
Public method CreateLink Creates a new, empty ITestExternalLink.
Public method CreateTestRun Creates and returns a new automated or manual test-run for this test plan.
Public method Delete() Deletes this test plan and all test runs and test points that are associated with it.
Public method Delete(DeleteAction) Deletes this test plan and all test runs and test points that are associated with it.
Public method FindTestPoint(Int32) Finds and returns a test point that is specified by the test point ID.
Public method FindTestPoint(Int32, String) Finds and returns a test point that is specified by the test point ID.
Public method QueryImpactedPoints(Uri) Returns a collection of test points that is affected by all builds. This includes previous builds and the specified build.
Public method QueryImpactedPoints(Uri, String) Returns a collection of test points that is affected by all builds. This includes previous builds and the specified build.
Public method QueryTestPointHierarchy Returns the hierarchy of test suites that contains test points that match the WIQL query.
Public method QueryTestPoints(String) Finds and returns all test points that belong to this test plan and that match the provided query.
Public method QueryTestPoints(String, String) Finds and returns all test points that belong to this test plan and that match the provided point query and field value subquery.
Public method QueryTestPoints(String, String, array<String[], Boolean) Finds all points that belong to this plan and match the given WIQL conditions.
Public method QueryTestPointsAndStatistics(String, String, ITestPointStatistics%) Finds all points that belong to this plan and match the given WIQL conditions.
Public method QueryTestPointsAndStatistics(String, String, array<String[], ITestPointStatistics%) Finds all points that belong to this plan and match the given WIQL conditions.
Public method QueryTestPointStatistics Finds and returns the test point statistics that belong to this test plan and that match the given query.
Public method QueryTestPointStatisticsByPivot Returns statistics of points by pivot that belong to this plan and match the given WIQL conditions.
Public method Refresh Refreshes all objects in this test plan by using current data from the server.
Public method RefreshRootSuite
Public method RefreshTestCase Refreshes all instances of the specified test case in this test plan.
Public method Save Saves the data from all objects in this test plan to the server.
Public method SetBuildInfo

Top

Events

  Name Description
Public event PropertyChanged Occurs when a property value changes. (Inherited from INotifyPropertyChanged.)

Top

Remarks

This interface supports the object model for Test Case management (TCM) in Visual Studio. This interface is not intended for you to implement in a custom class, but you can use this interface in a custom class when a TCM object returns an internal implementation.

See Also

Reference

Microsoft.TeamFoundation.TestManagement.Client Namespace

ITestObject<T>

IIdentifiable<TKey>

IPropertyOwner

IDataErrorInfo

INotifyPropertyChanged