CatalogWebService Class

Article
09/28/2012

Inheritance Hierarchy

System.Object
  System.ComponentModel.MarshalByValueComponent
    System.Web.Services.WebService
      Microsoft.TeamFoundation.Framework.Server.WebServices.TeamFoundationWebService
        Microsoft.TeamFoundation.Framework.Server.WebServices.FrameworkWebService
          Microsoft.TeamFoundation.Framework.Server.WebServices.CatalogWebService

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

Syntax

'Declaration
<WebServiceAttribute(Namespace := "https://microsoft.com/webservices/")> _
<ClientServiceAttribute(ComponentName := "Framework", ServiceName := "CatalogService",  _
    ServerConfiguration := ServerConfiguration.TfsConfigurationServer, ConfigurationServiceIdentifier := "C2F9106F-127A-45B7-B0A3-E0AD8239A2A7")> _
Public Class CatalogWebService _
    Inherits FrameworkWebService

[WebServiceAttribute(Namespace = "https://microsoft.com/webservices/")]
[ClientServiceAttribute(ComponentName = "Framework", ServiceName = "CatalogService", 
    ServerConfiguration = ServerConfiguration.TfsConfigurationServer, ConfigurationServiceIdentifier = "C2F9106F-127A-45B7-B0A3-E0AD8239A2A7")]
public class CatalogWebService : FrameworkWebService

[WebServiceAttribute(Namespace = L"https://microsoft.com/webservices/")]
[ClientServiceAttribute(ComponentName = L"Framework", ServiceName = L"CatalogService", 
    ServerConfiguration = ServerConfiguration::TfsConfigurationServer, ConfigurationServiceIdentifier = L"C2F9106F-127A-45B7-B0A3-E0AD8239A2A7")]
public ref class CatalogWebService : public FrameworkWebService

[<WebServiceAttribute(Namespace = "https://microsoft.com/webservices/")>]
[<ClientServiceAttribute(ComponentName = "Framework", ServiceName = "CatalogService", 
    ServerConfiguration = ServerConfiguration.TfsConfigurationServer, 
    ConfigurationServiceIdentifier = "C2F9106F-127A-45B7-B0A3-E0AD8239A2A7")>]
type CatalogWebService =  
    class 
        inherit FrameworkWebService 
    end

public class CatalogWebService extends FrameworkWebService

The CatalogWebService type exposes the following members.

Constructors

	Name	Description
	CatalogWebService

Top

Properties

	Name	Description
	Application	Gets the application object for the current HTTP request. (Inherited from WebService.)
	Container	Gets the container for the component. (Inherited from MarshalByValueComponent.)
	Context	Gets the ASP.NET HttpContext for the current request, which encapsulates all HTTP-specific context used by the HTTP server to process Web requests. (Inherited from WebService.)
	DesignMode	Gets a value indicating whether the component is currently in design mode. (Inherited from MarshalByValueComponent.)
	Events	Gets the list of event handlers that are attached to this component. (Inherited from MarshalByValueComponent.)
	RequestContext	The RequestContext associated with this Web service request. (Inherited from TeamFoundationWebService.)
	Server	Gets the HttpServerUtility for the current request. (Inherited from WebService.)
	Session	Gets the HttpSessionState instance for the current request. (Inherited from WebService.)
	Site	Gets or sets the site of the component. (Inherited from MarshalByValueComponent.)
	SoapVersion	Gets the version of the SOAP protocol used to make the SOAP request to the XML Web service. (Inherited from WebService.)
	User	Gets the ASP.NET server User object. Can be used to authenticate whether a user is authorized to execute the request. (Inherited from WebService.)

Top

Methods

	Name	Description
	AddWebServiceResource	Adds IDisposable resources used by Web Service methods which should be disposed at the end of the request (Inherited from TeamFoundationWebService.)
	Dispose()	Releases all resources used by the MarshalByValueComponent. (Inherited from MarshalByValueComponent.)
	Dispose(Boolean)	Releases the unmanaged resources used by the MarshalByValueComponent and optionally releases the managed resources. (Inherited from MarshalByValueComponent.)
	EnterMethod	EnterMethod is used to note the start of the WebMethod execution. (Inherited from TeamFoundationWebService.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from MarshalByValueComponent.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetService	Gets the implementer of the IServiceProvider. (Inherited from MarshalByValueComponent.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	HandleException	This basic WebService ExceptionHandler captures the exception and records it in the request Context for future logging. Services may decide to over-ride this method, perform some actions based on the exception, changing the exception, eating it or just letting it pass. (Inherited from TeamFoundationWebService.)
	LeaveMethod	LeaveMethod should be called as the last block of code in the execution of the WebMethod's scope. (Inherited from TeamFoundationWebService.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	QueryDependents	Returns all of the nodes that depend on the node's existence.
	QueryNodes	Returns the catalog nodes that exist under the parentPath and have a type that is listed in resourceTypeFilters.
	QueryParents	Returns the nodes for the resource provided, in addition to 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 without filters and recursing to the root would yield TP1, TPC1, PG2 and PG1.
	QueryResources	Returns the resource that is associated with the identifier.
	QueryResourcesByType	Returns all of the catalog resources of the provided types.
	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.
	SaveCatalogChanges	Saves the changes associated with the objects.
	ToString	Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from MarshalByValueComponent.)

Top

Events

	Name	Description
	Disposed	Adds an event handler to listen to the Disposed event on the component. (Inherited from MarshalByValueComponent.)

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.