ITestPlan Interface

Article
09/08/2015

No content here will be updated; please do not add material here.

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

Syntax

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
    Inherits ITestObject(Of Integer), IIdentifiable(Of Integer), IPropertyOwner,
    IDataErrorInfo, INotifyPropertyChanged

Properties

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

Methods

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

Events

	Name	Description
	PropertyChanged	(Inherited from INotifyPropertyChanged.)

Remarks