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

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

All Implemented Interfaces:

IControl, IManagedObject, IMVCObject

public class BannerStartSearchControl
extends StartSearchControl

Author:

CraigS

Field Summary

static java.lang.String	CACHED_RECENT_KEY Name under which we cache recent banner searches in our subsession.
static java.lang.String	CACHED_SEARCHPREFS_KEY Name under which we cache banner search preferences in our subsession.
static java.lang.String	SEARCHPREF_GROUPBY
static java.lang.String	SEARCHPREF_LIMITBYLOCALE Names of search preferences in the Plumtree database.
static java.lang.String	SEARCHPREF_OBJECTTYPES
static java.lang.String	SEARCHPREF_OBSOLETE_GROUPBY
static java.lang.String	SEARCHPREF_PAGESIZE
static java.lang.String	STR_MVC_CLASS_NAME Name of this control.

Fields inherited from class com.plumtree.portaluiinfrastructure.search.StartSearchControl

FILTER_QS, NON_INPUT_PREFIX, OPTIONAL_CONSTRAINT_PREFIX, REQUIRED_CONSTRAINT_PFX_CHECKBOXES, REQUIRED_CONSTRAINT_PFX_RADIO, REQUIRED_CONSTRAINT_PREFIX, SELECTED_PREFIX

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

BannerStartSearchControl()

Method Summary

java.lang.Object	Create() This method is used by the ASManager to return new instances of managed objects.
protected Redirect	CustomizeQuery(QueryArguments query) This is a "hook" that subclasses can override to make special- purpose modifications to a search query just before it runs, or to redirect specific searches to a different page.
protected SearchSettingCollection	GetCustomSearchSettings() This method is called just before the initial query is executed for banner search.
protected java.lang.String	GetLogString() For banner searches, the user's query is logged in the search server logs
java.lang.String	GetName() Return the name of the MVC object.

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

ExecuteSearchControl, expectModelInitialized, GetBannerSearchObjectTypes

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

Name of this control.

See Also:

Constant Field Values

SEARCHPREF_LIMITBYLOCALE

public static final java.lang.String SEARCHPREF_LIMITBYLOCALE

Names of search preferences in the Plumtree database.

See Also:

Constant Field Values

SEARCHPREF_PAGESIZE

public static final java.lang.String SEARCHPREF_PAGESIZE

See Also:

Constant Field Values

SEARCHPREF_OBJECTTYPES

public static final java.lang.String SEARCHPREF_OBJECTTYPES

See Also:

Constant Field Values

SEARCHPREF_GROUPBY

public static final java.lang.String SEARCHPREF_GROUPBY

See Also:

Constant Field Values

SEARCHPREF_OBSOLETE_GROUPBY

public static final java.lang.String SEARCHPREF_OBSOLETE_GROUPBY

See Also:

Constant Field Values

CACHED_SEARCHPREFS_KEY

public static final java.lang.String CACHED_SEARCHPREFS_KEY

Name under which we cache banner search preferences in our subsession.

See Also:

Constant Field Values

CACHED_RECENT_KEY

public static final java.lang.String CACHED_RECENT_KEY

Name under which we cache recent banner searches in our subsession.

See Also:

Constant Field Values

Constructor Detail

BannerStartSearchControl

public BannerStartSearchControl()

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

Overrides:

Create in class StartSearchControl

Returns:

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

Overrides:

GetName in class StartSearchControl

Returns:

See Also:

com.plumtree.portaluiinfrastructure.activityspace.IControl#GetName()

CustomizeQuery

protected Redirect CustomizeQuery(QueryArguments query)

Description copied from class: StartSearchControl

This is a "hook" that subclasses can override to make special- purpose modifications to a search query just before it runs, or to redirect specific searches to a different page. See portalui.browsing.search.results.BannerStartSearchControl.CustomizeQuery() to customize banner search. The provided QueryArguments object contains the query as specified in the URL (see the javadocs or n-docs for that class). The subclass can do either of two things with this object: (1) return a Redirect that forwards the user on to some other page - for example, if the query has special syntax like a ">" in front of the query string (2) replace the members of the QueryArguments to substitute a different search - for example, you can replace the simple string userQuery with an IPTFilter that runs a complex search. Then return null to stay on the search page instead of redirecting.

Overrides:

CustomizeQuery in class StartSearchControl

See Also:

com.plumtree.portaluiinfrastructure.search.StartSearchControl.CustomizeQuery()

GetCustomSearchSettings

protected SearchSettingCollection GetCustomSearchSettings()

This method is called just before the initial query is executed for banner search. It uses a user's preferences to add a few settings to the search (to specify the object types to be searched, for example). It also calls any banner search event interface to allow a customer or PSO to customize the search query or settings.

Overrides:

GetCustomSearchSettings in class StartSearchControl

GetLogString

protected java.lang.String GetLogString()

For banner searches, the user's query is logged in the search server logs

Overrides:

GetLogString in class StartSearchControl