This documentation is archived and is not being maintained.

Microsoft.SharePoint.Dsp Namespace

Windows SharePoint Services 3

Provides the base class for the data retrieval service adapters used in Microsoft Windows SharePoint Services.

The adapters define a protocol for data consumers to query heterogeneous data sources and for the data sources to return query results back to the consumers, integrating different types of data into a unified format so that they can be related, analyzed, and manipulated easily.

Each data retrieval service provides a data-binding scheme that enables data consumers and data servers to communicate with each other through SOAP or the object model of Windows SharePoint Services. The client side of the data retrieval services consists of data consumers such as applications, data-driven Web Parts, or data-bound server controls. The server side of the data retrieval services is a group of adapters, which are Web services that return XML data from different data sources or that perform data-manipulation operations in those data sources. The following adapters are used in Windows SharePoint Services:

The Microsoft.SharePoint.Dsp.Sts namespace has both an object model and a SOAP interface, while the other three namespaces have only an object model.

The adapters provide an object model that can be used by other Microsoft .NET Framework managed assemblies. Server components can load the assembly of a service directly, eliminating the overhead of calling the service through SOAP. All adapters implement the IDspAdapter interface of the Microsoft.SharePoint.Dsp namespace, and by dynamically loading the data retrieval service assemblies, the same client code can be written to talk to any of the adapters.

Public classAllFieldsUsed in a query to specify that all the fields be returned from the data source.
Public classAuthenticationThe Authentication class represents the authentication mode that is used to connect to the back-end server.
Public classConnectionRepresents a connection to a data retrieval service adapter.
Public classDataRootRepresents the root of the content document for a particular adapter instance.
Public classDspAdapterImplements the IDspAdapter interface for use by the OleDbAdapter class in performing queries against OLE DB data sources.
Public classDspQueryDefines the filter used in a query against a data source provider.
Public classDSQueryRepresents a query used by a data retrieval service.
Public classFieldRepresents a single column in a query.
Public classFieldsRepresents the collection of columns that are included in a query.
Public classOrderFieldRepresents the column by which the result is ordered.
Public classPTQueryRepresents a pass-through query.
Public classQueryRequestRepresents the request in a query.
Public classQueryResponseRepresents the response in a query.
Public classRequestRepresents the request header in a query, containing information about the operation type and the document type of the query.
Public classRequestHeaderRepresents the request header in a query.
Public classResponseRepresents the response in a query.
Public classServerParameterRepresents a server parameter required by the server containing the data source.
Public classServerParameterInfoRepresents information about the parameters used by the server containing the data source.
Public classVersionsRepresents the versions of the data retrieval service that are supported by an adapter or the versions being used in a query.

Public interfaceIDspAdapterProvides a COM interface for clients to access a data retrieval service adapter locally.

Public enumerationColumnMappingTypeIndicates the type of XML format used for data returned in a query.
Public enumerationDocumentTypeSpecifies the document type for a request.
Public enumerationMethodTypeSpecifies the action of the request.
Public enumerationOrderDirectionThe OrderDirection enumeration specifies the direction in which a field or column is sorted.
Public enumerationPagingSupportTypeIndicates the type of paging that is supported for a query.
Public enumerationQueryTypeSpecifies a type of query that is used in a request.
Public enumerationResponseStatusSpecifies the status of a query response.
Public enumerationResultContentTypeIndicates the type of content that is returned through a query.