com.plumtree.portaluiinfrastructure.search
Interface IBaseSearchResultModelRO

All Superinterfaces:

IBaseSearchQueryRO, IModelRO, IMVCObject, IPaginationRO

All Known Subinterfaces:

ISearchResultModelRO

All Known Implementing Classes:

SearchResultModel

public interface IBaseSearchResultModelRO
extends IModelRO, IPaginationRO, IBaseSearchQueryRO

Author:

CraigS

Method Summary

SearchExecutionError	GetError() Returns any SearchExecutionError that occurred during the last search.
java.lang.String	GetKWIC(int rank) Returns the keyword-in-context (KWIC) information for a result.
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.
int	GetResultClassID(int rank) Returns a result's class ID.
XPDateTime	GetResultCreated(int rank) Returns a result's creation date.
java.lang.String	GetResultEODField(int rank, int propertyId) Returns the value of an EOD property for a result.
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.
int	GetResultSize(int rank) Returns a result's size.
java.lang.String	GetResultSubType(int rank) Returns a result's app-specific subtype: PTCARD, PTGADGET, etc.
SearchExecutionWarning	GetWarning() Returns any SearchExecutionWarning that occurred during the last search.
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.

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.IBaseSearchQueryRO

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

Method Detail

GetKWIC

java.lang.String GetKWIC(int rank)

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

java.lang.String GetResultAbsType(int rank)

Returns a result's abstract (app-independent) type: DOCUMENT, CONTAINER, or OTHER.

GetResultApp

java.lang.String GetResultApp(int rank)

Returns a result's application: PTPORTAL, PTCOLLAB, PTCONTENT.

isResultBestBet

boolean isResultBestBet(int rank)

Returns true if a result is a Best Bet.

GetResultClassID

int GetResultClassID(int rank)

Returns a result's class ID. Defined for portal objects only, returns -1 for other types.

GetResultPortletField

java.lang.String GetResultPortletField(int rank,
                                       int fieldId)

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

GetResultCreated

XPDateTime GetResultCreated(int rank)

Returns a result's creation date.

GetResultEODField

java.lang.String GetResultEODField(int rank,
                                   int propertyId)

Returns the value of an EOD property for a result.

GetResultFolderID

int GetResultFolderID(int rank)

Returns the ID of the folder in which this result is found.

GetResultIcon

java.lang.Object GetResultIcon(int rank)

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

XPDateTime GetResultLastModified(int rank)

Returns a result's last-modified date.

GetResultName

java.lang.String GetResultName(int rank)

Returns a result's name.

GetResultObjectID

int GetResultObjectID(int rank)

Returns a result's object ID. Defined for portal objects only, returns -1 for other types.

GetResultPath

java.lang.String GetResultPath(int rank)

Returns the full path to a result.

GetResultSize

int GetResultSize(int rank)

Returns a result's size.

GetResultSubType

java.lang.String GetResultSubType(int rank)

Returns a result's app-specific subtype: PTCARD, PTGADGET, etc.

GetError

SearchExecutionError 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.

GetWarning

SearchExecutionWarning 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

boolean IsInitialized()

Returns true if the model has been initialized (i.e. if a search has been run).