oracle.apps.fnd.applcore.globalSearch.ui
Class BaseSearchAction

java.lang.Object
  oracle.apps.fnd.applcore.globalSearch.ui.BaseSearchAction

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BaseSearchAction>

Direct Known Subclasses:

TaskSearchAction, URLSearchAction

public abstract class BaseSearchAction
extends java.lang.Object
implements java.io.Serializable, java.lang.Comparable<BaseSearchAction>

A base implementation of a Search Action.

Author:

David Groves <david.groves@oracle.com>

See Also:

Serialized Form

Field Summary

protected java.lang.String	_iconURL
protected java.lang.String	_title
protected java.lang.String	_toolTip
protected static java.lang.String	DEFAULT_TASK_FILE XML File for the Default Task
protected static java.lang.String	DEFAULT_TASK_NAME
static java.lang.String	DEFAULT_UNRESOLVED_TITLE Default title, if user ever see this iti is a bug due to resolver failing.
static java.lang.String	PARAMETER_APPLICATION_STRIPE applicationStripe parameter.
static java.lang.String	PARAMETER_ICON_URL Icon Url parameter.
static java.lang.String	PARAMETER_NAV_TASK_KEY_LIST Nav Task Key List parameter.
static java.lang.String	PARAMETER_NAV_TASK_LABEL Nav Task Label parameter.
static java.lang.String	PARAMETER_NAV_TASK_PARAMETERS_LIST Nav Task Parameters List parameter.
static java.lang.String	PARAMETER_NEW_BROWSER_TAB New Browser Tab parameter.
static java.lang.String	PARAMETER_PAGE_DEFINITION pageDefinitionName parameter.
static java.lang.String	PARAMETER_PAGE_PARAMETERS_LIST Page Parameters List parameter.
static java.lang.String	PARAMETER_REQUEST_CONTEXT_PATH Request Context Path parameter.
static java.lang.String	PARAMETER_TASK_FILE Use the ECSF parameter name, not the UIShell name - this keeps us more in line with std ECSF config.
static java.lang.String	PARAMETER_TASK_NAME Task Name parameter.
static java.lang.String	PARAMETER_TOOLTIP Tooltip parameter.
static java.lang.String	PARAMETER_VIEW_ID View ID parameter.
static java.lang.String	PARAMETER_WEB_APP Web App parameter.

Constructor Summary

BaseSearchAction(boolean isTaskAction, java.lang.String title, java.lang.String toolTip, java.lang.String iconURL)
Construct this class.

Method Summary

int	compareTo(BaseSearchAction thatSearchAction) Do comparison of this category to thatSearchAction based on the lowercase Display name.
abstract void	evaluateParams() Evaluate all attributes except for the tile.
abstract void	evaluateTitle() Evaluate the title attribute.
BaseSearchAction	getDefaultSearchAction() Get the default Search Action.
java.lang.String	getIconURL() Get the iconURL property value.
java.lang.String	getIconURLExists() Whether the Icon URL Exists.
java.lang.String	getTitle() Get the title to show in the UI.
java.lang.String	getToolTip() Get the toolTip property value.
java.lang.String	getUnformattedTitle() Get an unformatted title that may be used in the tab of UIShell (which does not understand HTML markup).
boolean	isTaskAction() Is this a task action.
void	setDefaultSearchAction(BaseSearchAction defaultSearchAction) Set the default Search Action.
void	setToolTip(java.lang.String toolTip) Set the toll tip.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_UNRESOLVED_TITLE

public static final java.lang.String DEFAULT_UNRESOLVED_TITLE

Default title, if user ever see this iti is a bug due to resolver failing.

See Also:

Constant Field Values

PARAMETER_VIEW_ID

public static final java.lang.String PARAMETER_VIEW_ID

View ID parameter.

See Also:

Constant Field Values

PARAMETER_REQUEST_CONTEXT_PATH

public static final java.lang.String PARAMETER_REQUEST_CONTEXT_PATH

Request Context Path parameter.

See Also:

Constant Field Values

PARAMETER_WEB_APP

public static final java.lang.String PARAMETER_WEB_APP

Web App parameter.

See Also:

Constant Field Values

PARAMETER_PAGE_PARAMETERS_LIST

public static final java.lang.String PARAMETER_PAGE_PARAMETERS_LIST

Page Parameters List parameter.

See Also:

Constant Field Values

PARAMETER_TASK_FILE

public static final java.lang.String PARAMETER_TASK_FILE

Use the ECSF parameter name, not the UIShell name - this keeps us more in line with std ECSF config.

See Also:

Constant Field Values

PARAMETER_TASK_NAME

public static final java.lang.String PARAMETER_TASK_NAME

Task Name parameter.

See Also:

Constant Field Values

PARAMETER_NAV_TASK_KEY_LIST

public static final java.lang.String PARAMETER_NAV_TASK_KEY_LIST

Nav Task Key List parameter.

See Also:

Constant Field Values

PARAMETER_NAV_TASK_PARAMETERS_LIST

public static final java.lang.String PARAMETER_NAV_TASK_PARAMETERS_LIST

Nav Task Parameters List parameter.

See Also:

Constant Field Values

PARAMETER_NAV_TASK_LABEL

public static final java.lang.String PARAMETER_NAV_TASK_LABEL

Nav Task Label parameter.

See Also:

Constant Field Values

PARAMETER_ICON_URL

public static final java.lang.String PARAMETER_ICON_URL

Icon Url parameter.

See Also:

Constant Field Values

PARAMETER_TOOLTIP

public static final java.lang.String PARAMETER_TOOLTIP

Tooltip parameter.

See Also:

Constant Field Values

PARAMETER_NEW_BROWSER_TAB

public static final java.lang.String PARAMETER_NEW_BROWSER_TAB

New Browser Tab parameter.

See Also:

Constant Field Values

PARAMETER_APPLICATION_STRIPE

public static final java.lang.String PARAMETER_APPLICATION_STRIPE

applicationStripe parameter.

See Also:

Constant Field Values

PARAMETER_PAGE_DEFINITION

public static final java.lang.String PARAMETER_PAGE_DEFINITION

pageDefinitionName parameter.

See Also:

Constant Field Values

DEFAULT_TASK_FILE

protected static final java.lang.String DEFAULT_TASK_FILE

XML File for the Default Task

See Also:

Constant Field Values

DEFAULT_TASK_NAME

protected static final java.lang.String DEFAULT_TASK_NAME

See Also:

Constant Field Values

_title

protected java.lang.String _title

_toolTip

protected java.lang.String _toolTip

_iconURL

protected java.lang.String _iconURL

Constructor Detail

BaseSearchAction

public BaseSearchAction(boolean isTaskAction,
                        java.lang.String title,
                        java.lang.String toolTip,
                        java.lang.String iconURL)

Construct this class.

Parameters:

isTaskAction - is this a task or URL action.

title - title to show the user.

toolTip - tooltip to show the user.

iconURL - Icon URL, possibly null.

Method Detail

getTitle

public java.lang.String getTitle()

Get the title to show in the UI. This is usually the title property, but in screen reader mode, will be prepended with the base title value.

Returns:

title.

getUnformattedTitle

public java.lang.String getUnformattedTitle()

Get an unformatted title that may be used in the tab of UIShell (which does not understand HTML markup).

Returns:

unformatted version of title.

getToolTip

public java.lang.String getToolTip()

Get the toolTip property value.

Returns:

toolTip property value.

getIconURL

public java.lang.String getIconURL()

Get the iconURL property value.

Returns:

iconURL property value.

isTaskAction

public boolean isTaskAction()

Is this a task action.

Returns:

task action property value.

getIconURLExists

public java.lang.String getIconURLExists()

Whether the Icon URL Exists.

Returns:

"true" if icon url exists otherwise "false"

evaluateTitle

public abstract void evaluateTitle()

Evaluate the title attribute. This attribute may be expensive to determine and is needed only when displayed in the UI.

See Also:

evaluateParams()

evaluateParams

public abstract void evaluateParams()

Evaluate all attributes except for the tile. The attribute may be expensive to determine and are needed only when a result is clicked on in the UI.

See Also:

evaluateTitle()

compareTo

public int compareTo(BaseSearchAction thatSearchAction)

Do comparison of this category to thatSearchAction based on the lowercase Display name.

Specified by:

compareTo in interface java.lang.Comparable<BaseSearchAction>

Parameters:

thatSearchAction - other SearchAction to compare.

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

setDefaultSearchAction

public void setDefaultSearchAction(BaseSearchAction defaultSearchAction)

Set the default Search Action.

Parameters:

defaultSearchAction - default Search Action.

getDefaultSearchAction

public BaseSearchAction getDefaultSearchAction()

Get the default Search Action.

Returns:

default Search Action.

setToolTip

public void setToolTip(java.lang.String toolTip)

Set the toll tip.

Parameters:

toolTip - tooltip value.