oracle.apps.fnd.applcore.patterns.uishell.context
Class UIShellContext

java.lang.Object
  oracle.apps.fnd.applcore.patterns.uishell.context.UIShellContext

public class UIShellContext
extends java.lang.Object

Constructor Summary

UIShellContext()

Method Summary

TaskFlowHistory	getCurrentTask() Get the focused task.
java.lang.String	getCurrentTaskFlowId() Get task flow id of the focused task.
java.lang.String	getCurrentTaskFlowLabel() Get task flow label of the focused task.
java.lang.Boolean	getCurrentTaskForceRefresh() Get forcere refresh property of the focused task.
java.util.Map	getCurrentTaskKeyMap() Get key map of the focused task .
java.util.Map	getCurrentTaskParams() Get page params of the focused task.
TaskFlowHistory	getCurrentTaskParent() n Get parent task.
java.lang.Boolean	getCurrentTaskReuseInstance() Get resue instance property of the focused task.
java.lang.String	getCurrentTaskType() Get focused task type.
java.lang.String	getCurrentWorkAreId() Get current work area id.
java.lang.String	getDynamicTabNavigationMode() API to determine if the current workarea page running in tabs mode or no-tabs mode.
TaskFlowHistory[]	getOpenTaskList() Get all opened tasks.
java.lang.String	getURI(java.lang.String webappName) Get URI of a given webapp
java.lang.String	getURL(java.lang.String viewId, java.lang.String webApp, java.lang.String pageParametersList, java.lang.String navTaskFlowId, java.lang.String navTaskKeyList, java.lang.String navTaskParametersList, java.lang.String navTaskLabel, FndMethodParameters methodParameters) This api generates the URL with the parameters passed in.
java.lang.String	getURLForCurrentTask() This api generates the URL of the currently opened task in the UIShell Main Area.
boolean	isMainAreaOnly() Checks if the page is displayed MainArea only.

Methods inherited from class java.lang.Object

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

Constructor Detail

UIShellContext

public UIShellContext()

Method Detail

getURI

public java.lang.String getURI(java.lang.String webappName)

Get URI of a given webapp

Parameters:

webappName -

Returns:

URI string.

getOpenTaskList

public TaskFlowHistory[] getOpenTaskList()

Get all opened tasks.

Returns:

Array of TaskFlowHistory objects representing the currently opened tasks.

getCurrentTask

public TaskFlowHistory getCurrentTask()

Get the focused task.

Returns:

TaskFlowHistory object representing the currently focused task.

getCurrentTaskFlowId

public java.lang.String getCurrentTaskFlowId()

Get task flow id of the focused task.

Returns:

String representing the currently focused task flow id.

getCurrentTaskFlowLabel

public java.lang.String getCurrentTaskFlowLabel()

Get task flow label of the focused task.

Returns:

String representing the currently focused task flow label.

getCurrentTaskParams

public java.util.Map getCurrentTaskParams()

Get page params of the focused task.

Returns:

Map representing the key-value pairs.

getCurrentTaskKeyMap

public java.util.Map getCurrentTaskKeyMap()

Get key map of the focused task .

Returns:

Map representing the key-value pairs.

getCurrentTaskReuseInstance

public java.lang.Boolean getCurrentTaskReuseInstance()

Get resue instance property of the focused task.

Returns:

Boolean.

getCurrentTaskForceRefresh

public java.lang.Boolean getCurrentTaskForceRefresh()

Get forcere refresh property of the focused task.

Returns:

Boolean.

getCurrentTaskType

public java.lang.String getCurrentTaskType()

Get focused task type.

Returns:

String.

getCurrentTaskParent

public TaskFlowHistory getCurrentTaskParent()

n Get parent task.

Returns:

TaskFlowHistory.

getCurrentWorkAreId

public java.lang.String getCurrentWorkAreId()

Get current work area id.

Returns:

String.

getURLForCurrentTask

public java.lang.String getURLForCurrentTask()
                                      throws java.io.IOException

This api generates the URL of the currently opened task in the UIShell Main Area. If no taskflow opened in MainArea then returns the currently deployed application url from the ASK tables. null will be returned if the currently deployed app information not found.

Returns:

URL String

Throws:

java.io.IOException

getURL

public java.lang.String getURL(java.lang.String viewId,
                               java.lang.String webApp,
                               java.lang.String pageParametersList,
                               java.lang.String navTaskFlowId,
                               java.lang.String navTaskKeyList,
                               java.lang.String navTaskParametersList,
                               java.lang.String navTaskLabel,
                               FndMethodParameters methodParameters)
                        throws java.io.IOException

This api generates the URL with the parameters passed in.

Parameters:

viewId -

webApp -

pageParametersList -

navTaskFlowId -

navTaskKeyList -

navTaskParametersList -

navTaskLabel -

methodParameters -

Returns:

URL string. Relative url will be returned when webApp is null but viewId is not null. Fully qualified url will be returned when both the webApp and viewId are not null. Other parameters will be appended to the url only when one of the above two cases returnes a valid url and the taskFlowId is not null.

Throws:

java.io.IOException

getDynamicTabNavigationMode

public java.lang.String getDynamicTabNavigationMode()

API to determine if the current workarea page running in tabs mode or no-tabs mode.

Returns:

String value. If return value equals to: "TRUE" then the current workarea page is running in dynamicTabNavigation mode. "FALSE" then the current workarea page is running no-tabs mode. null (current workarea page is Home page.

isMainAreaOnly

public boolean isMainAreaOnly()

Checks if the page is displayed MainArea only. When this is true, all defaultRegional task type itemNodes are ignored.

Returns:

boolean