com.plumtree.portaluiinfrastructure.search
Interface ISearchResultModel

All Superinterfaces:
IManagedObject, IModel, IModelRO, IMVCObject, IPagination, ISaveSearchModel
All Known Implementing Classes:
SearchResultModel

public interface ISearchResultModel
extends IModel, IPagination, ISaveSearchModel

Author:
CraigS

Method Summary
 void ChangeSortOrder(java.lang.String sortOrder, java.lang.Object additionalInfo)
          Update sort order
 void Drilldown(java.lang.String key, java.lang.String groupByField, int category)
          Drill down into the indicated category.
 void Filter(java.lang.String key, int filterId)
          Filter the search result based on the filterId
 java.lang.String GetSortOrder()
          Gets the property id that is currently used as the order by property in the model.
 boolean IsInitialized()
          Returns true if the model has been initialized (i.e.
 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 key, 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.
 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 allSettings, SearchSettingCollection removableSettings)
          Initialize the model by running the provided query with the provided settings (allSettings).
 void SearchWithinResults(java.lang.String key, 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 SetWarning(SearchExecutionWarning e)
          Tell the model that there was a warning on the previous search.
 
Methods inherited from interface com.plumtree.uiinfrastructure.activityspace.IModel
CleanupAllData, CleanupTempData, Init
 
Methods inherited from interface com.plumtree.uiinfrastructure.activityspace.IMVCObject
GetName
 
Methods inherited from interface com.plumtree.uiinfrastructure.activityspace.IManagedObject
Create
 
Methods inherited from interface com.plumtree.uiinfrastructure.pagination.IPagination
GoToPage
 
Methods inherited from interface com.plumtree.portaluiinfrastructure.search.ISaveSearchModel
SetSavedSearchErrorCode, SetSavedSearchName
 

Method Detail

SetPageMode

void SetPageMode(java.lang.String pageMode)
SearchResultModel holds onto a "page mode" string for the benefit of client code.. it doesn't care about the contents.


Drilldown

void Drilldown(java.lang.String key,
               java.lang.String groupByField,
               int category)
Drill down into the indicated category. Pass in the groupby field that was used to generate the set of categories you are using; the model should validate that it is using the right categories.


IsInitialized

boolean IsInitialized()
Returns true if the model has been initialized (i.e. if a search has been run). This could be in ISearchResultModelRO, but is here for convenience, since the caller probably needs to call Search() if this returns false.


Reorganize

void Reorganize(java.lang.String key,
                java.lang.String groupByField)
Perform a different categorization on the current result set


ChangeSortOrder

void ChangeSortOrder(java.lang.String sortOrder,
                     java.lang.Object additionalInfo)
Update sort order

Parameters:
sortOrder -
additionalInfo -

RestoreFromBreadcrumb

void RestoreFromBreadcrumb(java.lang.String keyOfPageWhereLinkAppears,
                           java.lang.String keyToRestore)
Follow a breadcrumb link with the specified key.


Search

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.


Search

void Search(java.lang.String searchString,
            java.lang.String basicFields,
            IPTFilter advancedFilter,
            SearchSettingCollection allSettings,
            SearchSettingCollection removableSettings)
Initialize the model by running the provided query with the provided settings (allSettings). removableSettings, if non-null, are those settings that may be removed on a followup search.


SearchWithinResults

void SearchWithinResults(java.lang.String key,
                         java.lang.String additionalQuery)
Search within results already generated for the indicated additional query string.


RefreshResults

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.


SetError

void SetError(SearchExecutionError e)
Tell the model that there was an error on the previous search.


SetWarning

void SetWarning(SearchExecutionWarning e)
Tell the model that there was a warning on the previous search.


Filter

void Filter(java.lang.String key,
            int filterId)
Filter the search result based on the filterId


GetSortOrder

java.lang.String GetSortOrder()
Gets the property id that is currently used as the order by property in the model.

Returns:
Property Id as a string



Copyright 2002,2003,2004,2005 Plumtree Software, Inc., All Rights Reserved.