|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IPTFederatedSearchAgent
This is the interface for the federated search agent. It allows another portal to request a federated search of this portal.
More specifically, in the COM implementation, the server side of a federated search request is handled by PTFederatedSearchServer (in the Extensibility package). PTFederatedSearchServer creates an PTSearchProxy, which instantiates an IPTFederatedSearchAgent, which, in turn, creates local portal search objects (e.g. IPTSearchRequest) to actually run the search.
Method Summary | |
---|---|
boolean |
DoBasicSearch(java.lang.String strRequestingPortal,
java.lang.String strRequestingPortalPassword,
java.lang.String strRequestingUser,
java.lang.String strSearchString,
int lNumToSkip,
int lMaxToReturn,
java.lang.Object errorMessage)
Run a search against this portal. |
java.lang.String |
GetCardImageURL(int lRowIndex,
java.lang.String bstrImageServerURL)
Returns a URL for an icon associated with a particular result's type. |
java.lang.String |
GetDocumentURL(int lRowIndex)
Returns an URL that may be used to open the document corresponding to a search result. |
double |
GetFieldsAsDouble(int lRowIndex,
int lPropID)
Returns the value of a single field (property) of type double in a single search result. |
int |
GetFieldsAsInt(int lRowIndex,
int lPropID)
Returns the value of a single field (property) of type int in a single search result. |
java.lang.Object |
GetFieldsAsObject(int lRowIndex,
int lPropID)
Returns the value of a single field (property) in a single search result. |
java.lang.String |
GetFieldsAsString(int lRowIndex,
int lPropID)
Returns the value of a single field (property) of type String in a single search result. |
com.plumtree.openfoundation.util.XPDateTime |
GetFieldsAsXPDateTime(int lRowIndex,
int lPropID)
Returns the value of a single field (property) of date type in a single search result. |
int |
GetMatchesReturned()
Get the number of results returned. |
int |
GetTotalMatches()
Get the total number of matches for the query. |
void |
Initialize(IPTSession pSession)
Initializes object. |
Methods inherited from interface com.plumtree.server.IPTUnknown |
---|
GetInterfaces |
Method Detail |
---|
boolean DoBasicSearch(java.lang.String strRequestingPortal, java.lang.String strRequestingPortalPassword, java.lang.String strRequestingUser, java.lang.String strSearchString, int lNumToSkip, int lMaxToReturn, java.lang.Object errorMessage)
strRequestingPortal
- Name of the portal requesting this search; must match PT_PROPID_FEDERATEDPORTAL_FEDERATEDPORTALIDENTITY for some locally registered federated portal.strRequestingPortalPassword
- Password for the requesting portal.strRequestingUser
- User whose credentials to use when running the search.strSearchString
- User's search string.lNumToSkip
- Number of results to skip before returning results. For results 21-30, this is 20.lMaxToReturn
- Maximum number of results to return. For results 21-30, this is 10.errorMessage
- Location where this object writes any error message resulting from the search, if return value is false. For the Java implementation, this should be an XPStringBuilder.
int GetTotalMatches()
int GetMatchesReturned()
int GetFieldsAsInt(int lRowIndex, int lPropID)
lRowIndex
- Result rank, in the range 0 to (GetMatchesReturned()-1).lPropID
- ID of the property desired, or one of the special-case pseudoproperties
given by PT_INTRINSICS in the ranges [1,8] and [51,58]. Must be a numeric property.
java.lang.String GetFieldsAsString(int lRowIndex, int lPropID)
lRowIndex
- Result rank, in the range 0 to (GetMatchesReturned()-1).lPropID
- ID of the property desired, or one of the special-case pseudoproperties
given by PT_INTRINSICS in the ranges [1,8] and [51,58]. Must be a text (string-valued) property.
double GetFieldsAsDouble(int lRowIndex, int lPropID)
lRowIndex
- Result rank, in the range 0 to (GetMatchesReturned()-1).lPropID
- ID of the property desired, or one of the special-case pseudoproperties
given by PT_INTRINSICS in the ranges [1,8] and [51,58]. Must be a numeric property.
com.plumtree.openfoundation.util.XPDateTime GetFieldsAsXPDateTime(int lRowIndex, int lPropID)
Note that there is special-case behavior for the OBJECTCREATED and OBJECTLASTMODIFIED properties - although the portal considers these to be date properties, search actually returns them as Double instead, so call GetFieldsAsDouble. The method SearchResultModel.ConvertSearchDateTimeToXPDateTime converts this double to an XPDateTime (or see the Search Developer's Guide for code).
lRowIndex
- Result rank, in the range 0 to (GetMatchesReturned()-1).lPropID
- ID of the property desired, or one of the special-case pseudoproperties
given by PT_INTRINSICS in the ranges [1,8] and [51,58]. Must be a date property.
java.lang.Object GetFieldsAsObject(int lRowIndex, int lPropID)
lRowIndex
- Result rank, in the range 0 to (GetMatchesReturned()-1).lPropID
- ID of the property desired, or one of the special-case pseudoproperties
given by PT_INTRINSICS in the ranges [1,8] and [51,58].
java.lang.String GetCardImageURL(int lRowIndex, java.lang.String bstrImageServerURL)
lRowIndex
- Result rank, in the range 0 to (GetMatchesReturned()-1).bstrImageServerURL
- Base URL to the image server.
java.lang.String GetDocumentURL(int lRowIndex)
lRowIndex
- Result rank, in the range 0 to (GetMatchesReturned()-1).
void Initialize(IPTSession pSession)
pSession
- Current Plumtree session.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |