com.plumtree.server
Interface IPTFederatedSearch

All Superinterfaces:

IPTUnknown

public interface IPTFederatedSearch
extends IPTUnknown

Federated Searches are used to access data on remote Federated Portals. A single Federated Search can execute searches against multiple Federated Portals concurrently.

Author:

michaels

See Also:

IPTFederatedPortal

Method Summary

void	Add(int lFederatedPortalID) Adds a Federated Portal to the search targets for this search.
void	ExecuteSimpleSearch(java.lang.String bstrSearchString, int nSkip, int nMax) Perform the specified search against all Federated Portals that were added with the Add call.
java.lang.String	GetLastError(int lFederatedPortalID) If a call to GetSearchResult returns null (indicating an error), call this method to get a description of the error.
int	GetLastErrorCode(int lFederatedPortalID) If a call to GetSearchResult returns null (indicating an error), call this method to get the error number associated with the error.
IPTSearchResponse	GetSearchResult(int lFederatedPortalID, java.lang.Object vAppData) Get an IPTSearchResponse that encapsulates the results of a search for a particular FederatedPortal.
void	SetApplicationDataState(IPTState Value) The Application Data State must be set before this Federated Search can be used.

Methods inherited from interface com.plumtree.server.IPTUnknown

GetInterfaces

Method Detail

Add

void Add(int lFederatedPortalID)

Adds a Federated Portal to the search targets for this search. When the search is performed, all Federated Portals that have been added will be searched in parallel.

Parameters:

lFederatedPortalID - the Object ID of the Federated Portal to be searched.

ExecuteSimpleSearch

void ExecuteSimpleSearch(java.lang.String bstrSearchString,
                         int nSkip,
                         int nMax)

Perform the specified search against all Federated Portals that were added with the Add call.

Parameters:

bstrSearchString - the search string, which is passed to the Federated Portals

nSkip - the number of results to skip. This is used for pagination (e. g. to show results 101-200, this value would be 101.)

nMax - the number of results to return. This is used for pagination (e. g. to show results 101-200, this value would be 100.)

GetSearchResult

IPTSearchResponse GetSearchResult(int lFederatedPortalID,
                                  java.lang.Object vAppData)

Get an IPTSearchResponse that encapsulates the results of a search for a particular FederatedPortal. You must call ExecuteSimpleSearch before calling GetSearchResult.

Parameters:

lFederatedPortalID - the ID of the Federated Portal for which results are desired

vAppData - An IPTState that is used for storing and retreiving search data

Returns:

the IPTSearchResponse object corresponding to the results, or null on error

See Also:

IPTSearchResponse

GetLastError

java.lang.String GetLastError(int lFederatedPortalID)

If a call to GetSearchResult returns null (indicating an error), call this method to get a description of the error.

Parameters:

lFederatedPortalID - the ID of the Federated Portal for which searching failed

Returns:

a string describing the error

SetApplicationDataState

void SetApplicationDataState(IPTState Value)

The Application Data State must be set before this Federated Search can be used. Generally, it will be set by the call to IPTFederatedPortalManager.OpenFederatedSearch, and does not need to be set explicitly on the Federated Search object

Parameters:

Value - An IPTState object holding the Application State, used for storing and retreiving search data

See Also:

IPTFederatedPortalManager

GetLastErrorCode

int GetLastErrorCode(int lFederatedPortalID)

If a call to GetSearchResult returns null (indicating an error), call this method to get the error number associated with the error.

Parameters:

lFederatedPortalID - the ID of the Federated Portal for which searching failed

Returns:

an error number associated with the error