com.plumtree.portaluiinfrastructure.search
Interface ISearchResultModelRO

All Superinterfaces:

IBaseSearchQueryRO, IBaseSearchResultModelRO, IModelRO, IMVCObject, IPaginationRO, ISaveSearchModelRO, ISearchQueryRO

All Known Implementing Classes:

SearchResultModel

public interface ISearchResultModelRO
extends IBaseSearchResultModelRO, ISearchQueryRO, ISaveSearchModelRO

Author:

CraigS

Method Summary

boolean	CollabInstalled()
boolean	ContentInstalled()
java.lang.String	GetBreadcrumbKey(int step) Returns a key that may be used in ISearchResultModel.FollowBreadcrumb to use the indicated breadcrumb step (must be between 1 and getDrilldownDepth(), inclusive).
java.lang.String	GetBreadcrumbLabel(int step) Returns a displayable label for the indicated breadcrumb (must be between 2 and getDrilldownDepth(), inclusive).
int	GetCorrectionFrequency(int misspellingIndex, int correctionIndex) Returns the number of times the given correction actually matched a document.
java.lang.String	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.
XPDateFormat	GetDateFormat(AActivitySpace owner)
int	GetDrilldownDepth() Returns the number of drilldown steps the user has taken.
java.lang.Object	GetGroupIcon(int group) Returns an icon (actually an HTMLImg) for the indicated group, or null if there is no appropriate icon.
java.lang.String	GetGroupName(int group) Returns the name of the indicated group.
java.lang.String	GetLastGroupByField() Returns the most recent categorization field
java.lang.String	GetMisspelledToken(int misspellingIndex) Returns a single misspelled token.
int	GetNumCorrections(int misspellingIndex) Returns the number of corrections for the indicated misspelling.
int	GetNumMisspelledTokens() Returns the number of misspelled tokens.
int	GetNumResultGroups() Returns the number of result groups.
java.lang.String	GetPageMode() SearchResultModel holds onto a "page mode" string for the benefit of client code..
PathwaysTagRestData[]	GetPathwaysResultTags(int rank) Returns the pathways tags associated to the pathways search result item
XPHashtable	GetReconstructionArgs() Get URL arguments that are sufficient to reconstruct this search result if it has been flushed from the cache.
XPHashtable	GetReconstructionArgs(boolean pageContext) Same as getReconstructionArgs(), but if pageContext is false, omit any args that indicate what page the model is on - i.e.
XPHashtable	GetReconstructionArgs(java.lang.String prefix, boolean wantPageContext)
SearchSettingCollection	GetRemovableSettings() Returns settings that were used for this search, but that could be removed from followup searches if desired
java.lang.String	GetResultBestBetKey(int rank) Returns an internal key used by Best Bets; do not call otherwise
HTMLAnchor	GetResultClickthroughURL(int rank, boolean allowPopup) Returns an URL that may be used for clickthrough in "view" mode.
HTMLAnchor	GetResultClickthroughURL(int rank, boolean allowPopup, boolean editMode) Returns an URL that may be used for clickthrough.
HTMLAnchor	GetResultClickthroughURL(int rank, boolean allowPopup, boolean editMode, java.lang.String extraParameters) Returns an URL that may be used for clickthrough.
java.lang.String	GetResultCollabProjectName(int rank) Special call for Collab Server results; returns the name of the item's containing project.
java.lang.String	GetResultCollabProjectURL(int rank) Special call for Collab Server results; returns the URL used to open the containing project.
java.lang.String	GetResultContentLastPubUser(int rank) Special call for Content Server results; returns the "last published by" username.
int[]	GetResultContentPortletIDs(int rank) Special call for Content Server results; returns the IDs of this result's parent portlets.
HTMLAnchor	GetResultEditLink(int rank, boolean allowPopup) Returns an edit link that may be used for clickthrough.
HTMLAnchor	GetResultPropertiesURL(int rank, boolean allowPopup) Returns an URL that may be used to open a "properties" page for the item, or null if there is no such page.
int	GetResultRank(int groupNum, int resultNum) Returns the overall relevance rank of a grouped result.
java.lang.String	GetResultStyleClass(java.lang.String subType)
int	GetReturnedResultsInGroup(int group) Returns the number of results in the indicated group that were actually returned.
XPHashtable	GetSearchAgainArgs(boolean includeOptional) Returns arguments that can be used for a followup search with the same settings as the current search.
int	GetSelectedTypeFilter()
java.lang.String	GetSpellingCorrection(int misspellingIndex, int correctionIndex) Returns a single corrected token for the indicated misspelling.
XPHashtable	GetTagCloud() Returns the pathways tag cloud associated with the pathways search result
java.lang.String	GetTotalResultsInGroup(int group) Returns the total number of results in the indicated group.
boolean	hasDrilledDownIntoSingleCategory(java.lang.String orgType) Returns true if this model has been drilled down into a single category of the given organization scheme.
boolean	isEntireGroupReturned(int group) Returns true if all results in the group were returned.
boolean	IsPathwaysSearch() Returns true if it is a Pathways search, otherwise it is a regular search.
boolean	wasSpellCorrected() Returns true if the user's search phrase was spell-corrected.

Methods inherited from interface com.plumtree.portaluiinfrastructure.search.IBaseSearchResultModelRO

GetError, GetKWIC, GetResultAbsType, GetResultApp, GetResultClassID, GetResultCreated, GetResultEODField, GetResultFolderID, GetResultIcon, GetResultLastModified, GetResultName, GetResultObjectID, GetResultPath, GetResultPortletField, GetResultSize, GetResultSubType, GetWarning, IsInitialized, isResultBestBet

Methods inherited from interface com.plumtree.uiinfrastructure.activityspace.IMVCObject

GetName

Methods inherited from interface com.plumtree.uiinfrastructure.pagination.IPaginationRO

GetFirstDisplayableItem, GetItemsPerPage, GetNumDisplayableItems, GetSortOrder, GetTotalItems

Methods inherited from interface com.plumtree.portaluiinfrastructure.search.ISearchQueryRO

GetASConstraintOperator, GetASConstraintProperty, GetASConstraintValue, GetASNumPropertyConstraints, GetASPropertyClauseOperator, GetASTopLevelOperator, isAdvancedSearch, IsASTooComplexToSummarize

Methods inherited from interface com.plumtree.portaluiinfrastructure.search.IBaseSearchQueryRO

GetAbstractTypeRestrictions, GetAdminFolderRestrictions, GetApplicationRestrictions, GetCollabProjectRestrictions, GetCommunityNameForID, GetCommunityRestrictions, GetDocFolderRestrictions, GetFolderNameForID, GetIncludeSubfolders, GetLanguageRestriction, GetLocalizedSearchString, GetObjectTypeRestrictions, GetPortletNameForID, GetPortletRestrictions, GetSearchString

Methods inherited from interface com.plumtree.portaluiinfrastructure.search.ISaveSearchModelRO

GetHasBeenSaved, GetSavedSearchErrorCode, GetSavedSearchName

Method Detail

GetBreadcrumbKey

java.lang.String GetBreadcrumbKey(int step)
                                  throws SearchModelException

Returns a key that may be used in ISearchResultModel.FollowBreadcrumb to use the indicated breadcrumb step (must be between 1 and getDrilldownDepth(), inclusive).

Throws:

SearchModelException

GetBreadcrumbLabel

java.lang.String GetBreadcrumbLabel(int step)
                                    throws SearchModelException

Returns a displayable label for the indicated breadcrumb (must be between 2 and getDrilldownDepth(), inclusive).

Throws:

SearchModelException

GetCorrectionFrequency

int GetCorrectionFrequency(int misspellingIndex,
                           int correctionIndex)
                           throws SearchModelException

Returns the number of times the given correction actually matched a document.

Throws:

SearchModelException

GetCurrentKey

java.lang.String GetCurrentKey()
                               throws SearchModelException

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.

Throws:

SearchModelException

hasDrilledDownIntoSingleCategory

boolean hasDrilledDownIntoSingleCategory(java.lang.String orgType)
                                         throws SearchModelException

Returns true if this model has been drilled down into a single category of the given organization scheme.

Throws:

SearchModelException

GetDrilldownDepth

int GetDrilldownDepth()
                      throws SearchModelException

Returns the number of drilldown steps the user has taken.

Throws:

SearchModelException

isEntireGroupReturned

boolean isEntireGroupReturned(int group)
                              throws SearchModelException

Returns true if all results in the group were returned.

Throws:

SearchModelException

GetGroupName

java.lang.String GetGroupName(int group)
                              throws SearchModelException

Returns the name of the indicated group.

Throws:

SearchModelException

GetGroupIcon

java.lang.Object GetGroupIcon(int group)
                              throws SearchModelException

Returns an icon (actually an HTMLImg) for the indicated group, or null if there is no appropriate icon.

Throws:

SearchModelException

GetLastGroupByField

java.lang.String GetLastGroupByField()
                                     throws SearchModelException

Returns the most recent categorization field

Throws:

SearchModelException

GetPageMode

java.lang.String GetPageMode()

SearchResultModel holds onto a "page mode" string for the benefit of client code.. it doesn't care about the contents.

GetMisspelledToken

java.lang.String GetMisspelledToken(int misspellingIndex)
                                    throws SearchModelException

Returns a single misspelled token.

Throws:

SearchModelException

GetNumCorrections

int GetNumCorrections(int misspellingIndex)
                      throws SearchModelException

Returns the number of corrections for the indicated misspelling.

Throws:

SearchModelException

GetNumMisspelledTokens

int GetNumMisspelledTokens()
                           throws SearchModelException

Returns the number of misspelled tokens.

Throws:

SearchModelException

GetNumResultGroups

int GetNumResultGroups()
                       throws SearchModelException

Returns the number of result groups.

Throws:

SearchModelException

GetReconstructionArgs

XPHashtable GetReconstructionArgs()
                                  throws SearchModelException

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.

Throws:

SearchModelException

GetReconstructionArgs

XPHashtable GetReconstructionArgs(boolean pageContext)
                                  throws SearchModelException

Same as getReconstructionArgs(), but if pageContext is false, omit any args that indicate what page the model is on - i.e. the model will come back on page 1 with the default sort order and organization.

Throws:

SearchModelException

GetReconstructionArgs

XPHashtable GetReconstructionArgs(java.lang.String prefix,
                                  boolean wantPageContext)
                                  throws SearchModelException

Throws:

SearchModelException

GetResultBestBetKey

java.lang.String GetResultBestBetKey(int rank)
                                     throws SearchModelException

Returns an internal key used by Best Bets; do not call otherwise

Throws:

SearchModelException

GetResultClickthroughURL

HTMLAnchor GetResultClickthroughURL(int rank,
                                    boolean allowPopup)
                                    throws SearchModelException

Returns an URL that may be used for clickthrough in "view" mode. Equivalent to GetResultClickthroughURL(rank, allowPopup, false).

Throws:

SearchModelException

GetResultClickthroughURL

HTMLAnchor GetResultClickthroughURL(int rank,
                                    boolean allowPopup,
                                    boolean editMode)
                                    throws SearchModelException

Returns an URL that may be used for clickthrough.

Throws:

SearchModelException

GetResultClickthroughURL

HTMLAnchor GetResultClickthroughURL(int rank,
                                    boolean allowPopup,
                                    boolean editMode,
                                    java.lang.String extraParameters)
                                    throws SearchModelException

Returns an URL that may be used for clickthrough.

Throws:

SearchModelException

GetResultEditLink

HTMLAnchor GetResultEditLink(int rank,
                             boolean allowPopup)
                             throws SearchModelException

Returns an edit link that may be used for clickthrough. Equivalent to GetResultClickthroughURL(rank, allowPopup, true).

Throws:

SearchModelException

GetResultCollabProjectURL

java.lang.String GetResultCollabProjectURL(int rank)
                                           throws SearchModelException

Special call for Collab Server results; returns the URL used to open the containing project.

Throws:

SearchModelException

GetResultCollabProjectName

java.lang.String GetResultCollabProjectName(int rank)
                                            throws SearchModelException

Special call for Collab Server results; returns the name of the item's containing project.

Throws:

SearchModelException

GetResultContentLastPubUser

java.lang.String GetResultContentLastPubUser(int rank)
                                             throws SearchModelException

Special call for Content Server results; returns the "last published by" username.

Throws:

SearchModelException

GetResultContentPortletIDs

int[] GetResultContentPortletIDs(int rank)
                                 throws SearchModelException

Special call for Content Server results; returns the IDs of this result's parent portlets.

Throws:

SearchModelException

GetResultPropertiesURL

HTMLAnchor GetResultPropertiesURL(int rank,
                                  boolean allowPopup)
                                  throws SearchModelException

Returns an URL that may be used to open a "properties" page for the item, or null if there is no such page.

Throws:

SearchModelException

GetResultRank

int GetResultRank(int groupNum,
                  int resultNum)
                  throws SearchModelException

Returns the overall relevance rank of a grouped result.

Throws:

SearchModelException

GetReturnedResultsInGroup

int GetReturnedResultsInGroup(int group)
                              throws SearchModelException

Returns the number of results in the indicated group that were actually returned.

Throws:

SearchModelException

GetSearchAgainArgs

XPHashtable GetSearchAgainArgs(boolean includeOptional)
                               throws SearchModelException

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.

Throws:

SearchModelException

GetSpellingCorrection

java.lang.String GetSpellingCorrection(int misspellingIndex,
                                       int correctionIndex)
                                       throws SearchModelException

Returns a single corrected token for the indicated misspelling.

Throws:

SearchModelException

GetTotalResultsInGroup

java.lang.String GetTotalResultsInGroup(int group)
                                        throws SearchModelException

Returns the total number of results in the indicated group. The total may be an estimate of the form "~ 100".

Throws:

SearchModelException

GetRemovableSettings

SearchSettingCollection GetRemovableSettings()
                                             throws SearchModelException

Returns settings that were used for this search, but that could be removed from followup searches if desired

Throws:

SearchModelException

wasSpellCorrected

boolean wasSpellCorrected()
                          throws SearchModelException

Returns true if the user's search phrase was spell-corrected.

Throws:

SearchModelException

GetDateFormat

XPDateFormat GetDateFormat(AActivitySpace owner)

GetResultStyleClass

java.lang.String GetResultStyleClass(java.lang.String subType)

ContentInstalled

boolean ContentInstalled()

CollabInstalled

boolean CollabInstalled()

GetSelectedTypeFilter

int GetSelectedTypeFilter()

GetPathwaysResultTags

PathwaysTagRestData[] GetPathwaysResultTags(int rank)

Returns the pathways tags associated to the pathways search result item

Parameters:

rank - - the search result # you want info from

GetTagCloud

XPHashtable GetTagCloud()

Returns the pathways tag cloud associated with the pathways search result

IsPathwaysSearch

boolean IsPathwaysSearch()

Returns true if it is a Pathways search, otherwise it is a regular search.