com.plumtree.portaluiinfrastructure.search
Class DrilldownControl

java.lang.Object
  extended by com.plumtree.portaluiinfrastructure.search.SearchResultControl
      extended by com.plumtree.portaluiinfrastructure.search.DrilldownControl
All Implemented Interfaces:
IControl, IManagedObject, IMVCObject

public class DrilldownControl
extends SearchResultControl

Author:
CraigS

Field Summary
static java.lang.String CATEGORY_DATA
           
static java.lang.String CATEGORY_FOR_NO_DRILLDOWN
           
static java.lang.String GROUPBY_DATA
           
static java.lang.String STR_MVC_CLASS_NAME
           
 
Fields inherited from class com.plumtree.portaluiinfrastructure.search.SearchResultControl
_model, _parent, BASIC_FIELDS, KEY_DATA, PARTIAL_SEARCH, RECONSTRUCTION_ARGS_PREFIX, RECONSTRUCTION_PREFIX_LENGTH, USER_QUERY
 
Constructor Summary
DrilldownControl()
           
 
Method Summary
 java.lang.Object Create()
          This method is used by the ASManager to return new instances of managed objects.
protected  Redirect ExecuteSearchControl(XPHashtable args, java.lang.String key)
          Execute method that subclasses should implement; unlike Execute() it's allowed to throw a SearchExecutionException.
 java.lang.String GetName()
          Return the name of the MVC object.
static HTMLElement makeURL(ISearchResultModelRO model, AActivitySpace parent, HTMLElement linkText, int category)
          Factory method to make a drilldown link.
static HTMLElement makeURL(ISearchResultModelRO model, AActivitySpace parent, java.lang.String linkText, int category)
          Factory method to make a drilldown link.
 
Methods inherited from class com.plumtree.portaluiinfrastructure.search.SearchResultControl
addCommonData, CheckActionSecurityAndExecute, expectModelInitialized, Init, parseQueryArgs, SpaceNeedsPassthruURL
 
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

CATEGORY_DATA

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

GROUPBY_DATA

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

CATEGORY_FOR_NO_DRILLDOWN

public static final java.lang.String CATEGORY_FOR_NO_DRILLDOWN
See Also:
Constant Field Values
Constructor Detail

DrilldownControl

public DrilldownControl()
Method Detail

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 SearchResultControl
Returns:
the name of the object.
See Also:
com.plumtree.portaluiinfrastructure.activityspace.IControl#GetName()

makeURL

public static HTMLElement makeURL(ISearchResultModelRO model,
                                  AActivitySpace parent,
                                  java.lang.String linkText,
                                  int category)
Factory method to make a drilldown link.

Parameters:
model - Current batch of search results
linkText - Desired link text
category - Desired category to drill down into

makeURL

public static HTMLElement makeURL(ISearchResultModelRO model,
                                  AActivitySpace parent,
                                  HTMLElement linkText,
                                  int category)
Factory method to make a drilldown link.

Parameters:
model - Current batch of search results
linkText - Desired link text
category - Desired category to drill down into

Create

public java.lang.Object Create()
Description copied from class: SearchResultControl
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 SearchResultControl
Returns:
A new instance of the managed class (i.e. return new Foo();)
See Also:
IManagedObject.Create()

ExecuteSearchControl

protected Redirect ExecuteSearchControl(XPHashtable args,
                                        java.lang.String key)
                                 throws SearchExecutionException
Description copied from class: SearchResultControl
Execute method that subclasses should implement; unlike Execute() it's allowed to throw a SearchExecutionException. The key argument indicates the page on which this control's URL was located; this lets us handle the case where the user hits BACK before clicking on something, and (for example) drills down into a different set of categories than the set being displayed on the current page.

Specified by:
ExecuteSearchControl in class SearchResultControl
Throws:
SearchExecutionException
See Also:
com.plumtree.portalpages.search.SearchResultControl#ExecuteSearchControl()



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