com.microsoft.tfs.core.clients.framework.catalog
Class CatalogWebServiceProxy

java.lang.Object
  extended by com.microsoft.tfs.core.clients.framework.catalog.CatalogWebServiceProxy

public class CatalogWebServiceProxy
extends java.lang.Object

A proxy class for the TFS catalog web service.

Since:
TEE-SDK-10.1

Constructor Summary
CatalogWebServiceProxy(TFSConfigurationServer server)
          Constructor
 
Method Summary
 CatalogData queryDependents(java.lang.String path, int queryOptions)
          Returns all of the nodes that depend on the nodes existence.
 CatalogData queryNodes(java.lang.String[] pathSpecs, com.microsoft.tfs.util.GUID[] resourceTypeFilters, CatalogResourceProperty[] propertyFilters, int queryOptions)
          Return the CatalogData which contains resources and nodes which match the specified filters.
 CatalogData queryParents(com.microsoft.tfs.util.GUID resourceIdentifier, java.lang.String[] pathFilters, com.microsoft.tfs.util.GUID[] resourceTypeFilters, boolean recurseToRoot, int queryOptions)
          Returns the nodes for the resource provided as well as the parents.
 CatalogData queryResources(com.microsoft.tfs.util.GUID[] resourceTypeFilters, int queryOptions)
          Return the CatalogData which contains resources and nodes which match the specified filters.
 CatalogData queryResourcesByType(com.microsoft.tfs.util.GUID[] resourceTypeFilters, CatalogResourceProperty[] propertyFilters, int queryOptions)
          Returns all of the catalog resources of the provided type.
 CatalogResourceType[] queryResourceTypes(com.microsoft.tfs.util.GUID[] resourceTypeIdentifiers)
          Retrieve resource type objects for the specified resource type identifiers.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CatalogWebServiceProxy

public CatalogWebServiceProxy(TFSConfigurationServer server)
Constructor

Method Detail

queryResourceTypes

public CatalogResourceType[] queryResourceTypes(com.microsoft.tfs.util.GUID[] resourceTypeIdentifiers)
Retrieve resource type objects for the specified resource type identifiers.

Parameters:
resourceTypeIdentifiers - Identifies the resource types that should be returned. Use null or an empty array to retrieve all resource types.
Returns:
The set of resource types matching the specified filter.

queryNodes

public CatalogData queryNodes(java.lang.String[] pathSpecs,
                              com.microsoft.tfs.util.GUID[] resourceTypeFilters,
                              CatalogResourceProperty[] propertyFilters,
                              int queryOptions)
Return the CatalogData which contains resources and nodes which match the specified filters.

Parameters:
pathSpecs - The paths of the element or elements that are being searched for. This path can contain the wildcards "*", "**" and "..." where "*" means one-level and "**" and "..." means any number of levels.
resourceTypeFilters - The list of types that this query should include. If this is null or empty, all types will be included.
propertyFilters - The set of property filters to apply to the resource found. Matches will be based on both the key and the value of the property matching. If the value of a certain filter is null or empty then it will be assumed that all resource with the supplied property should be returned. A match consists of a resource that matches all of the propertyFilters
queryOptions - If ExpandDependencies is specified, the Dependencies property on nodes will contain the nodes they are dependent on. If IncludeParents is specified, the ParentNode property on the CatalogNode will contain the parent node. Leaving a given option will result in the returned catalog nodes to have null for that value. Extra data should only be retrieved if it is needed since computing and sending information can be expensive.
Returns:
The resulting set of matching nodes and resources contained within a CatalogData object.

queryResources

public CatalogData queryResources(com.microsoft.tfs.util.GUID[] resourceTypeFilters,
                                  int queryOptions)
Return the CatalogData which contains resources and nodes which match the specified filters.

Parameters:
resourceTypeFilters - The list of types that this query should include. If this is null or empty, all types will be included.
queryOptions - If ExpandDependencies is specified, the Dependencies property on nodes will contain the nodes they are dependent on. If IncludeParents is specified, the ParentNode property on the CatalogNode will contain the parent node. Leaving a given option will result in the returned catalog nodes to have null for that value. Extra data should only be retrieved if it is needed since computing and sending information can be expensive.
Returns:
The resulting set of matching nodes and resources contained within a CatalogData object.

queryResourcesByType

public CatalogData queryResourcesByType(com.microsoft.tfs.util.GUID[] resourceTypeFilters,
                                        CatalogResourceProperty[] propertyFilters,
                                        int queryOptions)
Returns all of the catalog resources of the provided type. If GUID.EMPTY is passed in, all resources are returned.

Parameters:
resourceTypeFilters - The list of types that this query should include. If this is null or empty, all types will be included.
propertyFilters - The set of property filters to apply to the resource found. Matches will be based on both the key and the value of the property matching. If the value of a certain filter is null or empty then it will be assumed that all resource with the supplied property should be returned. A match consists of a resource that matches all of the propertyFilters
queryOptions - If ExpandDependencies is specified, the Dependencies property on nodes will contain the nodes they are dependent on. If IncludeParents is specified, the ParentNode property on the CatalogNode will contain the parent node. Leaving a given option will result in the returned catalog nodes to have null for that value. Extra data should only be retrieved if it is needed since computing and sending information can be expensive.
Returns:
The resulting set of matching nodes and resources contained within a CatalogData object.

queryDependents

public CatalogData queryDependents(java.lang.String path,
                                   int queryOptions)
Returns all of the nodes that depend on the nodes existence.

Parameters:
path - The path whose dependents are being queried.
queryOptions - If ExpandDependencies is specified, the Dependencies property on nodes will contain the nodes they are dependent on. If IncludeParents is specified, the ParentNode property on the CatalogNode will contain the parent node. Leaving a given option will result in the returned catalog nodes to have null for that value. Extra data should only be retrieved if it is needed since computing and sending information can be expensive.
Returns:
The resulting set of dependents contained within a CatalogData object.

queryParents

public CatalogData queryParents(com.microsoft.tfs.util.GUID resourceIdentifier,
                                java.lang.String[] pathFilters,
                                com.microsoft.tfs.util.GUID[] resourceTypeFilters,
                                boolean recurseToRoot,
                                int queryOptions)
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.

Parameters:
resourceIdentifier - The identifier for the resource who's parents are being queried. The resource and its nodes will only be returned if they are not filtered out.
pathFilters - Nodes will only be returned if they live under one of the paths provided here. If this value is null or empty it will be assumed that parents from all places within the tree are valid.
resourceTypeFilters - The list of types that this query should include. If this is null or empty, all types will be included.
recurseToRoot - If this is true then parent nodes will be enumerated all the way to the root. If this is false then only the first level of parents will be returned.
queryOptions - If ExpandDependencies is specified, the Dependencies property on nodes will contain the nodes they are dependent on. If IncludeParents is specified, the ParentNode property on the CatalogNode will contain the parent node. Leaving a given option will result in the returned catalog nodes to have null for that value. Extra data should only be retrieved if it is needed since computing and sending information can be expensive.
Returns:
The resulting set of matching nodes and resources contained within a CatalogData object.


© 2015 Microsoft. All rights reserved.