Plumtree Portal UI  
 

IBaseSearchResultModelRO Members

IBaseSearchResultModelRO overview

Public Instance Methods

GetError Returns any SearchExecutionError that occurred during the last search. If this is non-null, then no search results are available (and calling any of the getResultXXX methods will result in throwing another exception). This error should be displayed to the user in some way.
GetKWIC Returns the keyword-in-context (KWIC) information for a result. This method html-encodes always returns an html-encoded result, except that keywords are surrounded by highlighting tags. Note that html-encoding is NOT applied to the return value of any other method from this interface.
GetResultAbsType Returns a result's abstract (app-independent) type: DOCUMENT, CONTAINER, or OTHER.
GetResultApp Returns a result's application: PTPORTAL, PTCOLLAB, PTCONTENT.
GetResultClassID Returns a result's class ID. Defined for portal objects only, returns -1 for other types.
GetResultCreated Returns a result's creation date.
GetResultEODField Returns the value of an EOD property for a result.
GetResultFolderID Returns the ID of the folder in which this result is found.
GetResultIcon Returns the icon corresponding to an item's application and class, and any other relevant info (i.e. file extension) This actually returns an HTMLImg.
GetResultLastModified Returns a result's last-modified date.
GetResultName Returns a result's name.
GetResultObjectID Returns a result's object ID. Defined for portal objects only, returns -1 for other types.
GetResultPath Returns the full path to a result.
GetResultPortletField Returns the value of a gadget field for the result. Portlet fields are a small set of special case fields: PT_SEARCH_INTERNAL_FIELD.PT_SEARCH_IF_GADGET_TYPE PT_SEARCH_INTERNAL_FIELD.PT_SEARCH_IF_GADGET_ALIGNMENT PT_SEARCH_INTERNAL_FIELD.PT_SEARCH_IF_GADGET_USER_INTERFACES
GetResultSize Returns a result's size.
GetResultSubType Returns a result's app-specific subtype: PTCARD, PTGADGET, etc.
GetWarning Returns any SearchExecutionWarning that occurred during the last search. If this is non-null, then the warning should be displayed to the user, but some search results are still available (they may not be complete or may not match the user's expectations).
IsInitialized Returns true if the model has been initialized (i.e. if a search has been run).
isResultBestBet Returns true if a result is a Best Bet.

See Also

IBaseSearchResultModelRO Interface | com.plumtree.portaluiinfrastructure.search Namespace