NavigationContext (Nuxeo ECM Projects 9.10-SNAPSHOT API)

All Known Implementing Classes:

NavigationContextBean
```
public interface NavigationContext
```
Stateful Seam component.
- manages the navigation context variables
- outjects them for compatibility
- provides getters and setters for navigation context variables (ie : hide what Seam scope is used for that)
- provides basic navigation features by leveraging Core API + Distributed cache + internal cache
This Seam component should ideally serve only DocumentModel, lists of DMs and Trees of DMs: no UI related structure.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`DocumentModel`	`factoryChangeableDocument()` Gets current document for edition.
`DocumentModel`	`factoryCurrentContentRoot()` Gets the currentContentRootWorkspace and puts it in Page context.
`DocumentModel`	`factoryCurrentDocument()` Gets the currentDocument and puts it in Page context.
`DocumentModel`	`factoryCurrentDomain()` Gets the currentDomain and puts it in Page context.
`RepositoryLocation`	`factoryCurrentServerLocation()` Gets the current ServerLocation and puts it in Page Context.
`DocumentModel`	`factoryCurrentSuperSpace()` Gets the currentSuperSpace and puts it in Page context.
`DocumentModel`	`factoryCurrentWorkspace()` Gets the currentWorkspace and puts it in Page context.
`String`	`getActionResult(DocumentModel doc, UserAction action)` Performs context updates and returns the view associated with the document and action passed.
`DocumentModel`	`getChangeableDocument()` This is used for documents about to be created, which are not yet persisted thus not all their fields might be valid (like its reference).
`DocumentModel`	`getCurrentContentRoot()` Gets the current Content Root (Workspaces, Sections, Templates...).
`DocumentModel`	`getCurrentDocument()` Current Document other than Domain or Workspace.
`String`	`getCurrentDocumentFullUrl()`
`String`	`getCurrentDocumentUrl()`
`DocumentModel`	`getCurrentDomain()` Current Domain, if user has read permission on it.
`String`	`getCurrentDomainPath()` Finds the path to current domain.
`DocumentModelList`	`getCurrentPath()` Returns a list of the DocumentsModels (to build the BreadCrumb for example).
`List<PathElement>`	`getCurrentPathList()`
`RepositoryLocation`	`getCurrentServerLocation()`
`DocumentModel`	`getCurrentSuperSpace()` Returns the currentSuperSpace (Section, Workspace...).
`DocumentModel`	`getCurrentWorkspace()` Gets the current Workspace.
`CoreSession`	`getOrCreateDocumentManager()` Returns the current documentManager if any or create a new session to the currently selected repository location.
`RepositoryLocation`	`getSelectedServerLocation()` Deprecated. use getCurrentServerLocation instead
`String`	`goBack()`
`String`	`goHome()` go to the root server, the root document or to the dashboard if the latest document are not accessible.
`void`	`init()` Callback for component initialization.
`void`	`invalidateCurrentDocument()` Will trigger reloading of current document data from the server.
`String`	`navigateTo(RepositoryLocation serverLocation, DocumentRef docRef)` Initializes the context for the given refs and returns the default view for the doc.
`String`	`navigateToDocument(DocumentModel doc)` Updates the context with given document and returns its default view.
`String`	`navigateToDocument(DocumentModel doc, String viewId)` Initializes the context for the given doc and returns its given view.
`String`	`navigateToDocument(DocumentModel docModel, VersionModel versionModel)`
`String`	`navigateToDocumentWithView(DocumentModel doc, String viewId)` Initializes the context for the given doc and returns its given view.
`String`	`navigateToId(String documentId)` Updates the context and returns the view for the given document id.
`String`	`navigateToRef(DocumentRef docRef)` Updates the context and returns the view for the given document ref.
`String`	`navigateToURL()` Initializes the context for the given refs and returns the default view for the doc.
`String`	`navigateToURL(String documentUrl)` Initializes the context for the given refs and returns the default view for the doc.
`void`	`resetCurrentContext()` Resets all context variables.
`void`	`saveCurrentDocument()` Saves the current copy of the document to server.
`void`	`selectionChanged()`
`void`	`setChangeableDocument(DocumentModel changeableDocument)`
`void`	`setCurrentContentRoot(DocumentModel currentContentRoot)` Sets the current ContentRoot.
`void`	`setCurrentDocument(DocumentModel documentModel)`
`void`	`setCurrentDomain(DocumentModel currentDomain)`
`void`	`setCurrentServerLocation(RepositoryLocation serverLocation)` Switch to a new server location by updating the context and updating to the CoreSession (aka the 'documentManager' Seam component).
`void`	`updateDocumentContext(DocumentModel doc)` Updates the current document in the (session) context and resets the other common structures (breadcrumbs, etc).

- Method Detail
  - init
```
void init()
```
    Callback for component initialization.
  - getCurrentServerLocation
```
RepositoryLocation getCurrentServerLocation()
```
    Returns:
    
    current repository location or null if no server is connected
  - getSelectedServerLocation
```
@Deprecated
RepositoryLocation getSelectedServerLocation()
```
    Deprecated. use getCurrentServerLocation instead
    
    Returns:
    
    current selected repository location or null
  - getCurrentDomain
```
DocumentModel getCurrentDomain()
```
    Current Domain, if user has read permission on it. Use
    
    Returns:
    
    the current domain.
  - getCurrentDomainPath
```
String getCurrentDomainPath()
```
    Finds the path to current domain.
    This method tries hard to always returns an answer: the path to current domain is deduced from the path of current document (assuming that it would be the first element of this path).
    If current document is null, the same logic is applied to the first document found amongst all documents user has access to.
  - setCurrentDomain
```
void setCurrentDomain(DocumentModel currentDomain)
```
  - getCurrentDocument
```
DocumentModel getCurrentDocument()
```
    Current Document other than Domain or Workspace.
  - getCurrentSuperSpace
```
DocumentModel getCurrentSuperSpace()
```
    Returns the currentSuperSpace (Section, Workspace...). Uses SuperSpace facet for that.
  - setCurrentDocument
```
void setCurrentDocument(DocumentModel documentModel)
```
  - getChangeableDocument
```
DocumentModel getChangeableDocument()
```
    This is used for documents about to be created, which are not yet persisted thus not all their fields might be valid (like its reference).
  - setChangeableDocument
```
void setChangeableDocument(DocumentModel changeableDocument)
```
  - saveCurrentDocument
```
void saveCurrentDocument()
```
    Saves the current copy of the document to server.
  - getCurrentPathList
```
List<PathElement> getCurrentPathList()
```
  - getCurrentPath
```
DocumentModelList getCurrentPath()
```
    Returns a list of the DocumentsModels (to build the BreadCrumb for example).
  - getCurrentDocumentUrl
```
String getCurrentDocumentUrl()
```
    Returns:
    
    the URL that can be used to refer the current document from outside current context
  - getCurrentDocumentFullUrl
```
String getCurrentDocumentFullUrl()
```
    Returns:
    
    the URL that can be used to refer the current document from outside current context
  - updateDocumentContext
```
void updateDocumentContext(DocumentModel doc)
```
    Updates the current document in the (session) context and resets the other common structures (breadcrumbs, etc).
    
    Parameters:
    
    doc - DocumentModel that will be set as current document
  - resetCurrentContext
```
void resetCurrentContext()
```
    Resets all context variables.
  - getActionResult
```
String getActionResult(DocumentModel doc,
                       UserAction action)
```
    Performs context updates and returns the view associated with the document and action passed.
    
    Returns:
    
    document view associated with the result
  - goHome
```
String goHome()
```
    go to the root server, the root document or to the dashboard if the latest document are not accessible.
  - goBack
```
String goBack()
```
  - navigateToId
```
String navigateToId(String documentId)
```
    Updates the context and returns the view for the given document id.
  - navigateToRef
```
String navigateToRef(DocumentRef docRef)
```
    Updates the context and returns the view for the given document ref.
  - navigateToDocument
```
String navigateToDocument(DocumentModel doc)
```
    Updates the context with given document and returns its default view.
    The default view is configured on the UI document type definition.
  - navigateToDocument
```
String navigateToDocument(DocumentModel doc,
                          String viewId)
```
    Initializes the context for the given doc and returns its given view.
    If view is not found, use default view.
    
    Parameters:
    
    doc -
    
    viewId - for the document as defined in its type
    
    Returns:
    
    navigation view for the document
  - navigateToDocumentWithView
```
String navigateToDocumentWithView(DocumentModel doc,
                                  String viewId)
```
    Initializes the context for the given doc and returns its given view.
    If view is not found, use default view set on the UI document type. This is an alias to navigateToDocument(DocumentModel doc, String viewId), to resolve ambiguity when method is invoked by an EL expression.
    
    Parameters:
    
    doc -
    
    viewId - for the document as defined in its type
    
    Returns:
    
    navigation view for the document
  - navigateTo
```
String navigateTo(RepositoryLocation serverLocation,
                  DocumentRef docRef)
```
    Initializes the context for the given refs and returns the default view for the doc.
  - navigateToURL
```
String navigateToURL(String documentUrl)
```
    Initializes the context for the given refs and returns the default view for the doc.
  - navigateToURL
```
String navigateToURL()
```
    Initializes the context for the given refs and returns the default view for the doc.
    Takes parameter String docRef from the Request.
  - selectionChanged
```
void selectionChanged()
```
  - setCurrentServerLocation
```
void setCurrentServerLocation(RepositoryLocation serverLocation)
```
    Switch to a new server location by updating the context and updating to the CoreSession (aka the 'documentManager' Seam component).
    
    Parameters:
    
    serverLocation - new server location to connect to
  - getOrCreateDocumentManager
```
CoreSession getOrCreateDocumentManager()
```
    Returns the current documentManager if any or create a new session to the currently selected repository location.
  - navigateToDocument
```
String navigateToDocument(DocumentModel docModel,
                          VersionModel versionModel)
```
  - factoryCurrentDocument
```
DocumentModel factoryCurrentDocument()
```
    Gets the currentDocument and puts it in Page context.
  - factoryCurrentDomain
```
DocumentModel factoryCurrentDomain()
```
    Gets the currentDomain and puts it in Page context.
  - factoryCurrentWorkspace
```
DocumentModel factoryCurrentWorkspace()
```
    Gets the currentWorkspace and puts it in Page context.
  - factoryCurrentSuperSpace
```
DocumentModel factoryCurrentSuperSpace()
```
    Gets the currentSuperSpace and puts it in Page context.
  - factoryCurrentContentRoot
```
DocumentModel factoryCurrentContentRoot()
```
    Gets the currentContentRootWorkspace and puts it in Page context.
  - factoryCurrentServerLocation
```
RepositoryLocation factoryCurrentServerLocation()
```
    Gets the current ServerLocation and puts it in Page Context.
  - factoryChangeableDocument
```
DocumentModel factoryChangeableDocument()
```
    Gets current document for edition.
  - getCurrentContentRoot
```
DocumentModel getCurrentContentRoot()
```
    Gets the current Content Root (Workspaces, Sections, Templates...).
  - getCurrentWorkspace
```
DocumentModel getCurrentWorkspace()
```
    Gets the current Workspace.
  - setCurrentContentRoot
```
void setCurrentContentRoot(DocumentModel currentContentRoot)
```
    Sets the current ContentRoot.
  - invalidateCurrentDocument
```
void invalidateCurrentDocument()
```
    Will trigger reloading of current document data from the server.

Interface NavigationContext

Method Summary

Method Detail

init

getCurrentServerLocation

getSelectedServerLocation

getCurrentDomain

getCurrentDomainPath

setCurrentDomain

getCurrentDocument

getCurrentSuperSpace

setCurrentDocument

getChangeableDocument

setChangeableDocument

saveCurrentDocument

getCurrentPathList

getCurrentPath

getCurrentDocumentUrl

getCurrentDocumentFullUrl

updateDocumentContext

resetCurrentContext

getActionResult

goHome

goBack

navigateToId

navigateToRef

navigateToDocument

navigateToDocument

navigateToDocumentWithView

navigateTo

navigateToURL

navigateToURL

selectionChanged

setCurrentServerLocation

getOrCreateDocumentManager

navigateToDocument

factoryCurrentDocument

factoryCurrentDomain

factoryCurrentWorkspace

factoryCurrentSuperSpace

factoryCurrentContentRoot

factoryCurrentServerLocation

factoryChangeableDocument

getCurrentContentRoot

getCurrentWorkspace

setCurrentContentRoot

invalidateCurrentDocument