|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IPTFederatedSearch
Federated Searches are used to access data on remote Federated Portals. A single Federated Search can execute searches against multiple Federated Portals concurrently.
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 |
---|
void Add(int lFederatedPortalID)
lFederatedPortalID
- the Object ID of the Federated Portal to be
searched.void ExecuteSimpleSearch(java.lang.String bstrSearchString, int nSkip, int nMax)
bstrSearchString
- the search string, which is passed to the
Federated PortalsnSkip
- 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.)IPTSearchResponse GetSearchResult(int lFederatedPortalID, java.lang.Object vAppData)
lFederatedPortalID
- the ID of the Federated Portal for which
results are desiredvAppData
- An IPTState that is used for storing and retreiving search data
IPTSearchResponse
java.lang.String GetLastError(int lFederatedPortalID)
lFederatedPortalID
- the ID of the Federated Portal for which
searching failed
void SetApplicationDataState(IPTState Value)
Value
- An IPTState object holding the Application State, used for storing and retreiving search dataIPTFederatedPortalManager
int GetLastErrorCode(int lFederatedPortalID)
lFederatedPortalID
- the ID of the Federated Portal for which
searching failed
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |