|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.plumtree.portaluiinfrastructure.search.SearchResultModel
public class SearchResultModel
Field Summary | |
---|---|
protected IPTFilter |
_advancedFilter
User's original search filter |
protected boolean |
_initialBestBets
Whether best bets were initially requested |
protected java.lang.String |
_initialGroupBy
Field that was used for group-by on the original search. |
protected java.lang.String |
_initialSearchString
User's original search string |
protected boolean |
_isAdvancedSearch
Whether the original search used a filter (i.e. |
protected java.lang.String |
_pageMode
The current "mode" that the client page is in. |
protected int |
_pageSize
User's desired number of results per page |
protected int |
_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). |
protected java.lang.String |
_savedSearchName
Name this search has been saved under |
protected int |
_swrCount
|
protected java.lang.String |
_swrFields
Fields that search-within-results queries will run against |
static java.lang.String |
COLLAB_APP
String that getResultApp() returns for Collab items |
static java.lang.String |
CONTAINER_ABSTYPE
String that getResultAbsType() returns for containers |
static java.lang.String |
CONTENT_APP
String that getResultApp() returns for Content items |
static java.lang.String |
DOCUMENT_ABSTYPE
String that getResultAbsType() returns for documents |
static java.lang.String |
GROUP_BY_PREFS_KEY
|
static java.lang.String |
GROUPBY_FOLDER
Built-in group-by string identifiers. |
static java.lang.String |
GROUPBY_OBJECTTYPE
|
static java.lang.String |
MODEL_MODE_INPUT
|
static java.lang.String |
OTHER_ABSTYPE
String that getResultAbsType() returns for any other item |
static java.lang.String |
PORTAL_APP
String that getResultApp() returns for portal items |
static java.lang.String |
SORTORDER_CREATED_ASC
|
static java.lang.String |
SORTORDER_CREATED_DESC
|
static java.lang.String |
SORTORDER_MODIFIED_ASC
|
static java.lang.String |
SORTORDER_MODIFIED_DESC
|
static java.lang.String |
SORTORDER_NAME_ASC
|
static java.lang.String |
SORTORDER_NAME_DESC
|
static java.lang.String |
SORTORDER_RELEVANCE
Supported sort orders. |
static java.lang.String |
STR_MVC_CLASS_NAME
Name of this class |
static java.lang.String |
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) |
static java.lang.String |
UNKNOWN_FOLDER_NAME
Name of folder returned when db lookup of name fails- must be localized before displaying. |
Constructor Summary | |
---|---|
SearchResultModel()
|
Method Summary | |
---|---|
void |
ChangeSortOrder(java.lang.String sortOrder,
java.lang.Object additionalInfo)
Same as GoToPage but only changes sort order. |
void |
CleanupAllData()
This method is called when an ActivitySpace is removed from the cache. |
void |
CleanupTempData()
This method is called at the end of every HTTP request by the Interpreter. |
boolean |
CollabInstalled()
|
boolean |
ContentInstalled()
|
static XPDateTime |
ConvertSearchDateTimeToXPDateTime(double searchTime)
|
java.lang.Object |
Create()
This method is used by the ASManager to return new instances of managed objects. |
protected void |
doSearch(IPTSearchQuery additionalQuery,
java.lang.String additionalBreadcrumb,
java.lang.String newKey)
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. |
void |
Drilldown(java.lang.String keyOnPage,
java.lang.String groupByField,
int category)
Drill down into the indicated category. |
void |
ExternalLightInitialization(IPTSearchResponse sr,
AActivitySpace asSpace)
|
void |
Filter(java.lang.String key,
int filterId)
Filter the search result based on the filterId |
int |
GetAbstractTypeRestrictions()
Returns the abstract types the search was restricted to, if any. |
int[] |
GetAdminFolderRestrictions()
Returns the admin folders the search was restricted to, if any. |
int |
GetApplicationRestrictions()
Returns the applications the search was restricted to, if any. |
java.lang.String |
GetASConstraintOperator(int condition)
If advanced search, returns the operator for the indicated property condition (localized). |
java.lang.String |
GetASConstraintProperty(int condition)
If advanced search, returns the property name for the indicated property condition. |
java.lang.String |
GetASConstraintValue(int condition)
If advanced search, returns the comparison value for the indicated property condition. |
int |
GetASNumPropertyConstraints()
If advanced search, returns the number of property restrictions. |
boolean |
GetASPropertyClauseOperator()
If advanced search, returns whether individual property conditions are ANDed or ORed together (true <-> AND). |
boolean |
GetASTopLevelOperator()
If advanced search, returns whether text and property conditions (as a group) are ANDed or ORed together (true <-> AND). |
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[] |
GetCollabProjectRestrictions()
Returns the Collab projects the search was restricted to, if any. |
java.lang.String |
GetCommunityNameForID(int id)
Utility method to lookup the name of a community given its id. |
int[] |
GetCommunityRestrictions()
Returns the communities the search was restricted to, if any. |
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)
|
static java.lang.String |
getDisplayableNameForType(AActivitySpace m_asOwner,
int classId)
|
int[] |
GetDocFolderRestrictions()
Returns the document folders the search was restricted to, if any. |
int |
GetDrilldownDepth()
Returns the number of drilldown steps the user has taken. |
SearchExecutionError |
GetError()
Returns any SearchExecutionError that occurred during the last search. |
int |
GetFirstDisplayableItem()
Returns the index of the first displayable item. |
java.lang.String |
GetFolderNameForID(int id,
boolean isAdmin)
Utility method to lookup the name of a folder given its id. |
java.lang.Object |
GetGroupIcon(int groupIdx)
Returns an icon (actually an HTMLImg) for the indicated group, or null if there is no appropriate icon. |
java.lang.String |
GetGroupName(int groupIdx)
Returns the name of the indicated group. |
XPHashtable |
GetGroupsForAncestorKey(java.lang.String ancestorKey)
Special-case method for use only by DrilldownView. |
boolean |
GetHasBeenSaved()
Returns true if this search has already been saved. |
boolean |
GetHasDisplayedObjects(int classID)
|
int |
GetHeaderID(int nCommunityID)
Return the headerID for the community; used when processing the style sheet. |
boolean |
GetIncludeSubfolders()
Returns true if the folder restrictions included subfolders. |
int |
GetItemsPerPage()
Returns the user's desired results per page. |
java.lang.String |
GetKWIC(int rank)
Returns the keyword-in-context (KWIC) information for a result. |
java.lang.String |
GetLanguageRestriction()
Returns the two-character code for the language restriction, if any, or null otherwise. |
java.lang.String |
GetLastDrilldownGroup()
Special-case method for use only by DrilldownView. |
java.lang.String |
GetLastGroupByField()
Returns the most recent categorization field |
java.lang.String |
GetMisspelledToken(int misspellingIndex)
Returns a single misspelled token. |
java.lang.String |
GetName()
Return the name of the MVC object. |
int |
GetNumCorrections(int misspellingIndex)
Returns the number of corrections for the indicated misspelling. |
int |
GetNumDisplayableItems()
Returns the number of results actually returned. |
int |
GetNumMisspelledTokens()
Returns the number of misspelled tokens. |
int |
GetNumResultGroups()
Returns the number of result groups. |
int[] |
GetObjectTypeRestrictions()
Returns the types (as PT_CLASSIDs) the search was restricted to, if any. |
java.lang.String |
GetPageMode()
SearchResultModel holds onto a "page mode" string for the benefit of client code.. |
java.lang.String |
GetPortletNameForID(int id)
Utility method to lookup the name of a portlet given its id. |
int[] |
GetPortletRestrictions()
Returns the Content Server portlets the search was restricted to, if any. |
XPHashtable |
GetReconstructionArgs()
Get URL arguments that are sufficient to reconstruct this search result if it has been flushed from the cache. |
XPHashtable |
GetReconstructionArgs(boolean wantPageContext)
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 |
GetResultAbsType(int rank)
Returns a result's abstract (app-independent) type: DOCUMENT, CONTAINER, or OTHER. |
java.lang.String |
GetResultApp(int rank)
Returns a result's application: PTPORTAL, PTCOLLAB, PTCONTENT. |
java.lang.String |
GetResultBestBetKey(int rank)
Returns an internal key used by Best Bets; do not call otherwise |
int |
GetResultClassID(int rank)
Returns a result's class ID. |
HTMLAnchor |
GetResultClickthroughURL(int rank,
boolean allowPopup)
Returns a view link that may be used for clickthrough. |
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 extraParams)
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. |
XPDateTime |
GetResultCreated(int rank)
Returns a result's creation date. |
HTMLAnchor |
GetResultEditLink(int rank,
boolean allowPopup)
Returns an edit link that may be used for clickthrough. |
java.lang.String |
GetResultEODField(int rank,
int propertyId)
Returns the value of an EOD property for a result. |
java.lang.Object |
GetResultEODFieldAsObject(int rank,
int propertyId)
|
int |
GetResultFolderID(int rank)
Returns the ID of the folder in which this result is found. |
java.lang.Object |
GetResultIcon(int rank)
Returns the icon corresponding to an item's application and class, and any other relevant info (i.e. |
XPDateTime |
GetResultLastModified(int rank)
Returns a result's last-modified date. |
java.lang.String |
GetResultName(int rank)
Returns a result's name. |
int |
GetResultObjectID(int rank)
Returns a result's object ID. |
java.lang.String |
GetResultPath(int rank)
Returns the full path to a result. |
java.lang.String |
GetResultPortletField(int rank,
int fieldId)
Returns the value of a gadget field for the result. |
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. |
int |
GetResultSize(int rank)
Returns a result's size. |
java.lang.String |
GetResultStyleClass(java.lang.String subType)
|
java.lang.String |
GetResultSubType(int rank)
Returns a result's app-specific subtype: PTCARD, PTGADGET, etc. |
java.lang.String |
GetResultTypeUUID(int rank)
|
int |
GetReturnedResultsInGroup(int groupIdx)
Returns the number of results in the indicated group that were actually returned. |
int |
GetSavedSearchErrorCode()
Returns an int that clients can set via ISaveSearchModel.setSavedSearchErrorCode() to communicate conditions like "a saved search already exists with that name". |
java.lang.String |
GetSavedSearchName()
Returns the name of the search if the search has been saved, or null otherwise. |
XPHashtable |
GetSearchAgainArgs(boolean includeOptional)
Returns arguments that can be used for a followup search with the same settings as the current search. |
java.lang.String |
GetSearchString()
Returns the user's original search string. |
int |
GetSelectedTypeFilter()
|
java.lang.String |
GetSortOrder()
Gets the property id that is currently used as the order by property in the model. |
java.lang.String |
GetSpellingCorrection(int misspellingIndex,
int correctionIndex)
Returns a single corrected token for the indicated misspelling. |
java.lang.String |
GetStyleSheet(int nCommunityID)
Return the stylesheet for the community; used when processing the style sheet. |
int |
GetTotalItems()
Returns the total number of items, some of which may not currently be displayable. |
java.lang.String |
GetTotalResultsInGroup(int groupIdx)
Returns the total number of results in the indicated group. |
SearchExecutionWarning |
GetWarning()
Returns any SearchExecutionWarning that occurred during the last search. |
void |
GoToPage(java.lang.String sortOrder,
int first,
int pageSize,
java.lang.Object additionalInfo)
Go to another page. |
boolean |
hasDrilledDownIntoSingleCategory(java.lang.String orgType)
Returns true if this model has been drilled down into a single category of the given organization scheme. |
void |
Init(AActivitySpace parent)
This method initializes the model. |
boolean |
isAdvancedSearch()
Returns true if this result was generated by an advanced search. |
boolean |
IsASTooComplexToSummarize()
Returns true if this advanced search consists of a nested set of clauses that are too complex to easily summarize. |
boolean |
isEntireGroupReturned(int groupIdx)
Returns true if all results in the group were returned. |
boolean |
IsInitialized()
Returns true if the model has been initialized (i.e. |
boolean |
isResultBestBet(int rank)
Returns true if a result is a Best Bet. |
protected java.lang.String |
localizeObjectTypeName(java.lang.String objType)
Helper method to convert an indexed object type or abstract type to its localized equivalent |
void |
RefreshResults(java.lang.String keyOnPage)
Rerun the search that generated the indicated page; call this following any action that may change the result set. |
void |
Reorganize(java.lang.String keyOnPage,
java.lang.String groupByField)
Perform a different categorization on the current result set |
void |
RestoreFromBreadcrumb(java.lang.String keyOfPageWhereLinkAppears,
java.lang.String keyToRestore)
Follow a breadcrumb link with the specified key. |
protected void |
restoreState(java.lang.String keyOnPage)
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. |
void |
Search(java.lang.String searchString,
java.lang.String basicFields,
IPTFilter advancedFilter,
SearchSettingCollection settings)
Initialize the model by running the provided query with the provided settings. |
void |
Search(java.lang.String searchString,
java.lang.String basicFields,
IPTFilter advancedFilter,
SearchSettingCollection settings,
SearchSettingCollection removableSettings)
Initialize the model by running the provided query with the provided settings (allSettings). |
void |
SearchWithinResults(java.lang.String keyOnPage,
java.lang.String additionalQuery)
Search within results already generated for the indicated additional query string. |
void |
SetError(SearchExecutionError e)
Tell the model that there was an error on the previous search. |
void |
SetPageMode(java.lang.String pageMode)
SearchResultModel holds onto a "page mode" string for the benefit of client code.. |
void |
SetSavedSearchErrorCode(int code)
Sets an int that clients can use to communicate conditions like "a saved search already exists with that name". |
void |
SetSavedSearchName(java.lang.String name)
Call to set a flag to indicate that this search has been saved, and the "save this search" link no longer should be displayed. |
void |
SetWarning(SearchExecutionWarning e)
Tell the model that there was a warning on the previous search. |
boolean |
wasSpellCorrected()
Returns true if the user's search phrase was spell-corrected. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String STR_MVC_CLASS_NAME
public static final java.lang.String MODEL_MODE_INPUT
public static final java.lang.String PORTAL_APP
public static final java.lang.String TEMPLATING_APP
public static final java.lang.String COLLAB_APP
public static final java.lang.String CONTENT_APP
public static final java.lang.String DOCUMENT_ABSTYPE
public static final java.lang.String CONTAINER_ABSTYPE
public static final java.lang.String OTHER_ABSTYPE
public static final java.lang.String SORTORDER_RELEVANCE
public static final java.lang.String SORTORDER_CREATED_ASC
public static final java.lang.String SORTORDER_CREATED_DESC
public static final java.lang.String SORTORDER_MODIFIED_ASC
public static final java.lang.String SORTORDER_MODIFIED_DESC
public static final java.lang.String SORTORDER_NAME_ASC
public static final java.lang.String SORTORDER_NAME_DESC
public static final java.lang.String GROUPBY_FOLDER
public static final java.lang.String GROUPBY_OBJECTTYPE
public static final java.lang.String GROUP_BY_PREFS_KEY
public static final java.lang.String UNKNOWN_FOLDER_NAME
protected IPTFilter _advancedFilter
protected java.lang.String _initialSearchString
protected boolean _initialBestBets
protected java.lang.String _initialGroupBy
protected java.lang.String _savedSearchName
protected java.lang.String _swrFields
protected boolean _isAdvancedSearch
protected java.lang.String _pageMode
protected int _pageSize
protected int _savedSearchErrorCode
protected int _swrCount
Constructor Detail |
---|
public SearchResultModel()
Method Detail |
---|
public boolean IsASTooComplexToSummarize()
ISearchQueryRO
IsASTooComplexToSummarize
in interface ISearchQueryRO
com.plumtree.portalpages.search.ISearchQueryRO.IsASTooComplexToSummarize()
public java.lang.String GetASConstraintOperator(int condition)
ISearchQueryRO
GetASConstraintOperator
in interface ISearchQueryRO
com.plumtree.portalpages.search.ISearchQueryRO.getASConstraintOperator()
public java.lang.String GetASConstraintProperty(int condition)
ISearchQueryRO
GetASConstraintProperty
in interface ISearchQueryRO
com.plumtree.portalpages.search.ISearchQueryRO.getASConstraintPropertyID()
public java.lang.String GetASConstraintValue(int condition)
ISearchQueryRO
GetASConstraintValue
in interface ISearchQueryRO
com.plumtree.portalpages.search.ISearchQueryRO.getASConstraintValue()
public int GetASNumPropertyConstraints()
ISearchQueryRO
GetASNumPropertyConstraints
in interface ISearchQueryRO
com.plumtree.portalpages.search.ISearchQueryRO.getASNumPropertyConstraints()
public boolean GetASPropertyClauseOperator()
ISearchQueryRO
GetASPropertyClauseOperator
in interface ISearchQueryRO
com.plumtree.portalpages.search.ISearchQueryRO.getASOverallPropertyOperator()
public boolean GetASTopLevelOperator()
ISearchQueryRO
GetASTopLevelOperator
in interface ISearchQueryRO
com.plumtree.portalpages.search.ISearchQueryRO.getASTopLevelOperator()
public int GetAbstractTypeRestrictions()
IBaseSearchQueryRO
GetAbstractTypeRestrictions
in interface IBaseSearchQueryRO
com.plumtree.portalpages.search.IBaseSearchQueryRO.getAbstractTypeRestrictions()
public int[] GetAdminFolderRestrictions()
IBaseSearchQueryRO
GetAdminFolderRestrictions
in interface IBaseSearchQueryRO
com.plumtree.portalpages.search.IBaseSearchQueryRO.getAdminFolderRestrictions()
public boolean isAdvancedSearch()
ISearchQueryRO
isAdvancedSearch
in interface ISearchQueryRO
com.plumtree.portalpages.search.ISearchQueryRO.isAdvancedSearch()
public int GetApplicationRestrictions()
IBaseSearchQueryRO
GetApplicationRestrictions
in interface IBaseSearchQueryRO
com.plumtree.portalpages.search.IBaseSearchQueryRO.getApplicationRestrictions()
public java.lang.String GetBreadcrumbKey(int step)
ISearchResultModelRO
GetBreadcrumbKey
in interface ISearchResultModelRO
com.plumtree.portalpages.search.ISearchResultModelRO.getBreadcrumbKey()
public java.lang.String GetBreadcrumbLabel(int step)
ISearchResultModelRO
GetBreadcrumbLabel
in interface ISearchResultModelRO
com.plumtree.portalpages.search.ISearchResultModelRO.getBreadcrumbLabel()
public java.lang.String GetCommunityNameForID(int id)
IBaseSearchQueryRO
GetCommunityNameForID
in interface IBaseSearchQueryRO
com.plumtree.portalpages.search.IBaseSearchQueryRO.getCommunityNameForID()
public java.lang.String GetPortletNameForID(int id)
IBaseSearchQueryRO
GetPortletNameForID
in interface IBaseSearchQueryRO
com.plumtree.portalpages.search.IBaseSearchQueryRO.GetPortletNameForID()
public int[] GetCommunityRestrictions()
IBaseSearchQueryRO
GetCommunityRestrictions
in interface IBaseSearchQueryRO
com.plumtree.portalpages.search.IBaseSearchQueryRO.getCommunityRestrictions()
public int[] GetPortletRestrictions()
IBaseSearchQueryRO
GetPortletRestrictions
in interface IBaseSearchQueryRO
com.plumtree.portalpages.search.IBaseSearchQueryRO.getPortletRestrictions()
public int[] GetCollabProjectRestrictions()
IBaseSearchQueryRO
GetCollabProjectRestrictions
in interface IBaseSearchQueryRO
com.plumtree.portalpages.search.IBaseSearchQueryRO.getCollabProjectRestrictions()
public java.lang.String GetStyleSheet(int nCommunityID)
public int GetHeaderID(int nCommunityID)
public int GetCorrectionFrequency(int misspellingIndex, int correctionIndex)
ISearchResultModelRO
GetCorrectionFrequency
in interface ISearchResultModelRO
com.plumtree.portalpages.search.ISearchResultModelRO.getCorrectionFrequency()
public java.lang.String GetCurrentKey()
ISearchResultModelRO
GetCurrentKey
in interface ISearchResultModelRO
com.plumtree.portalpages.search.ISearchResultModelRO.getCurrentKey()
public boolean hasDrilledDownIntoSingleCategory(java.lang.String orgType)
ISearchResultModelRO
hasDrilledDownIntoSingleCategory
in interface ISearchResultModelRO
com.plumtree.portalpages.search.ISearchResultModelRO.hasDrilledDownIntoSingleCategory()
public static java.lang.String getDisplayableNameForType(AActivitySpace m_asOwner, int classId)
m_asOwner
- classId
-
public int[] GetDocFolderRestrictions()
IBaseSearchQueryRO
GetDocFolderRestrictions
in interface IBaseSearchQueryRO
com.plumtree.portalpages.search.IBaseSearchQueryRO.getDocFolderRestrictions()
public int GetDrilldownDepth()
ISearchResultModelRO
GetDrilldownDepth
in interface ISearchResultModelRO
com.plumtree.portalpages.search.ISearchResultModelRO.getDrilldownDepth()
public boolean isEntireGroupReturned(int groupIdx)
ISearchResultModelRO
isEntireGroupReturned
in interface ISearchResultModelRO
com.plumtree.portalpages.search.ISearchResultModelRO.isEntireGroupReturned()
public java.lang.String GetFolderNameForID(int id, boolean isAdmin)
IBaseSearchQueryRO
GetFolderNameForID
in interface IBaseSearchQueryRO
com.plumtree.portalpages.search.IBaseSearchQueryRO.getFolderNameForID()
public java.lang.String GetGroupName(int groupIdx)
ISearchResultModelRO
GetGroupName
in interface ISearchResultModelRO
com.plumtree.portalpages.search.ISearchResultModelRO.getGroupName()
public java.lang.Object GetGroupIcon(int groupIdx)
ISearchResultModelRO
GetGroupIcon
in interface ISearchResultModelRO
com.plumtree.portalpages.search.ISearchResultModelRO.GetGroupIcon()
public XPHashtable GetGroupsForAncestorKey(java.lang.String ancestorKey)
public java.lang.String GetLastDrilldownGroup()
public boolean GetHasBeenSaved()
ISaveSearchModelRO
GetHasBeenSaved
in interface ISaveSearchModelRO
com.plumtree.portalpages.search.ISaveSearchModelRO.GetHasBeenSaved()
public boolean GetIncludeSubfolders()
IBaseSearchQueryRO
GetIncludeSubfolders
in interface IBaseSearchQueryRO
com.plumtree.portalpages.search.IBaseSearchQueryRO.getIncludeSubfolders()
public java.lang.String GetKWIC(int rank)
IBaseSearchResultModelRO
GetKWIC
in interface IBaseSearchResultModelRO
com.plumtree.portalpages.search.ISearchResultModelRO.getKWIC()
public java.lang.String GetLanguageRestriction()
IBaseSearchQueryRO
GetLanguageRestriction
in interface IBaseSearchQueryRO
com.plumtree.portalpages.search.IBaseSearchQueryRO.getLanguageRestriction()
public java.lang.String GetLastGroupByField()
ISearchResultModelRO
GetLastGroupByField
in interface ISearchResultModelRO
com.plumtree.portalpages.search.ISearchResultModelRO.getLastGroupByField()
public void SetPageMode(java.lang.String pageMode)
ISearchResultModel
SetPageMode
in interface ISearchResultModel
com.plumtree.portaluiinfrastructure.search.ISearchResultModel.SetPageMode()
public java.lang.String GetPageMode()
ISearchResultModelRO
GetPageMode
in interface ISearchResultModelRO
com.plumtree.portaluiinfrastructure.search.ISearchResultModelRO.GetPageMode()
public java.lang.String GetMisspelledToken(int misspellingIndex)
ISearchResultModelRO
GetMisspelledToken
in interface ISearchResultModelRO
com.plumtree.portalpages.search.ISearchResultModelRO.getMisspelledToken()
public int GetNumCorrections(int misspellingIndex)
ISearchResultModelRO
GetNumCorrections
in interface ISearchResultModelRO
com.plumtree.portalpages.search.ISearchResultModelRO.getNumCorrections()
public int GetNumMisspelledTokens()
ISearchResultModelRO
GetNumMisspelledTokens
in interface ISearchResultModelRO
com.plumtree.portalpages.search.ISearchResultModelRO.getNumMisspelledTokens()
public int GetNumResultGroups()
ISearchResultModelRO
GetNumResultGroups
in interface ISearchResultModelRO
com.plumtree.portalpages.search.ISearchResultModelRO.getNumResultGroups()
public int[] GetObjectTypeRestrictions()
IBaseSearchQueryRO
GetObjectTypeRestrictions
in interface IBaseSearchQueryRO
com.plumtree.portalpages.search.IBaseSearchQueryRO.getObjectTypeRestrictions()
public XPHashtable GetReconstructionArgs()
ISearchResultModelRO
GetReconstructionArgs
in interface ISearchResultModelRO
com.plumtree.portalpages.search.ISearchResultModelRO.getReconstructionArgs()
public XPHashtable GetReconstructionArgs(boolean wantPageContext)
ISearchResultModelRO
GetReconstructionArgs
in interface ISearchResultModelRO
com.plumtree.portalpages.search.ISearchResultModelRO.getReconstructionArgs()
public XPHashtable GetReconstructionArgs(java.lang.String prefix, boolean wantPageContext)
GetReconstructionArgs
in interface ISearchResultModelRO
com.plumtree.portalpages.search.ISearchResultModelRO.getReconstructionArgs()
public java.lang.String GetResultAbsType(int rank)
IBaseSearchResultModelRO
GetResultAbsType
in interface IBaseSearchResultModelRO
com.plumtree.portalpages.search.ISearchResultModelRO.getResultAbsType()
public java.lang.String GetResultApp(int rank)
IBaseSearchResultModelRO
GetResultApp
in interface IBaseSearchResultModelRO
com.plumtree.portalpages.search.ISearchResultModelRO.getResultApp()
public boolean isResultBestBet(int rank)
IBaseSearchResultModelRO
isResultBestBet
in interface IBaseSearchResultModelRO
com.plumtree.portalpages.search.ISearchResultModelRO.getResultName()
public java.lang.String GetResultBestBetKey(int rank)
ISearchResultModelRO
GetResultBestBetKey
in interface ISearchResultModelRO
com.plumtree.portalpages.search.ISearchResultModelRO.getResultBestBetKey()
public int GetResultClassID(int rank)
IBaseSearchResultModelRO
GetResultClassID
in interface IBaseSearchResultModelRO
com.plumtree.portalpages.search.ISearchResultModelRO.getResultClassID()
public HTMLAnchor GetResultEditLink(int rank, boolean allowPopup) throws SearchModelException
GetResultEditLink
in interface ISearchResultModelRO
SearchModelException
public HTMLAnchor GetResultClickthroughURL(int rank, boolean allowPopup)
GetResultClickthroughURL
in interface ISearchResultModelRO
public HTMLAnchor GetResultClickthroughURL(int rank, boolean allowPopup, boolean editMode)
ISearchResultModelRO
GetResultClickthroughURL
in interface ISearchResultModelRO
com.plumtree.portalpages.search.ISearchResultModelRO.getResultClickthroughURL()
public HTMLAnchor GetResultClickthroughURL(int rank, boolean allowPopup, boolean editMode, java.lang.String extraParams)
ISearchResultModelRO
GetResultClickthroughURL
in interface ISearchResultModelRO
com.plumtree.portalpages.search.ISearchResultModelRO.getResultClickthroughURL()
public java.lang.String GetResultCollabProjectName(int rank)
ISearchResultModelRO
GetResultCollabProjectName
in interface ISearchResultModelRO
com.plumtree.portaluiinfrastructure.search.ISearchResultModelRO.GetResultCollabProjectName()
public java.lang.String GetResultCollabProjectURL(int rank)
ISearchResultModelRO
GetResultCollabProjectURL
in interface ISearchResultModelRO
com.plumtree.portalpages.search.ISearchResultModelRO.getResultCollabProjectURL()
public java.lang.String GetResultPortletField(int rank, int fieldId)
IBaseSearchResultModelRO
GetResultPortletField
in interface IBaseSearchResultModelRO
com.plumtree.portalpages.search.IBaseSearchResultModelRO.GetResultPortletField()
public java.lang.String GetResultContentLastPubUser(int rank)
ISearchResultModelRO
GetResultContentLastPubUser
in interface ISearchResultModelRO
com.plumtree.portalpages.search.ISearchResultModelRO.getResultContentLastPubUser()
public int[] GetResultContentPortletIDs(int rank)
ISearchResultModelRO
GetResultContentPortletIDs
in interface ISearchResultModelRO
com.plumtree.portalpages.search.ISearchResultModelRO.getResultContentPortletIDs()
public XPDateTime GetResultCreated(int rank)
IBaseSearchResultModelRO
GetResultCreated
in interface IBaseSearchResultModelRO
com.plumtree.portalpages.search.ISearchResultModelRO.getResultCreated()
public java.lang.String GetResultEODField(int rank, int propertyId)
IBaseSearchResultModelRO
GetResultEODField
in interface IBaseSearchResultModelRO
com.plumtree.portalpages.search.ISearchResultModelRO.getResultField()
public java.lang.Object GetResultEODFieldAsObject(int rank, int propertyId)
public int GetResultFolderID(int rank)
IBaseSearchResultModelRO
GetResultFolderID
in interface IBaseSearchResultModelRO
com.plumtree.portalpages.search.ISearchResultModelRO.getResultFolderID()
public void ExternalLightInitialization(IPTSearchResponse sr, AActivitySpace asSpace)
public java.lang.Object GetResultIcon(int rank)
IBaseSearchResultModelRO
GetResultIcon
in interface IBaseSearchResultModelRO
com.plumtree.portalpages.search.ISearchResultModelRO.getResultIcon()
public XPDateTime GetResultLastModified(int rank)
IBaseSearchResultModelRO
GetResultLastModified
in interface IBaseSearchResultModelRO
com.plumtree.portalpages.search.ISearchResultModelRO.getResultLastModified()
public java.lang.String GetResultName(int rank)
IBaseSearchResultModelRO
GetResultName
in interface IBaseSearchResultModelRO
com.plumtree.portalpages.search.ISearchResultModelRO.getResultName()
public int GetResultObjectID(int rank)
IBaseSearchResultModelRO
GetResultObjectID
in interface IBaseSearchResultModelRO
com.plumtree.portalpages.search.ISearchResultModelRO.getResultObjectID()
public java.lang.String GetResultPath(int rank)
IBaseSearchResultModelRO
GetResultPath
in interface IBaseSearchResultModelRO
com.plumtree.portalpages.search.ISearchResultModelRO.getResultPath()
public HTMLAnchor GetResultPropertiesURL(int rank, boolean allowPopup)
ISearchResultModelRO
GetResultPropertiesURL
in interface ISearchResultModelRO
com.plumtree.portalpages.search.ISearchResultModelRO.getResultPropertiesURL()
public int GetResultRank(int groupNum, int resultNum)
ISearchResultModelRO
GetResultRank
in interface ISearchResultModelRO
com.plumtree.portalpages.search.ISearchResultModelRO.getResultRank()
public int GetResultSize(int rank)
IBaseSearchResultModelRO
GetResultSize
in interface IBaseSearchResultModelRO
com.plumtree.portalpages.search.ISearchResultModelRO.getResultSize()
public java.lang.String GetResultSubType(int rank)
IBaseSearchResultModelRO
GetResultSubType
in interface IBaseSearchResultModelRO
com.plumtree.portalpages.search.ISearchResultModelRO.getResultSubType()
public java.lang.String GetResultStyleClass(java.lang.String subType)
GetResultStyleClass
in interface ISearchResultModelRO
ISearchResultModelRO.GetResultStyleClass(java.lang.String)
public java.lang.String GetResultTypeUUID(int rank)
rank
-
public int GetReturnedResultsInGroup(int groupIdx)
ISearchResultModelRO
GetReturnedResultsInGroup
in interface ISearchResultModelRO
com.plumtree.portalpages.search.ISearchResultModelRO.getReturnedResultsInGroup()
public void SetSavedSearchErrorCode(int code)
ISaveSearchModel
SetSavedSearchErrorCode
in interface ISaveSearchModel
com.plumtree.portalpages.search.ISaveSearchModel.SetSavedSearchErrorCode()
public int GetSavedSearchErrorCode()
ISaveSearchModelRO
GetSavedSearchErrorCode
in interface ISaveSearchModelRO
com.plumtree.portalpages.search.ISaveSearchModelRO.GetSavedSearchErrorCode()
public void SetSavedSearchName(java.lang.String name)
ISaveSearchModel
SetSavedSearchName
in interface ISaveSearchModel
com.plumtree.portalpages.search.ISaveSearchModel.SetSavedSearchName()
public java.lang.String GetSavedSearchName()
ISaveSearchModelRO
GetSavedSearchName
in interface ISaveSearchModelRO
com.plumtree.portalpages.search.ISaveSearchModelRO.GetSavedSearchName()
public XPHashtable GetSearchAgainArgs(boolean includeOptional)
ISearchResultModelRO
GetSearchAgainArgs
in interface ISearchResultModelRO
com.plumtree.portalpages.search.ISearchResultModelRO.getSearchAgainArgs()
public java.lang.String GetSearchString()
IBaseSearchQueryRO
GetSearchString
in interface IBaseSearchQueryRO
com.plumtree.portalpages.search.IBaseSearchQueryRO.getSearchString()
public java.lang.String GetSpellingCorrection(int misspellingIndex, int correctionIndex)
ISearchResultModelRO
GetSpellingCorrection
in interface ISearchResultModelRO
com.plumtree.portalpages.search.ISearchResultModelRO.getSpellingCorrection()
public java.lang.String GetTotalResultsInGroup(int groupIdx)
ISearchResultModelRO
GetTotalResultsInGroup
in interface ISearchResultModelRO
com.plumtree.portalpages.search.ISearchResultModelRO.getTotalResultsInGroup()
public void CleanupTempData()
IModel
CleanupTempData
in interface IModel
IModel.CleanupTempData()
public void CleanupAllData()
IModel
CleanupAllData
in interface IModel
IModel.CleanupAllData()
public java.lang.Object Create()
IManagedObject
Create
in interface IManagedObject
IManagedObject.Create()
public void Drilldown(java.lang.String keyOnPage, java.lang.String groupByField, int category) throws SearchExecutionException
ISearchResultModel
Drilldown
in interface ISearchResultModel
SearchExecutionException
com.plumtree.portalpages.search.ISearchResultModel.Drilldown()
public SearchExecutionError GetError()
IBaseSearchResultModelRO
GetError
in interface IBaseSearchResultModelRO
com.plumtree.portalpages.search.IBaseSearchResultModelRO.GetError()
public int GetFirstDisplayableItem()
IPaginationRO
GetFirstDisplayableItem
in interface IPaginationRO
IPaginationRO.GetFirstDisplayableItem()
public int GetItemsPerPage()
IPaginationRO
GetItemsPerPage
in interface IPaginationRO
IPaginationRO.GetItemsPerPage()
public java.lang.String GetName()
IMVCObject
GetName
in interface IMVCObject
com.plumtree.portaluiinfrastructure.activityspace.IModelRO#GetName()
public int GetNumDisplayableItems()
IPaginationRO
GetNumDisplayableItems
in interface IPaginationRO
IPaginationRO.GetNumDisplayableItems()
public SearchSettingCollection GetRemovableSettings()
ISearchResultModelRO
GetRemovableSettings
in interface ISearchResultModelRO
com.plumtree.portalpages.search.ISearchResultModelRO.GetRemovableSettings()
public java.lang.String GetSortOrder()
ISearchResultModel
GetSortOrder
in interface ISearchResultModel
GetSortOrder
in interface IPaginationRO
IPaginationRO.GetItemsPerPage()
public int GetTotalItems()
IPaginationRO
GetTotalItems
in interface IPaginationRO
IPaginationRO.GetTotalItems()
public SearchExecutionWarning GetWarning()
IBaseSearchResultModelRO
GetWarning
in interface IBaseSearchResultModelRO
com.plumtree.portalpages.search.IBaseSearchResultModelRO.GetWarning()
public void RefreshResults(java.lang.String keyOnPage)
ISearchResultModel
RefreshResults
in interface ISearchResultModel
com.plumtree.portalpages.search.ISearchResultModel.RefreshResults()
public boolean GetHasDisplayedObjects(int classID)
public void ChangeSortOrder(java.lang.String sortOrder, java.lang.Object additionalInfo)
ChangeSortOrder
in interface ISearchResultModel
sortOrder
- additionalInfo
- public void GoToPage(java.lang.String sortOrder, int first, int pageSize, java.lang.Object additionalInfo)
IPagination
GoToPage
in interface IPagination
sortOrder
- Sort order in which firstItemOnPage should be interpretedfirst
- First item to appear on page (1-based)pageSize
- Desired number of items on pageadditionalInfo
- Additional application-specific info, if neededIPagination.GoToPage(java.lang.String, int, int, java.lang.Object)
public void Init(AActivitySpace parent)
IModel
Init
in interface IModel
parent
- the parent Activity Spacecom.plumtree.portaluiinfrastructure.activityspace.IModel#Init(AActivitySpace)
public boolean IsInitialized()
IBaseSearchResultModelRO
IsInitialized
in interface IBaseSearchResultModelRO
IsInitialized
in interface ISearchResultModel
com.plumtree.portalpages.search.ISearchResultModel.isInitialized()
public void Reorganize(java.lang.String keyOnPage, java.lang.String groupByField) throws SearchExecutionException
ISearchResultModel
Reorganize
in interface ISearchResultModel
SearchExecutionException
com.plumtree.portalpages.search.ISearchResultModel.Reorganize
public void RestoreFromBreadcrumb(java.lang.String keyOfPageWhereLinkAppears, java.lang.String keyToRestore) throws SearchExecutionException
ISearchResultModel
RestoreFromBreadcrumb
in interface ISearchResultModel
SearchExecutionException
com.plumtree.portalpages.search.ISearchResultModel.RestoreFromBreadcrumb()
public void Search(java.lang.String searchString, java.lang.String basicFields, IPTFilter advancedFilter, SearchSettingCollection settings) throws SearchExecutionException
ISearchResultModel
Search
in interface ISearchResultModel
SearchExecutionException
com.plumtree.portalpages.search.ISearchResultModel.Search()
public void Search(java.lang.String searchString, java.lang.String basicFields, IPTFilter advancedFilter, SearchSettingCollection settings, SearchSettingCollection removableSettings) throws SearchExecutionException
ISearchResultModel
Search
in interface ISearchResultModel
SearchExecutionException
com.plumtree.portalpages.search.ISearchResultModel.Search()
public void SearchWithinResults(java.lang.String keyOnPage, java.lang.String additionalQuery) throws SearchExecutionException
ISearchResultModel
SearchWithinResults
in interface ISearchResultModel
SearchExecutionException
com.plumtree.portalpages.search.ISearchResultModel.SearchWithinResults()
public void SetError(SearchExecutionError e)
ISearchResultModel
SetError
in interface ISearchResultModel
com.plumtree.portalpages.search.ISearchResultModel.SetError()
public void SetWarning(SearchExecutionWarning e)
ISearchResultModel
SetWarning
in interface ISearchResultModel
com.plumtree.portalpages.search.ISearchResultModel.SetError()
public boolean wasSpellCorrected()
ISearchResultModelRO
wasSpellCorrected
in interface ISearchResultModelRO
com.plumtree.portalpages.search.ISearchResultModelRO.wasSpellCorrected()
protected void doSearch(IPTSearchQuery additionalQuery, java.lang.String additionalBreadcrumb, java.lang.String newKey) throws SearchExecutionException
SearchExecutionException
protected java.lang.String localizeObjectTypeName(java.lang.String objType)
protected void restoreState(java.lang.String keyOnPage) throws SearchExecutionException
SearchExecutionException
public static XPDateTime ConvertSearchDateTimeToXPDateTime(double searchTime)
public XPDateFormat GetDateFormat(AActivitySpace owner)
GetDateFormat
in interface ISearchResultModelRO
public void Filter(java.lang.String key, int filterId)
ISearchResultModel
Filter
in interface ISearchResultModel
public boolean ContentInstalled()
ContentInstalled
in interface ISearchResultModelRO
public boolean CollabInstalled()
CollabInstalled
in interface ISearchResultModelRO
public int GetSelectedTypeFilter()
GetSelectedTypeFilter
in interface ISearchResultModelRO
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |