com.plumtree.portalpages.browsing.search.results
Class SearchSummaryView

java.lang.Object
  extended by com.plumtree.portalpages.browsing.search.results.SearchResultView
      extended by com.plumtree.portalpages.browsing.search.results.SearchSummaryView
All Implemented Interfaces:
IManagedObject, IMVCObject, IView

public class SearchSummaryView
extends SearchResultView

Author:
CraigS

Field Summary
protected  SearchPageModeHelper _pageMode
           
static java.lang.String STR_MVC_CLASS_NAME
           
 
Fields inherited from class com.plumtree.portalpages.browsing.search.results.SearchResultView
_model, m_asOwner, SPACE, SPACE2, SPACE3, SPACE4
 
Constructor Summary
SearchSummaryView()
           
 
Method Summary
static void AssembleUniqueMisspellingsAndCorrections(ISearchResultModelRO model, IXPList misspelledTokens, IXPList correctionsPerMisspelling)
          Assembles the list of spelling corrections given two empty lists.
 java.lang.Object Create()
          This method is used by the ASManager to return new instances of managed objects.
 HTMLElement DisplaySearchView()
          DisplaySearchView() should be implemented by all subclasses and should perform the same function as the regular Display() method, but is allowed to throw a SearchModelException or an HTMLException.
 java.lang.String GetName()
          Return the name of the MVC object.
static XPArrayList GetObjectTypeRestrictionsList(ISearchResultModelRO model, AActivitySpace asOwner)
          Returns the list of current object type restrictions.
 void LogSearchResultsEvent()
          Method to log the search result event.
 void SetPageModeHelper(SearchPageModeHelper pageMode)
           
static void ShowNumberOfResults(AActivitySpace owner, HTMLTableCell cell, IBaseSearchResultModelRO model)
          Shows a summary of the number of results and how many are being displayed.
 
Methods inherited from class com.plumtree.portalpages.browsing.search.results.SearchResultView
Display, DisplayJavascript, Init, is508
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

STR_MVC_CLASS_NAME

public static final java.lang.String STR_MVC_CLASS_NAME
See Also:
Constant Field Values

_pageMode

protected SearchPageModeHelper _pageMode
Constructor Detail

SearchSummaryView

public SearchSummaryView()
Method Detail

SetPageModeHelper

public void SetPageModeHelper(SearchPageModeHelper pageMode)

Create

public java.lang.Object Create()
Description copied from class: SearchResultView
This method is used by the ASManager to return new instances of managed objects.

Specified by:
Create in interface IManagedObject
Specified by:
Create in class SearchResultView
Returns:
A new instance of the managed class (i.e. return new Foo();)
See Also:
IManagedObject.Create()

DisplaySearchView

public HTMLElement DisplaySearchView()
Description copied from class: SearchResultView
DisplaySearchView() should be implemented by all subclasses and should perform the same function as the regular Display() method, but is allowed to throw a SearchModelException or an HTMLException. SearchModelException indicates a problem with usage of the portalinfrastructure classes, not a problem with the search itself (which are SearchExecutionExceptions; call ISearchResultModelRO.GetError()).

Specified by:
DisplaySearchView in class SearchResultView
See Also:
com.plumtree.portalpages.search.SearchResultView#DisplaySearchView()

AssembleUniqueMisspellingsAndCorrections

public static void AssembleUniqueMisspellingsAndCorrections(ISearchResultModelRO model,
                                                            IXPList misspelledTokens,
                                                            IXPList correctionsPerMisspelling)
Assembles the list of spelling corrections given two empty lists.

Parameters:
model - Search results model
misspelledTokens - List to which misspelled tokens are added
correctionsPerMisspelling - List to which corrections are added

GetObjectTypeRestrictionsList

public static XPArrayList GetObjectTypeRestrictionsList(ISearchResultModelRO model,
                                                        AActivitySpace asOwner)
Returns the list of current object type restrictions.

Parameters:
model - Search Results model
asOwner - Current activity space
Returns:
List of object types to show

GetName

public java.lang.String GetName()
Description copied from interface: IMVCObject
Return the name of the MVC object.

Specified by:
GetName in interface IMVCObject
Specified by:
GetName in class SearchResultView
Returns:
the name of the object.
See Also:
com.plumtree.portaluiinfrastructure.activityspace.IView#GetName()

ShowNumberOfResults

public static void ShowNumberOfResults(AActivitySpace owner,
                                       HTMLTableCell cell,
                                       IBaseSearchResultModelRO model)
Shows a summary of the number of results and how many are being displayed.

Parameters:
owner - Current activity space
cell - Cell to which to add the summary text
model - Search results model.

LogSearchResultsEvent

public void LogSearchResultsEvent()
Method to log the search result event.




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