Share via


ITestSuiteBase Interface

Represents the common properties and methods that are used by all suite types.

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

Syntax

'Declaration
Public Interface ITestSuiteBase _
    Inherits ITestObject(Of Integer), IIdentifiable(Of Integer),  _
    IPropertyOwner, IDataErrorInfo, INotifyPropertyChanged
public interface ITestSuiteBase : ITestObject<int>, 
    IIdentifiable<int>, IPropertyOwner, IDataErrorInfo, INotifyPropertyChanged
public interface class ITestSuiteBase : ITestObject<int>, 
    IIdentifiable<int>, IPropertyOwner, IDataErrorInfo, INotifyPropertyChanged
type ITestSuiteBase =  
    interface 
        interface ITestObject<int>
        interface IIdentifiable<int>
        interface IPropertyOwner 
        interface IDataErrorInfo 
        interface INotifyPropertyChanged 
    end
public interface ITestSuiteBase extends ITestObject<int>, IIdentifiable<int>, IPropertyOwner, IDataErrorInfo, INotifyPropertyChanged

The ITestSuiteBase type exposes the following members.

Properties

  Name Description
Public property AllTestCases Gets the read-only collection of test cases for this suite and all hierarchical children.
Public property DefaultConfigurations Gets the read-only list of default configurations.
Public property Description Gets or sets the description of this test suite.
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 IsRoot Gets a value that indicates whether this suite is the root suite in the test project.
Public property Item Gets the error message for the property with the given name. (Inherited from IDataErrorInfo.)
Public property LastUpdated Gets the date and time that this test suite was last updated.
Public property LastUpdatedBy Gets the identity of the person who last updated this test suite.
Public property LastUpdatedByName Last person to update suite
Public property Parent Gets the parent test suite that contains this test suite.
Public property Plan Gets the test plan that owns this test suite.
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 State Gets or sets the state of this test suite.
Public property TestCaseCount
Public property TestCases Gets a read-only collection of test cases.
Public property TestSuiteEntry Gets an entry that was created for use in a static test suite.
Public property TestSuiteType Gets the type of this test suite.
Public property Title Gets or sets the title of this test suite.
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 AssignTestPoints Changes the AssignedTo property by using the provided collection of test point assignments.
Public method ClearDefaultConfigurations Removes the list of default configurations from this suite. This causes this suite to inherit default configurations from its parent.
Public method CreateTestPointAssignment(Int32, IdAndName, TeamFoundationIdentity) Creates an ITestPointAssignment object to be passed into ITestSuiteBase.AssignTestPoints
Public method CreateTestPointAssignment(Int32, IdAndName, Guid) Creates a TestPointAssignment object for later use in AssignTestPoints()
Public method Refresh() Updates any suites in the suite hierarchy that are out of date.
Public method Refresh(Boolean) Updates any suites in the suite hierarchy, optionally forcing the update whether or not they are out of date.
Public method SetDefaultConfigurations Specifies a set of configurations to use with newly added suite entries. When entries are added, test points are created for each of these configurations.
Public method SetEntryConfigurations Creates and deletes the necessary test points to make its set of configurations passed in for each entry.

Top

Events

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

Top

Remarks

Test suites that are built on queries can use IDynamicTestSuiteBase. Test suites that are built on an explicit list of test case IDs can use IStaticTestSuite. Test suites that are built on a specific requirement can use IRequirementTestSuite.

See Also

Reference

Microsoft.TeamFoundation.TestManagement.Client Namespace

IRequirementTestSuite

IDynamicTestSuiteBase

IStaticTestSuite

ITestObject<T>

IIdentifiable<TKey>

IDataErrorInfo

IPropertyOwner

INotifyPropertyChanged