Plumtree Portal UI  
 

ISearchResultModelRO Methods

The methods of the ISearchResultModelRO interface are listed below. For a complete list of ISearchResultModelRO interface members, see the ISearchResultModelRO Members topic.

Public Instance Methods

CollabInstalled 
ContentInstalled 
GetBreadcrumbKey Returns a key that may be used in ISearchResultModel.FollowBreadcrumb to use the indicated breadcrumb step (must be between 1 and getDrilldownDepth(), inclusive).
GetBreadcrumbLabel Returns a displayable label for the indicated breadcrumb (must be between 2 and getDrilldownDepth(), inclusive).
GetCorrectionFrequency Returns the number of times the given correction actually matched a document.
GetCurrentKey Returns a key that should be attached to all URLs that access this model; this key allows the model to find the search result on which a URL was generated if the user hits the BACK button.
GetDateFormat 
GetDrilldownDepth Returns the number of drilldown steps the user has taken.
GetGroupIcon Returns an icon (actually an HTMLImg) for the indicated group, or null if there is no appropriate icon.
GetGroupName Returns the name of the indicated group.
GetLastGroupByField Returns the most recent categorization field
GetMisspelledToken Returns a single misspelled token.
GetNumCorrections Returns the number of corrections for the indicated misspelling.
GetNumMisspelledTokens Returns the number of misspelled tokens.
GetNumResultGroups Returns the number of result groups.
GetPageMode SearchResultModel holds onto a "page mode" string for the benefit of client code.. it doesn't care about the contents.
GetReconstructionArgsOverloaded. Get URL arguments that are sufficient to reconstruct this search result if it has been flushed from the cache. These are returned as an XPHashtable from a String key to an array of String values.
GetRemovableSettings Returns settings that were used for this search, but that could be removed from followup searches if desired
GetResultBestBetKey Returns an internal key used by Best Bets; do not call otherwise
GetResultClickthroughURLOverloaded. Returns an URL that may be used for clickthrough in "view" mode. Equivalent to GetResultClickthroughURL(rank, allowPopup, false).
GetResultCollabProjectName Special call for Collab Server results; returns the name of the item's containing project.
GetResultCollabProjectURL Special call for Collab Server results; returns the URL used to open the containing project.
GetResultContentLastPubUser Special call for Content Server results; returns the "last published by" username.
GetResultContentPortletIDs Special call for Content Server results; returns the IDs of this result's parent portlets.
GetResultEditLink Returns an edit link that may be used for clickthrough. Equivalent to GetResultClickthroughURL(rank, allowPopup, true).
GetResultPropertiesURL Returns an URL that may be used to open a "properties" page for the item, or null if there is no such page.
GetResultRank Returns the overall relevance rank of a grouped result.
GetResultStyleClass 
GetReturnedResultsInGroup Returns the number of results in the indicated group that were actually returned.
GetSearchAgainArgs Returns arguments that can be used for a followup search with the same settings as the current search. If removeOptional is true, then any settings that are in the "removable" set (as returned by GetRemovableSettings()) are not included in the returned XPHashtable.
GetSelectedTypeFilter 
GetSpellingCorrection Returns a single corrected token for the indicated misspelling.
GetTotalResultsInGroup Returns the total number of results in the indicated group. The total may be an estimate of the form "~ 100".
hasDrilledDownIntoSingleCategory Returns true if this model has been drilled down into a single category of the given organization scheme.
isEntireGroupReturned Returns true if all results in the group were returned.
wasSpellCorrected Returns true if the user's search phrase was spell-corrected.

See Also

ISearchResultModelRO Interface | com.plumtree.portaluiinfrastructure.search Namespace