Aqualogic Interaction API  
 

IPTFederatedSearchAgent Members

IPTFederatedSearchAgent overview

Public Instance Methods

DoBasicSearch 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.
GetCardImageURL Returns a URL for an icon associated with a particular result's type.
GetDocumentURL Returns an URL that may be used to open the document corresponding to a search result.
GetFieldsAsDouble Returns the value of a single field (property) of type double in a single search result.
GetFieldsAsInt Returns the value of a single field (property) of type int in a single search result.
GetFieldsAsObject Returns the value of a single field (property) in a single search result. Actual underlying result type depends on the property type.
GetFieldsAsString Returns the value of a single field (property) of type String in a single search result.
GetFieldsAsXPDateTime Returns the value of a single field (property) of date type in a single search result. 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).
GetMatchesReturned Get the number of results returned. This is NOT the same as the total number of matches for the query (see GetTotalMatches() for that); this is the number of items for which complete information was returned. (If the UI says "Results 1-10 of 123", this method returns 10.)
GetTotalMatches Get the total number of matches for the query. Not all of these are necessarily returned; call GetResultsReturned() for that. If the UI says "Results 1-10 of 123", this method returns 123.
Initialize Initializes object. Call this method first, before DoBasicSearch.

See Also

IPTFederatedSearchAgent Interface | com.plumtree.server Namespace