|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IPTFederatedSearchProvider
An IPTFederatedSearchProvider is an external component that knows how to perform searches in external systems and return search results to Plumtree
IPTFederatedSearch
Method Summary | |
---|---|
IPTSearchResponse |
FinishSimpleFederatedSearch(java.lang.String bstrRequestStateStorageName,
com.plumtree.openfoundation.util.IXPPropertyBag pWebServiceSettings,
int lWebServiceID,
java.lang.Object vAppData,
IPTState pRequestState,
com.plumtree.openfoundation.util.XPStringBuilder 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 |
---|
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)
pSession
- the Plumtree session of the current usersSearchString
- the search string to pass to the remote search
serversRequestingUser
- the name of the requesting usersRequestingPortal
- the name of the requesting portalsRequestStateStorageName
- the name of the items in the state
object that are related to this searchpRequestState
- the state objectpRequestChain
- the WebDownloaderParallel request chain on which to
place this requestnSkip
- number of rows to skip at the beginning, or 0 for nonenMax
- maximum number of rows to return, or -1 for allIPTSearchResponse FinishSimpleFederatedSearch(java.lang.String bstrRequestStateStorageName, com.plumtree.openfoundation.util.IXPPropertyBag pWebServiceSettings, int lWebServiceID, java.lang.Object vAppData, IPTState pRequestState, com.plumtree.openfoundation.util.XPStringBuilder pbstrErrorMessage)
bstrRequestStateStorageName
- the name of the items in the state
object that are related to this searchpWebServiceSettings
- the settings for the Web Service for this
searchlWebServiceID
- the ID of the Web Service for this searchvAppData
- persistent application data for this searchpRequestState
- the request state for this userpbstrErrorMessage
- Buffer to write the error message for this search
java.lang.Object GetCapabilities(int lFederatedPortalCapability)
lFederatedPortalCapability
- a value from
PT_FEDERATEDPORTALPROVIDER_CAPABILITIES
java.lang.String GetName()
java.lang.String GetDescription()
java.lang.String GetFederatedSearchProviderCLSID()
java.lang.String GetImageUUID()
void Initialize(IPTSession pSession, com.plumtree.openfoundation.util.IXPPropertyBag pbagConfigurationInfo, IPTWebService pWebService, int lFederatedPortalID, java.lang.String bstrThisPortalIdentity)
pSession
- the user session of the current userpbagConfigurationInfo
- configuration info for this ProviderpWebService
- the Web Service associated with this ProviderlFederatedPortalID
- the ID of the Federated Portal associated with
this ProviderbstrThisPortalIdentity
- a string uniquely identifying this Portal
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |