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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ECSFTaskSearchAction, ECSFURLInTaskSearchAction, WCURLInHomepageSearchAction

public class TaskSearchAction
extends BaseSearchAction
implements java.io.Serializable

A Search Action for ECSF Task Types.

Author:

David Groves <david.groves@oracle.com>

See Also:

Serialized Form

Field Summary

protected java.lang.String	_applicationStripe Application Stripe parameter, may be null, but if not is passed to NavigationUtil.getUserNavigationTarget API along with pageDefinition to determine the other parameters.
protected java.lang.String	_navTaskFile
protected java.lang.String	_navTaskKeyList
protected java.lang.String	_navTaskLabel Title of results task flow.
protected java.lang.String	_navTaskName
protected java.lang.String	_navTaskParametersList
protected java.lang.String	_pageDefinition Application Stripe parameter, may be null, but if not is passed to NavigationUtil.getUserNavigationTarget API along with applicationStripe to determine the other parameters.
protected java.lang.String	_pageParametersList
protected java.lang.String	_taskFlowURL
protected java.lang.String	_viewId
protected java.lang.String	_webApp

Fields inherited from class oracle.apps.fnd.applcore.globalSearch.ui.BaseSearchAction

_iconURL, _title, _toolTip, DEFAULT_TASK_FILE, DEFAULT_TASK_NAME, DEFAULT_UNRESOLVED_TITLE, PARAMETER_APPLICATION_STRIPE, PARAMETER_ICON_URL, PARAMETER_NAV_TASK_KEY_LIST, PARAMETER_NAV_TASK_LABEL, PARAMETER_NAV_TASK_PARAMETERS_LIST, PARAMETER_NEW_BROWSER_TAB, PARAMETER_PAGE_DEFINITION, PARAMETER_PAGE_PARAMETERS_LIST, PARAMETER_REQUEST_CONTEXT_PATH, PARAMETER_TASK_FILE, PARAMETER_TASK_NAME, PARAMETER_TOOLTIP, PARAMETER_VIEW_ID, PARAMETER_WEB_APP

Constructor Summary

TaskSearchAction(java.lang.String title, java.lang.String viewId, java.lang.String webApp, java.lang.String pageParametersList, java.lang.String navTaskFile, java.lang.String navTaskName, java.lang.String navTaskKeyList, java.lang.String navTaskParametersList, java.lang.String toolTip, java.lang.String iconURL, java.lang.String taskFlowURL, java.lang.String navTaskLabel)
Construct this class.

Method Summary

protected void	defaultParamsToCurrentPage() Default the viewId and webApp to the current page.
void	evaluateParams() Evaluate all attributes except for the tile.
void	evaluateTitle() Evaluate the title attribute.
FndMethodParameters	getMethodParameters() Get the methodParameters property value.
java.lang.String	getNavTaskFlowId() Get the navTaskFlowId property value.
java.lang.String	getNavTaskKeyList() Get the navTaskKeyList property value.
java.lang.String	getNavTaskLabel() Get the navTaskLabel.
java.lang.String	getNavTaskParametersList() Get the navTaskParametersList property value.
java.util.Map	getNavTaskParametersMap() Get the navTaskParametersList property value as a Map.
java.lang.String	getPageParametersList() Get the pageParametersList property value.
java.lang.String	getViewId() Get the viewId property value.
java.lang.String	getWebApp() Get the webApp property value.

Methods inherited from class oracle.apps.fnd.applcore.globalSearch.ui.BaseSearchAction

compareTo, getDefaultSearchAction, getIconURL, getIconURLExists, getTitle, getToolTip, getUnformattedTitle, isTaskAction, setDefaultSearchAction, setToolTip

Methods inherited from class java.lang.Object

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

Field Detail

_viewId

protected java.lang.String _viewId

_webApp

protected java.lang.String _webApp

_pageParametersList

protected java.lang.String _pageParametersList

_navTaskFile

protected java.lang.String _navTaskFile

_navTaskName

protected java.lang.String _navTaskName

_navTaskKeyList

protected java.lang.String _navTaskKeyList

_navTaskParametersList

protected java.lang.String _navTaskParametersList

_taskFlowURL

protected java.lang.String _taskFlowURL

_navTaskLabel

protected java.lang.String _navTaskLabel

Title of results task flow. If null, title will be used instead.

_applicationStripe

protected java.lang.String _applicationStripe

Application Stripe parameter, may be null, but if not is passed to NavigationUtil.getUserNavigationTarget API along with pageDefinition to determine the other parameters. It's nullness is also used as a check whether this test has/needs been performed, and the value will be nulled after this API has been called.

_pageDefinition

protected java.lang.String _pageDefinition

Application Stripe parameter, may be null, but if not is passed to NavigationUtil.getUserNavigationTarget API along with applicationStripe to determine the other parameters. It's nullness is also used as a check whether this test has/needs been performed, and the value will be nulled after this API has been called.

Constructor Detail

TaskSearchAction

public TaskSearchAction(java.lang.String title,
                        java.lang.String viewId,
                        java.lang.String webApp,
                        java.lang.String pageParametersList,
                        java.lang.String navTaskFile,
                        java.lang.String navTaskName,
                        java.lang.String navTaskKeyList,
                        java.lang.String navTaskParametersList,
                        java.lang.String toolTip,
                        java.lang.String iconURL,
                        java.lang.String taskFlowURL,
                        java.lang.String navTaskLabel)

Construct this class.

Parameters:

title - title to show the user.

viewId - page to show the task in.

webApp - web Application of the page.

pageParametersList - URL parameters for the page.

navTaskFile - task flow file to call in UIShell.

navTaskName - task flow name within navTaskFile to call in UIShell.

navTaskKeyList - navTaskKeyList.

navTaskParametersList - parameters for task flow.

toolTip - tooltip to show the user.

iconURL - Icon URL, possibly null.

taskFlowURL - String URL for the case where we are calling the specific internal frame task flow that shows the URL target.

navTaskLabel - name of results task tab - if null title will be used instead.

Method Detail

evaluateTitle

public void evaluateTitle()

Evaluate the title attribute. This attribute may be expensive to determine and is needed only when displayed in the UI. At this level in the code this method does nothing.

Specified by:

evaluateTitle in class BaseSearchAction

See Also:

BaseSearchAction.evaluateParams()

evaluateParams

public 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.

Specified by:

evaluateParams in class BaseSearchAction

See Also:

evaluateTitle()

getViewId

public java.lang.String getViewId()

Get the viewId property value.

Returns:

viewId property value.

getWebApp

public java.lang.String getWebApp()

Get the webApp property value.

Returns:

webApp property value.

getPageParametersList

public java.lang.String getPageParametersList()

Get the pageParametersList property value.

Returns:

pageParametersList property value.

getNavTaskLabel

public java.lang.String getNavTaskLabel()

Get the navTaskLabel. If null, use the title.

Returns:

value to show on result tab title.

getNavTaskFlowId

public java.lang.String getNavTaskFlowId()

Get the navTaskFlowId property value.

Returns:

navTaskFlowId property value.

getNavTaskKeyList

public java.lang.String getNavTaskKeyList()

Get the navTaskKeyList property value.

Returns:

navTaskKeyList property value.

getNavTaskParametersList

public java.lang.String getNavTaskParametersList()

Get the navTaskParametersList property value.

Returns:

navTaskParametersList property value.

getNavTaskParametersMap

public java.util.Map getNavTaskParametersMap()

Get the navTaskParametersList property value as a Map. Values are parsed from the navTaskParametersList property using ; and = as separators.

Returns:

navTaskParametersList property value as a Map.

getMethodParameters

public FndMethodParameters getMethodParameters()

Get the methodParameters property value. This value is generated as required and passed back with the taskFlowURL as the customObject.

Returns:

methodParameters property value, null if taskFlowURL is null.

defaultParamsToCurrentPage

protected void defaultParamsToCurrentPage()

Default the viewId and webApp to the current page.