|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal 11g Release 1 (11.1.1.7.0) E15995-06 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface NavigationContext
Used to access the navigation entities. This bean is EL accessible as #{navigationContext}
.
Field Summary | |
---|---|
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 | |
---|---|
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 |
---|
static final java.lang.String DEFAULT_METADATA_SCOPED_PATH
static final java.lang.String DEFAULT_METADATA_ID
static final java.lang.String DEFAULT_METADATA_PATH
static final java.lang.String PARAM_EL_MODEL_PATH
#{navigationContext.navigationModel['modelPath=/oracle/webcenter/portalapp/navigations/default-navigation-model']}
static final java.lang.String PARAM_EL_MODEL_SCOPE
PARAM_EL_MODEL_ID
#{navigationContext.navigationModel['modelScope=/oracle/webcenter/portalapp/navigations,modelId=default-navigation-model']}
PARAM_EL_MODEL_ID
, Constant Field Valuesstatic final java.lang.String PARAM_EL_MODEL_ID
PARAM_EL_MODEL_SCOPE
#{navigationContext.navigationModel['modelScope=/oracle/webcenter/portalapp/navigations,modelId=default-navigation-model']}
PARAM_EL_MODEL_SCOPE
, Constant Field ValuesMethod Detail |
---|
NavigationModel getNavigationModel(java.lang.String modelId) throws ResourceNotFoundException
modelId
- the relative filename without extension within the default scopeResourceNotFoundException
- if no NavigationModel by that modelId is foundNavigationModel getNavigationModel(java.lang.String modelScope, java.lang.String modelId) throws ResourceNotFoundException
modelScope
- the scope where the modelId existsmodelId
- the relative filename without extension within the modelScopeResourceNotFoundException
- if no NavigationModel by that modelId and modelScope is foundNavigationModel getDefaultNavigationModel() throws ResourceNotFoundException
#{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
ResourceNotFoundException
- if no default NavigationModel is foundNavigationModel getDefaultNavigationModel(java.lang.String modelScope) throws ResourceNotFoundException
ResourceNotFoundException
- if no default NavigationModel is foundvoid processAction(javax.faces.event.ActionEvent event)
#{navigationContext.processAction}
This assumes that the target resource to navigate to is passed in via the action UI component's node attribute.
event
-java.util.List<java.lang.String> listModels()
java.util.List<java.lang.String> listModels(java.lang.String modelScope)
modelScope
- the scope where the NavigationModels are locatedNavigationModel getCurrentNavigationModel()
#{navigationContext.currentNavigationModel}
void setCurrentNavigationModel(NavigationModel navigationModel)
navigationModel
- the NavigationModel objectNavigationResource getCurrentRequestSelection()
#{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.
|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal 11g Release 1 (11.1.1.7.0) E15995-06 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |