Public Instance Methods
 Clear | Clears this object and releases memory associated with it, which may be substantial. In the COM implementation, calling this as soon as possible avoids filling the unmanaged COM heap with large search results that wouldn't be freed until a garbage collection runs (possibly much later). No other method on this object may be called after Clear(). |
| GetCorrectedToken | Returns a single spelling correction for a single misspelled token. |
| GetCorrectionFrequency | Returns the number of search results in which the selected correction appears. This helps the UI decide which corrections to display and in what order. |
| GetFieldsAsDouble | Returns the value of a single field (property) in a single search result. |
| GetFieldsAsInt | Returns the value of a single field (property) in a single search result. This is the method to call if you want the Object ID of a search result - pass PT_INTRINSICS.PT_PROPERTY_OBJECTID for nPropertyID. |
| GetFieldsAsObject | Returns the value of a single field (property) in a single search result. |
| GetFieldsAsString | Returns the value of a single field (property) in a single search result. This is the method to call if you want the name of a search result - pass PT_INTRINSICS.PT_PROPERTY_OBJECTNAME for nPropertyID. |
| GetFieldsAsXPDateTime | Returns the value of a single field (property) in a single search result. |
| GetGroupLabel | Returns a label for a single group. If results were categorized by folder, this will be a localized name for a single folder, or "Unknown Folder" if the folder lookup fails. If results were categorized by object type, this method will return a string like "PTCOMMUNITY" that must be mapped to a localized equivalent before being displayed to an end user. |
| GetIsBestBet | Returns true if the result appears in the result set (or if its rank was affected) because of a Best Bet. |
| GetKWICFieldsAsDouble | Behaves identically to GetFieldsAsDouble; call that method instead. |
| GetKWICFieldsAsInt | Behaves identically to GetFieldsAsInt; call that method instead. |
| GetKWICFieldsAsObject | Call GetFieldsAsObject() or GetKWICFieldsAsString() instead, depending on what you want. |
| GetKWICFieldsAsString | Returns keyword-in-context ("KWIC") information for the given result and property. This is a String containing snippets of text from the given result; search keywords from the original query are enclosed in highlight tags that specify an HTML span of style listHiliteText. This method is usually called with PT_INTRINSICS.PT_PROPERTY_OBJECTSUMMARY, in which case it has special-case behavior to find the best KWIC information from the OBJECTSUMMARY and full-text content fields. This is how the portal generates the summaries that appear below the result title. However, you may call it with any other property used to constrain the search, and it will return KWIC info for that property if it exists. |
| GetKWICFieldsAsXPDateTime | Behaves identically to GetFieldsAsXPDateTime; call that method instead. |
| GetMisspelledToken | Returns one misspelled token. |
| GetNumCorrections | Returns the number of spelling corrections found for the given misspelled token. |
| GetNumGroups | Returns the number of categories into which the results were divided. "All Others" (uncategorized results) are not considered a separate group. If the GROUPBY setting was not used on the original search request, this method will return 0. |
| GetNumMisspelledTokens | Returns the number of tokens (words) in the user's query that were spell corrected. |
| GetQueryForAllOthers | Like GetQueryForGroup(), returns an IPTSearchQuery that may be used to drill down into the "all others" set of results that did not fall in any coherent group. |
| GetQueryForGroup | Returns an IPTSearchQuery that may be passed to IPTSearchRequest.FollowupSearch() (along with the original query/queries used to generate this IPTSearchResponse) to drill down into the indicated group. "Drilling down" means that all results from this followup search are members of the group. |
| GetRank | Maps from the result ranking within a group to the overall (ungrouped) result ranking. For example, the highest ranking result in group 2 might be the 4th-ranked result overall. In this case, GetRank(2,0) would return 3 (note ranking is zero-based). Note that methods like GetFields() index results by the ungrouped ranking, so if you are presenting results by group this will probably be the first method you call for each result row. |
| GetRankForUncategorizedDoc | Like GetRank(), maps from the rank in the uncategorized "all others" set to the overall result ranking. |
| GetResultAbsType | Abstractified, cross-application type of the result: "DOCUMENT", "CONTAINER", or "OTHER". |
| GetResultACL | Returns the ACL of the result (for portal objects only), or the list of Collab roles that have access to the result (for Collab objects only). For portal objects, both the ACL and folder ACL must match the user's access rights. Portal ACLs are returned as a space-separated string of group IDs and user IDs, where the user IDs are prefixed with the character 'u'. |
| GetResultApp | Returns the application that indexed this result: one of PTPORTAL (portal items), PTCONTENT (Content Server), PTCONTENTTEMPLATE (Branding Engine), or PTCOLLAB (Collaboration Server). |
| GetResultFolderACL | Returns the ACL of the result's folder (for portal objects only). Both the ACL and folder ACL must match the user's access rights. The folder ACL is returned as a space-separated string of group IDs and user IDs, where the user IDs are prefixed with the character 'u'. |
| GetResultInternalField | Returns the value of one of several "internal fields" that don't correspond to properties and that aren't important enough to merit their own method. See the PT_SEARCH_INTERNAL_FIELD enumeration for a list of these. |
| GetResultPath | Returns the full path to the object, in text form. Portal documents may live in more than one folder. If so, this method returns one folder path chosen more or less at random, and there is no guarantee that the user has rights to this particular folder (although s/he must have rights to one of the doc's folders). To check this, call GetResultInternalField() and request PT_SEARCH_INTERNAL_FIELD.PT_SEARCH_IF_PARENTIDS; if there is more than one parent (i.e. a space appears in this string) you should not display the path. Also, the path may not be localized to the user's current locale. |
| GetResultSize | Returns the size of the result in bytes, or a negative value if unknown. |
| GetResultsReturned | 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.) |
| GetResultSubType | Returns the application-specific type of the result. For portal objects, possible values are currently: PTUSER, PTGROUP, PTAUTHSOURCE, PTPROFILESOURCE, PTFOLDER, PTCARD, PTADMINFOLDER, PTFILTER, PTSAVEDSEARCH, PTDATASOURCE, PTCARDPROPERTY, PTDOCUMENTTYPE, PTCRAWLER, PTGADGET, PTINVITATION, PTFEDPORTAL, PTGADGETSERVER, PTCOMMTEMPLATE, PTGADGETBUNDLE, PTPAGETEMPLATE, PTWEBSERVICE, PTEXTOPERATION, PTGADGETTEMPLATE, PTJOB, PTCOMMUNITY. For Collaboration Server items, returns PTCOLLAB. For Content Server items, returns PTCONTENT. For Branding Engine items, returns PTCOMMUNITY, so these items appear in the "community" category. |
| GetReturnedResultsInGroup | Returns the number of results in the group that are available for display. Will always be equal to or less than the value returned by GetReturnedResults(). |
| GetReturnedResultsNotInAnyGroup | Returns the number of displayable results that did not fall in any group. |
| GetSkipped | Returns the number of results skipped before beginning to return results. For example, if you requested results 11 through 20, this method will return 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. |
| GetTotalResultsInGroup | Returns the total number of results in the indicated group, or an estimate in some cases. Estimates are indicated by "~", for example, "~ 1000". This is the total over the entire result set, not the number available for display. |
| GetTotalResultsNotInAnyGroup | Returns an estimate the number of results in the overall result set (not just those displayed) that did not fall into any group. The estimate is a string of the form "~ 1000". |
| GetWarning | Returns a code indicating whether any warnings were issued in the course of running the search. Warnings indicate that the search ran and some results may have been returned, but not necessarily all results, and that the user should be informed of the reason. See the PT_SEARCH_WARNING enumeration for a list of codes. |
See Also
IPTSearchResponse Interface | com.plumtree.server Namespace