Plumtree Portal UI  
 

SearchResultModel Members

SearchResultModel overview

Public Static Fields

COLLAB_APP String that getResultApp() returns for Collab items
CONTAINER_ABSTYPE String that getResultAbsType() returns for containers
CONTENT_APP String that getResultApp() returns for Content items
DOCUMENT_ABSTYPE String that getResultAbsType() returns for documents
GROUP_BY_PREFS_KEY 
GROUPBY_FOLDER Built-in group-by string identifiers.
GROUPBY_OBJECTTYPE 
MODEL_MODE_INPUT 
OTHER_ABSTYPE String that getResultAbsType() returns for any other item
PORTAL_APP String that getResultApp() returns for portal items
SORTORDER_CREATED_ASC 
SORTORDER_CREATED_DESC 
SORTORDER_MODIFIED_ASC 
SORTORDER_MODIFIED_DESC 
SORTORDER_NAME_ASC 
SORTORDER_NAME_DESC 
SORTORDER_RELEVANCE Supported sort orders. Note that any numeric or date property should work, but it's convenient to provide these simple definitions.
STR_MVC_CLASS_NAME Name of this class
TEMPLATING_APP String that getResultApp() returns for community templating items (whose subtypes are the same as those for portal items, but do not correspond to "real" portal objects)
UNKNOWN_FOLDER_NAME Name of folder returned when db lookup of name fails- must be localized before displaying. NOTE: this must be kept in sync with what is returned by PTSearch.dll

Public Static Methods

ConvertSearchDateTimeToXPDateTime 
getDisplayableNameForType 

Public Instance Constructors

SearchResultModel Constructor Initializes a new instance of the SearchResultModel class.

Public Instance Methods

ChangeSortOrder Same as GoToPage but only changes sort order. Called from SortOrderControl
CleanupAllData 
CleanupTempData 
CollabInstalled 
ContentInstalled 
Create 
Drilldown 
Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
ExternalLightInitialization 
Filter 
GetAbstractTypeRestrictions 
GetAdminFolderRestrictions 
GetApplicationRestrictions 
GetASConstraintOperator 
GetASConstraintProperty 
GetASConstraintValue 
GetASNumPropertyConstraints 
GetASPropertyClauseOperator 
GetASTopLevelOperator 
GetBreadcrumbKey 
GetBreadcrumbLabel 
GetCollabProjectRestrictions 
GetCommunityNameForID 
GetCommunityRestrictions 
GetCorrectionFrequency 
GetCurrentKey 
GetDateFormat 
GetDocFolderRestrictions 
GetDrilldownDepth 
GetError 
GetFirstDisplayableItem 
GetFolderNameForID 
GetGroupIcon 
GetGroupName 
GetGroupsForAncestorKey Special-case method for use only by DrilldownView. Not exposed through ISearchResultModelRO interface. Returns the set of groups that was generated for some ancestor of the drilled-down response currently being shown. This is used to generate a view that lets the user jump to a sibling of the current response. For example, if the user has drilled down into the "Documents" category, such a view might let the user jump over to the (sibling) "Portlets" category. For now, this method only works if the requested ancestor was grouped by object type.
GetHasBeenSaved 
GetHasDisplayedObjects 
GetHashCode (inherited from Object)Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table.
GetHeaderID Return the headerID for the community; used when processing the style sheet.
GetIncludeSubfolders 
GetItemsPerPage 
GetKWIC 
GetLanguageRestriction 
GetLastDrilldownGroup Special-case method for use only by DrilldownView. Not exposed through ISearchResultModelRO interface. Returns the ID of the last group we drilled down into. For example, if the initial search was grouped by Object Type, and the user selected Portlets (group 3) and drilled down, this would return "3".
GetLastGroupByField 
GetMisspelledToken 
GetName 
GetNumCorrections 
GetNumDisplayableItems 
GetNumMisspelledTokens 
GetNumResultGroups 
GetObjectTypeRestrictions 
GetPageMode 
GetPortletNameForID 
GetPortletRestrictions 
GetReconstructionArgsOverloaded.  
GetRemovableSettings 
GetResultAbsType 
GetResultApp 
GetResultBestBetKey 
GetResultClassID 
GetResultClickthroughURLOverloaded. Returns a view link that may be used for clickthrough.
GetResultCollabProjectName 
GetResultCollabProjectURL 
GetResultContentLastPubUser 
GetResultContentPortletIDs 
GetResultCreated 
GetResultEditLink Returns an edit link that may be used for clickthrough.
GetResultEODField 
GetResultEODFieldAsObject 
GetResultFolderID 
GetResultIcon 
GetResultLastModified 
GetResultName 
GetResultObjectID 
GetResultPath 
GetResultPortletField 
GetResultPropertiesURL 
GetResultRank 
GetResultSize 
GetResultStyleClass 
GetResultSubType 
GetResultTypeUUID 
GetReturnedResultsInGroup 
GetSavedSearchErrorCode 
GetSavedSearchName 
GetSearchAgainArgs 
GetSearchString 
GetSelectedTypeFilter 
GetSortOrder 
GetSpellingCorrection 
GetStyleSheet Return the stylesheet for the community; used when processing the style sheet.
GetTotalItems 
GetTotalResultsInGroup 
GetType (inherited from Object)Gets the Type of the current instance.
GetWarning 
GoToPage 
hasDrilledDownIntoSingleCategory 
Init 
isAdvancedSearch 
IsASTooComplexToSummarize 
isEntireGroupReturned 
IsInitialized 
isResultBestBet 
RefreshResults 
Reorganize 
RestoreFromBreadcrumb 
SearchOverloaded.  
SearchWithinResults 
SetError 
SetPageMode 
SetSavedSearchErrorCode 
SetSavedSearchName 
SetWarning 
ToString (inherited from Object)Returns a String that represents the current Object.
wasSpellCorrected 

Protected Instance Fields

_advancedFilter User's original search filter
_initialBestBets Whether best bets were initially requested
_initialGroupBy Field that was used for group-by on the original search. This field will also be the default for group-by on any later drilldown, or after the user uses a breadcrumb control to undo the drilldown.
_initialSearchString User's original search string
_isAdvancedSearch Whether the original search used a filter (i.e. advanced search)
_pageMode The current "mode" that the client page is in. This class doesn't care about the contents; this is just a convenient holder for client code. See get/set methods below.
_pageSize User's desired number of results per page
_savedSearchErrorCode Integer that client views can use to get/set error conditions for saved search (or they can use the getError() mechanism, but this affects *all* views, not just the saved search view).
_savedSearchName Name this search has been saved under
_swrCount 
_swrFields Fields that search-within-results queries will run against

Protected Instance Methods

doSearch doSearch() actually calls the COM side to do the search; this is called from any method that has made a change to the _request object and needs to update the search results. doSearch() also handles the various caches.
Finalize (inherited from Object)Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
localizeObjectTypeName Helper method to convert an indexed object type or abstract type to its localized equivalent
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.
restoreState If the user's hit the BACK button before clicking a link, this method restores our state to the way things were on the page where the user clicked the button.

See Also

SearchResultModel Class | com.plumtree.portaluiinfrastructure.search Namespace