oracle.webcenter.navigationframework

Interface NavigationContext

public interface NavigationContext

Used to access the navigation entities. This bean is EL accessible as #{navigationContext}.

Since:

11.1.1.4.0

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_METADATA_ID The default navigation file id
static java.lang.String	DEFAULT_METADATA_PATH The default navigation file path (scope + id)
static java.lang.String	DEFAULT_METADATA_SCOPED_PATH The default navigation file scope
static java.lang.String	PARAM_EL_MODEL_ID Parameter that defines the id of the navigation file to be used together with PARAM_EL_MODEL_SCOPE EL: #{navigationContext.navigationModel['modelScope=/oracle/webcenter/portalapp/navigations,modelId=default-navigation-model']}
static java.lang.String	PARAM_EL_MODEL_PATH Parameter that defines the path to the navigation file EL: #{navigationContext.navigationModel['modelPath=/oracle/webcenter/portalapp/navigations/default-navigation-model']}
static java.lang.String	PARAM_EL_MODEL_SCOPE Parameter that defines the scope of the navigation file to be used together with PARAM_EL_MODEL_ID EL: #{navigationContext.navigationModel['modelScope=/oracle/webcenter/portalapp/navigations,modelId=default-navigation-model']}

Method Summary

Modifier and Type	Method and Description
NavigationModel	getCurrentNavigationModel() Returns the current NavigationModel object EL: #{navigationContext.currentNavigationModel}
NavigationResource	getCurrentRequestSelection() Get the current resource for the request.
NavigationModel	getDefaultNavigationModel() Returns the default NavigationModel object EL: #{navigationContext.defaultNavigationModel}
NavigationModel	getDefaultNavigationModel(java.lang.String modelScope) Returns the default NavigationModel object in the default navigation scope
NavigationModel	getNavigationModel(java.lang.String modelId) Returns the NavigationModel object identified by the modelId in the default navigation scope.
NavigationModel	getNavigationModel(java.lang.String modelScope, java.lang.String modelId) Returns the NavigationModel object identified by the modelId in the modelScope.
java.util.List<java.lang.String>	listModels() Returns a list of paths of NavigationModels in the default navigation scope
java.util.List<java.lang.String>	listModels(java.lang.String modelScope) Returns a list of paths of NavigationModels in the given modelScope
void	processAction(javax.faces.event.ActionEvent event) Default navigation method for binding to UI component's actionListener attribute EL: #{navigationContext.processAction}
void	setCurrentNavigationModel(NavigationModel navigationModel) Sets the current NavigationModel object

Field Detail

DEFAULT_METADATA_SCOPED_PATH

static final java.lang.String DEFAULT_METADATA_SCOPED_PATH

The default navigation file scope

See Also:

Constant Field Values

DEFAULT_METADATA_ID

static final java.lang.String DEFAULT_METADATA_ID

The default navigation file id

See Also:

Constant Field Values

DEFAULT_METADATA_PATH

static final java.lang.String DEFAULT_METADATA_PATH

The default navigation file path (scope + id)

PARAM_EL_MODEL_PATH

static final java.lang.String PARAM_EL_MODEL_PATH

Parameter that defines the path to the navigation file
EL: #{navigationContext.navigationModel['modelPath=/oracle/webcenter/portalapp/navigations/default-navigation-model']}

See Also:

Constant Field Values

PARAM_EL_MODEL_SCOPE

static final java.lang.String PARAM_EL_MODEL_SCOPE

Parameter that defines the scope of the navigation file to be used together with PARAM_EL_MODEL_ID
EL: #{navigationContext.navigationModel['modelScope=/oracle/webcenter/portalapp/navigations,modelId=default-navigation-model']}

See Also:

PARAM_EL_MODEL_ID, Constant Field Values

PARAM_EL_MODEL_ID

static final java.lang.String PARAM_EL_MODEL_ID

Parameter that defines the id of the navigation file to be used together with PARAM_EL_MODEL_SCOPE
EL: #{navigationContext.navigationModel['modelScope=/oracle/webcenter/portalapp/navigations,modelId=default-navigation-model']}

See Also:

PARAM_EL_MODEL_SCOPE, Constant Field Values

Method Detail

getNavigationModel

NavigationModel getNavigationModel(java.lang.String modelId)
                            throws ResourceNotFoundException

Returns the NavigationModel object identified by the modelId in the default navigation scope. The modelId is the filename without extension of the navigation model metadata under the default navigation scope.

Parameters:

modelId - the relative filename without extension within the default scope

Returns:

the NavigationModel object

Throws:

ResourceNotFoundException - if no NavigationModel by that modelId is found

getNavigationModel

NavigationModel getNavigationModel(java.lang.String modelScope,
                                   java.lang.String modelId)
                            throws ResourceNotFoundException

Returns the NavigationModel object identified by the modelId in the modelScope. The modelId is the filename without extension of the navigation model metadata under the specified scope.

Parameters:

modelScope - the scope where the modelId exists

modelId - the relative filename without extension within the modelScope

Returns:

the NavigationModel object

Throws:

ResourceNotFoundException - if no NavigationModel by that modelId and modelScope is found

getDefaultNavigationModel

NavigationModel getDefaultNavigationModel()
                                   throws ResourceNotFoundException

Returns the default NavigationModel object
EL: #{navigationContext.defaultNavigationModel}

It tries to get the default navigation model path from the CustomPortalNavigation implementation class if specified in context-param in web.xml (oracle.webcenter.navigationframework.CustomPortalNavigationImpl). Otherwise, it gets it from the PreferencesBean

Returns:

the default NavigationModel

Throws:

ResourceNotFoundException - if no default NavigationModel is found

getDefaultNavigationModel

NavigationModel getDefaultNavigationModel(java.lang.String modelScope)
                                   throws ResourceNotFoundException

Returns the default NavigationModel object in the default navigation scope

Returns:

the default NavigationModel

Throws:

ResourceNotFoundException - if no default NavigationModel is found

processAction

void processAction(javax.faces.event.ActionEvent event)

Default navigation method for binding to UI component's actionListener attribute
EL: #{navigationContext.processAction}

This assumes that the target resource to navigate to is passed in via the action UI component's node attribute.

Parameters:

event -

listModels

java.util.List<java.lang.String> listModels()

Returns a list of paths of NavigationModels in the default navigation scope

Returns:

list of paths

listModels

java.util.List<java.lang.String> listModels(java.lang.String modelScope)

Returns a list of paths of NavigationModels in the given modelScope

Parameters:

modelScope - the scope where the NavigationModels are located

Returns:

list of paths

getCurrentNavigationModel

NavigationModel getCurrentNavigationModel()

Returns the current NavigationModel object
EL: #{navigationContext.currentNavigationModel}

Returns:

the current NavigationModel object

setCurrentNavigationModel

void setCurrentNavigationModel(NavigationModel navigationModel)

Sets the current NavigationModel object

Parameters:

navigationModel - the NavigationModel object

getCurrentRequestSelection

NavigationResource getCurrentRequestSelection()

Get the current resource for the request.
EL: #{navigationContext.currentRequestSelection}

If current request is not driven by navigation model, null is returned. If resource has not been set by the framework, null is returned.