TeamFoundationCatalogService Class

  • Article

Inheritance Hierarchy

System.Object
  Microsoft.TeamFoundation.Framework.Server.TeamFoundationCatalogService

Namespace:  Microsoft.TeamFoundation.Framework.Server
Assembly:  Microsoft.TeamFoundation.Framework.Server (in Microsoft.TeamFoundation.Framework.Server.dll)

Syntax

'Declaration
<TeamFoundationServiceDependency(GetType(TeamFoundationSecurityService))> _
<TeamFoundationServiceDependency(GetType(TeamFoundationSqlNotificationService))> _
Public NotInheritable Class TeamFoundationCatalogService _
    Implements ITeamFoundationService, IDisposable

[TeamFoundationServiceDependency(typeof(TeamFoundationSecurityService))]
[TeamFoundationServiceDependency(typeof(TeamFoundationSqlNotificationService))]
public sealed class TeamFoundationCatalogService : ITeamFoundationService, 
    IDisposable

[TeamFoundationServiceDependency(typeof(TeamFoundationSecurityService))]
[TeamFoundationServiceDependency(typeof(TeamFoundationSqlNotificationService))]
public ref class TeamFoundationCatalogService sealed : ITeamFoundationService, 
    IDisposable

[<Sealed>]
[<TeamFoundationServiceDependency(typeof(TeamFoundationSecurityService))>]
[<TeamFoundationServiceDependency(typeof(TeamFoundationSqlNotificationService))>]
type TeamFoundationCatalogService =  
    class 
        interface ITeamFoundationService 
        interface IDisposable 
    end

public final class TeamFoundationCatalogService implements ITeamFoundationService, IDisposable

The TeamFoundationCatalogService type exposes the following members.

Methods

  Name Description
Public method CreateTransactionContext Creates a transaction context to make changes in.
Public method DeleteEntireCatalog
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method QueryCatalogDependents Returns all of the nodes that depend on the nodes' existence.
Public method QueryNodes(TeamFoundationRequestContext, String, Guid) Returns the catalog nodes that exist under the [pathSpec] and have a type that is listed in [resourceTypeFilter].See overloads for more information and more options.
Public method QueryNodes(TeamFoundationRequestContext, IEnumerable<String>, IEnumerable<Guid>, CatalogQueryOptions) Returns the catalog nodes that exist under the [parentPath] and have a type that is listed in [resourceTypeFilters].
Public method QueryNodes(TeamFoundationRequestContext, String, Guid, IEnumerable<KeyValuePair<String, String>>)
Public method QueryNodes(TeamFoundationRequestContext, IEnumerable<String>, IEnumerable<Guid>, IEnumerable<KeyValuePair<String, String>>, CatalogQueryOptions) Returns the catalog nodes that exist under the [parentPath] and have a type that is listed in [resourceTypeFilters].
Public method QueryNodes(TeamFoundationRequestContext, String, Guid, IEnumerable<KeyValuePair<String, String>>, CatalogQueryOptions)
Public method QueryParents Returns the nodes for the resource that is provided and also for the parents.The direct nodes and the parent nodes will not be returned if they are filtered out. For the tree, PG1 / \ PG2 PG3 / \ \ TPC1 TPC2 TPC3 / \ TP1 TP2, querying for TP1's identifier without filters and recursing to the root would yield TP1, TPC1, PG2 and PG1.
Public method QueryResources(TeamFoundationRequestContext, IEnumerable<Guid>, CatalogQueryOptions) Returns the resource that is associated with the identifier.
Public method QueryResources(TeamFoundationRequestContext, IEnumerable<Guid>, IEnumerable<KeyValuePair<String, String>>, CatalogQueryOptions) Returns all of the catalog resources for the provided types.
Public method QueryResourcesByType Returns all of the catalog resources for the provided types.
Public method QueryResourceType Returns the resource type for the specified identifier.
Public method QueryResourceTypes Returns the resource types for all of the specified identifiers.If null or an empty list is passed in, all resource types will be returned.
Public method QueryRootNode Returns the specified root node. Well-known root paths can be found in [Microsoft.TeamFoundation.Framework.Common.Catalog.CatalogTree].
Public method QueryRootNodes Returns the root nodes in the tree.
Public method SaveTransactionContextChanges Saves the changes associated with the transaction context after it performs permission checks on them.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IDisposable.Dispose Dispose - do not call directly!
Explicit interface implemetationPrivate method ITeamFoundationService.ServiceEnd Clean up and resources.
Explicit interface implemetationPrivate method ITeamFoundationService.ServiceStart Initialize the class.

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.TeamFoundation.Framework.Server Namespace