com.plumtree.server
Interface IPTFederatedSearchProvider

All Superinterfaces:
IPTUnknown

public interface IPTFederatedSearchProvider
extends IPTUnknown

An IPTFederatedSearchProvider is an external component that knows how to perform searches in external systems and return search results to Plumtree

See Also:
IPTFederatedSearch

Method Summary
 IPTSearchResponse FinishSimpleFederatedSearch(java.lang.String bstrRequestStateStorageName, com.plumtree.openfoundation.util.IXPPropertyBag pWebServiceSettings, int lWebServiceID, java.lang.Object vAppData, IPTState pRequestState, java.lang.Object pbstrErrorMessage)
          Retrieves the search results
 java.lang.Object GetCapabilities(int lFederatedPortalCapability)
          Query this Provider to find it's capabilities
 java.lang.String GetDescription()
          Returns a description of this Provider
 java.lang.String GetFederatedSearchProviderCLSID()
          Returns the CLSID associated with this Provider
 java.lang.String GetImageUUID()
          Returns the UUID for the image that's used to represent this Provider in the UI
 java.lang.String GetName()
          Returns the name of this Provider
 void Initialize(IPTSession pSession, com.plumtree.openfoundation.util.IXPPropertyBag pbagConfigurationInfo, IPTWebService pWebService, int lFederatedPortalID, java.lang.String bstrThisPortalIdentity)
          Initialize the Provider before making other stateful calls on it.
 void StartSimpleFederatedSearch(IPTSession pSession, java.lang.String sSearchString, java.lang.String sRequestingUser, java.lang.String sRequestingPortal, java.lang.String sRequestStateStorageName, IPTState pRequestState, java.lang.Object pRequestChain, int nSkip, int nMax)
          Initializes a federated search on this object
 
Methods inherited from interface com.plumtree.server.IPTUnknown
GetInterfaces
 

Method Detail

StartSimpleFederatedSearch

public void StartSimpleFederatedSearch(IPTSession pSession,
                                       java.lang.String sSearchString,
                                       java.lang.String sRequestingUser,
                                       java.lang.String sRequestingPortal,
                                       java.lang.String sRequestStateStorageName,
                                       IPTState pRequestState,
                                       java.lang.Object pRequestChain,
                                       int nSkip,
                                       int nMax)
Initializes a federated search on this object
Parameters:
pSession - the Plumtree session of the current user
sSearchString - the search string to pass to the remote search server
sRequestingUser - the name of the requesting user
sRequestingPortal - the name of the requesting portal
sRequestStateStorageName - the name of the items in the state object that are related to this search
pRequestState - the state object
pRequestChain - the WebDownloaderParallel request chain on which to place this request
nSkip - number of rows to skip at the beginning, or 0 for none
nMax - maximum number of rows to return, or -1 for all

FinishSimpleFederatedSearch

public IPTSearchResponse FinishSimpleFederatedSearch(java.lang.String bstrRequestStateStorageName,
                                                     com.plumtree.openfoundation.util.IXPPropertyBag pWebServiceSettings,
                                                     int lWebServiceID,
                                                     java.lang.Object vAppData,
                                                     IPTState pRequestState,
                                                     java.lang.Object pbstrErrorMessage)
Retrieves the search results
Parameters:
bstrRequestStateStorageName - the name of the items in the state object that are related to this search
pWebServiceSettings - the settings for the Web Service for this search
lWebServiceID - the ID of the Web Service for this search
vAppData - persistent application data for this search
pRequestState - the request state for this user
pbstrErrorMessage - the error message for this search
Returns:
the IPTSearchResponse for this search

GetCapabilities

public java.lang.Object GetCapabilities(int lFederatedPortalCapability)
Query this Provider to find it's capabilities
Parameters:
lFederatedPortalCapability - a value from PT_FEDERATEDPORTALPROVIDER_CAPABILITIES
Returns:
the value of the capability

GetName

public java.lang.String GetName()
Returns the name of this Provider
Returns:
the name

GetDescription

public java.lang.String GetDescription()
Returns a description of this Provider
Returns:
the description

GetFederatedSearchProviderCLSID

public java.lang.String GetFederatedSearchProviderCLSID()
Returns the CLSID associated with this Provider
Returns:
the CLSID

GetImageUUID

public java.lang.String GetImageUUID()
Returns the UUID for the image that's used to represent this Provider in the UI
Returns:
the image UUID

Initialize

public void Initialize(IPTSession pSession,
                       com.plumtree.openfoundation.util.IXPPropertyBag pbagConfigurationInfo,
                       IPTWebService pWebService,
                       int lFederatedPortalID,
                       java.lang.String bstrThisPortalIdentity)
Initialize the Provider before making other stateful calls on it.
Parameters:
pSession - the user session of the current user
pbagConfigurationInfo - configuration info for this Provider
pWebService - the Web Service associated with this Provider
lFederatedPortalID - the ID of the Federated Portal associated with this Provider
bstrThisPortalIdentity - a string uniquely identifying this Portal


Copyright © 2003 Plumtree Software Inc. All Rights Reserved.