com.plumtree.server
Interface IPTDataSourceProviderRegistry

public interface IPTDataSourceProviderRegistry

Version:

$Revision$

Author:

Mike Sample

Method Summary

IPTQueryResult	GetCommonFields(java.lang.String bstrDataSourceProviderCLSID) Retrieve the common fields and descriptions for a particular Data Source Provider
IPTQueryResult	GetDocumentTypeMapSections() Returns the set of sections in the Document Type Map
java.lang.Object[][]	GetDocumentTypeMapSuggestedIdentifiers(int lSectionID) Returns a list of suggested Document Type mappings for this provider.
IPTQueryResult	GetProviderInfo(java.lang.String bstrDataSourceProviderCLSID) Get information about a particular Provider.
IPTQueryResult	GetRegisteredCrawlingProviders() Returns a list of registered crawl providers
IPTQueryResult	GetRegisteredProviders() Returns a list of registered providers
void	Register(IPTDataSourceProvider pDataSourceProvider) Used to register new Data Source Providers (currently not used)
void	UnRegister(java.lang.String bstrDataSourceProviderCLSID) Used to unregister existing Data Source Providers (currently not used)

Method Detail

Register

void Register(IPTDataSourceProvider pDataSourceProvider)

Used to register new Data Source Providers (currently not used)

Parameters:

pDataSourceProvider - an interface to the new Data Source Provider

UnRegister

void UnRegister(java.lang.String bstrDataSourceProviderCLSID)

Used to unregister existing Data Source Providers (currently not used)

Parameters:

pDataSourceProvider - an interface to the new Data Source Provider

GetCommonFields

IPTQueryResult GetCommonFields(java.lang.String bstrDataSourceProviderCLSID)

Retrieve the common fields and descriptions for a particular Data Source Provider

Parameters:

bstrDataSourceProviderCLSID - unique String code identifying the provider

Returns:

a query result containing the common fields for the given provider

GetProviderInfo

IPTQueryResult GetProviderInfo(java.lang.String bstrDataSourceProviderCLSID)

Get information about a particular Provider.

Parameters:

bstrDataSourceProviderCLSID - unique String code identifying the provider

Returns:

a query result containing provider information describing the given provider

GetRegisteredProviders

IPTQueryResult GetRegisteredProviders()

Returns a list of registered providers

Returns:

a query result identifying registered providers

GetRegisteredCrawlingProviders

IPTQueryResult GetRegisteredCrawlingProviders()

Returns a list of registered crawl providers

Returns:

a query result identifying registered providers that implement IPTDataSourceCrawlProvider

GetDocumentTypeMapSuggestedIdentifiers

java.lang.Object[][] GetDocumentTypeMapSuggestedIdentifiers(int lSectionID)

Returns a list of suggested Document Type mappings for this provider.

Parameters:

lSectionID - The section ID of the Document Type Map requested

Returns:

An array of extension to Document Type mappings

GetDocumentTypeMapSections

IPTQueryResult GetDocumentTypeMapSections()

Returns the set of sections in the Document Type Map

Returns:

An IPTQueryResult containing all Document Type Map sections