| |  | Aqualogic Interaction API | |
| | IPTFederatedSearchAgent.DoBasicSearch Method |
Run a search against this portal. Call Initialize() before calling this method. After this method has been called, call the various Get methods to obtain information about the results.
bool DoBasicSearch(
string strRequestingPortal,
string strRequestingPortalPassword,
string strRequestingUser,
string strSearchString,
int lNumToSkip,
int lMaxToReturn,
object errorMessage
);
Parameters
-
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.
Return Value
true if search was successful, false otherwise.
See Also
IPTFederatedSearchAgent Interface | com.plumtree.server Namespace