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

java.lang.Object
  com.plumtree.portaluiinfrastructure.search.SearchResultControl
      com.plumtree.portalpages.browsing.search.results.SearchWithinResultsControl

All Implemented Interfaces:

IControl, IManagedObject, IMVCObject

public class SearchWithinResultsControl
extends SearchResultControl

Author:

CraigS

Field Summary

static java.lang.String	ADDITIONAL_QUERY_DATA
static java.lang.String	ENTIRE_PORTAL_VALUE
static java.lang.String	SAME_RESTRICTIONS_VALUE
static java.lang.String	STR_MVC_CLASS_NAME
static java.lang.String	WITHIN_RESULTS_DATA_HI
static java.lang.String	WITHIN_RESULTS_DATA_SE
static java.lang.String	WITHIN_RESULTS_VALUE

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

SearchWithinResultsControl()

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.
protected boolean	expectModelInitialized() Overrides superclass method - indicates that we can still possibly run even if the owning ActivitySpace has been flushed from the cache.
java.lang.String	GetName() Return the name of the MVC object.

Methods inherited from class com.plumtree.portaluiinfrastructure.search.SearchResultControl

addCommonData, CheckActionSecurityAndExecute, 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

ADDITIONAL_QUERY_DATA

public static final java.lang.String ADDITIONAL_QUERY_DATA

See Also:

Constant Field Values

WITHIN_RESULTS_DATA_SE

public static final java.lang.String WITHIN_RESULTS_DATA_SE

See Also:

Constant Field Values

WITHIN_RESULTS_DATA_HI

public static final java.lang.String WITHIN_RESULTS_DATA_HI

See Also:

Constant Field Values

WITHIN_RESULTS_VALUE

public static final java.lang.String WITHIN_RESULTS_VALUE

See Also:

Constant Field Values

SAME_RESTRICTIONS_VALUE

public static final java.lang.String SAME_RESTRICTIONS_VALUE

See Also:

Constant Field Values

ENTIRE_PORTAL_VALUE

public static final java.lang.String ENTIRE_PORTAL_VALUE

See Also:

Constant Field Values

Constructor Detail

SearchWithinResultsControl

public SearchWithinResultsControl()

Method Detail

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()

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()

ExecuteSearchControl

protected Redirect ExecuteSearchControl(XPHashtable args,
                                        java.lang.String key)

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

See Also:

com.plumtree.portalpages.search.SearchResultControl#ExecuteSearchControl()

expectModelInitialized

protected final boolean expectModelInitialized()

Overrides superclass method - indicates that we can still possibly run even if the owning ActivitySpace has been flushed from the cache. Since this method returns false, ExecuteSearchControl has to be able to handle the case where _model.IsInitialized() returns false.

Overrides:

expectModelInitialized in class SearchResultControl