ICatalogService Interface
Namespace: Microsoft.TeamFoundation.Framework.Client
Assembly: Microsoft.TeamFoundation.Client (in Microsoft.TeamFoundation.Client.dll)
Syntax
'Declaration
Public Interface ICatalogService
public interface ICatalogService
public interface class ICatalogService
type ICatalogService = interface end
public interface ICatalogService
The ICatalogService type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
LocationService | Returns the location service that this catalog uses for its service definition references |
|
RootNodes | Returns the root nodes in the tree. |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
CreateChangeContext | Creates a change context in which many changes can be batched together. |
|
QueryNodes(IEnumerable<String>, IEnumerable<Guid>, CatalogQueryOptions) | Returns the catalog nodes that exist below the parentPath and have a type that is listed in resourceTypeFilters. |
|
QueryNodes(IEnumerable<String>, IEnumerable<Guid>, IEnumerable<KeyValuePair<String, String>>, CatalogQueryOptions) | Returns the catalog nodes that exist below the parentPath and have a type that is listed in resourceTypeFilters. |
|
QueryParents | Returns the nodes for the resource provided as well as the parents. The direct nodes and the parent nodes will not be returned if they are filtered out. For the following tree: PG1 / \ PG2 PG3 / \ \ TPC1 TPC2 TPC3 / \ TP1 TP2 Query for TP1's identifier with no filters and recursing to the root would yeild TP1, TPC1, PG2 and PG1. |
|
QueryResources(IEnumerable<Guid>, CatalogQueryOptions) | Returns the resource that is associated with the identifier. |
|
QueryResources(IEnumerable<Guid>, IEnumerable<KeyValuePair<String, String>>, CatalogQueryOptions) | Retuns all of the catalog resources of the prvodied type. If Guid.Empty is passed in, all resources are returned. |
|
QueryResourcesByType | Retuns all of the catalog resources of the prvodied type. If Guid.Empty is passed in, all resources are returned. |
|
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. |
|
QueryRootNode | Returns the specified root node. Well-known root paths can be found in Microsoft.TeamFoundation.Framework.Common.Catalog.CatalogTree. |
|
QueryUpTree | Queries "up" the tree from the provided path looking for the provided types in its parent nodes' children. If the path is "TFSInstance1/PG1/TPC1/TP1" this query will be translated into a series of QueryNodes calls that have the following pathSpecs: "TFSInstance1/*" "TFSInstance1/PG1/*" "TFSInstance1/PG1/TPC1/*" An example of when this could be used is when a ReportingSite is being added to a node and it must find the ReportServer that is a child of one of its parent nodes. |
|
SaveDelete | Deletes this node from the catalog. If this node is the only node that points to the resource it points to then this resource will also be deleted. If this node exists in the infrastructure tree then the resource that is associated with this node will also be deleted and it will be inherently recursive. |
|
SaveMove | Adds this move to the change context. It will be sent to the server when Save() is called. Note that if nodeToMove or newParent also have updated properties then those will be committed as well. Any node that is explicitly moved will have IsDefault set to 0. |
|
SaveNode | Saves the updated node and its resource in the catalog. |
|
SaveResource | Saves the updated resource in the catalog. Note that service definitions that exist as service references will be created if they are new and updated if they are not. |
Top