Nuxeo Enterprise Platform 5.4

org.nuxeo.dam.platform.context
Class NavigationContextBean

java.lang.Object
  extended by org.nuxeo.dam.platform.context.NavigationContextBean
All Implemented Interfaces:
Serializable, org.nuxeo.ecm.platform.ui.web.api.NavigationContext

@Name(value="navigationContext")
@Scope(value=CONVERSATION)
@Install(precedence=10)
public class NavigationContextBean
extends Object
implements org.nuxeo.ecm.platform.ui.web.api.NavigationContext, Serializable

See Also:
Serialized Form

Constructor Summary
NavigationContextBean()
           
 
Method Summary
 org.nuxeo.ecm.core.api.DocumentModel factoryChangeableDocument()
           
 org.nuxeo.ecm.core.api.DocumentModel factoryCurrentContentRoot()
           
 org.nuxeo.ecm.core.api.DocumentModel factoryCurrentDocument()
           
 org.nuxeo.ecm.core.api.DocumentModelList factoryCurrentDocumentChildren()
           
 org.nuxeo.ecm.core.api.DocumentModel factoryCurrentDomain()
           
 org.nuxeo.ecm.platform.util.RepositoryLocation factoryCurrentServerLocation()
           
 org.nuxeo.ecm.core.api.DocumentModel factoryCurrentSuperSpace()
           
 org.nuxeo.ecm.core.api.DocumentModel factoryCurrentWorkspace()
           
 String getActionResult(org.nuxeo.ecm.core.api.DocumentModel doc, org.nuxeo.ecm.platform.ui.web.api.UserAction action)
           
 org.nuxeo.ecm.core.api.DocumentModel getChangeableDocument()
           
 org.nuxeo.ecm.core.api.DocumentModel getCurrentContentRoot()
           
 org.nuxeo.ecm.core.api.DocumentModel getCurrentDocument()
           
 org.nuxeo.ecm.core.api.DocumentModelList getCurrentDocumentChildren()
           
 org.nuxeo.ecm.core.api.DocumentModelList getCurrentDocumentChildrenPage()
           
 String getCurrentDocumentFullUrl()
           
 String getCurrentDocumentUrl()
           
 org.nuxeo.ecm.core.api.DocumentModel getCurrentDomain()
           
 String getCurrentDomainPath()
           
 org.nuxeo.ecm.core.api.DocumentModelList getCurrentPath()
           
 List<org.nuxeo.ecm.platform.ui.web.pathelements.PathElement> getCurrentPathList()
           
 org.nuxeo.ecm.platform.util.RepositoryLocation getCurrentServerLocation()
           
 org.nuxeo.ecm.core.api.DocumentModel getCurrentSuperSpace()
           
 org.nuxeo.ecm.core.api.DocumentModel getCurrentWorkspace()
           
 org.nuxeo.ecm.core.api.CoreSession getOrCreateDocumentManager()
           
 org.nuxeo.ecm.core.api.PagedDocumentsProvider getResultsProvider(String name)
           
 org.nuxeo.ecm.core.api.PagedDocumentsProvider getResultsProvider(String name, org.nuxeo.ecm.core.api.SortInfo sortInfo)
           
 org.nuxeo.ecm.platform.util.RepositoryLocation getSelectedServerLocation()
           
 String goBack()
           
 String goHome()
           
 void init()
           
 void invalidateChildrenProvider()
           
 void invalidateCurrentDocument()
           
 String navigateTo(org.nuxeo.ecm.platform.util.RepositoryLocation serverLocation, org.nuxeo.ecm.core.api.DocumentRef docRef)
           
 String navigateToDocument(org.nuxeo.ecm.core.api.DocumentModel doc)
           
 String navigateToDocument(org.nuxeo.ecm.core.api.DocumentModel doc, String viewId)
           
 String navigateToDocument(org.nuxeo.ecm.core.api.DocumentModel docModel, org.nuxeo.ecm.core.api.VersionModel versionModel)
           
 String navigateToDocumentWithView(org.nuxeo.ecm.core.api.DocumentModel doc, String viewId)
           
 String navigateToId(String documentId)
           
 String navigateToRef(org.nuxeo.ecm.core.api.DocumentRef docRef)
           
 String navigateToURL()
           
 String navigateToURL(String documentUrl)
           
 void resetCurrentContext()
           
 void resetCurrentDocumentChildrenCache(org.nuxeo.ecm.core.api.DocumentModel targetDoc)
           
 void saveCurrentDocument()
           
 void selectionChanged()
           
 void setChangeableDocument(org.nuxeo.ecm.core.api.DocumentModel changeableDocument)
           
 void setCurrentContentRoot(org.nuxeo.ecm.core.api.DocumentModel currentContentRoot)
           
 void setCurrentDocument(org.nuxeo.ecm.core.api.DocumentModel documentModel)
           
 void setCurrentDomain(org.nuxeo.ecm.core.api.DocumentModel currentDomain)
           
 void setCurrentResultsProvider(org.nuxeo.ecm.core.api.PagedDocumentsProvider resultsProvider)
           
 void setCurrentServerLocation(org.nuxeo.ecm.platform.util.RepositoryLocation serverLocation)
           
 void updateDocumentContext(org.nuxeo.ecm.core.api.DocumentModel doc)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NavigationContextBean

public NavigationContextBean()
Method Detail

factoryChangeableDocument

public org.nuxeo.ecm.core.api.DocumentModel factoryChangeableDocument()
Specified by:
factoryChangeableDocument in interface org.nuxeo.ecm.platform.ui.web.api.NavigationContext

factoryCurrentContentRoot

public org.nuxeo.ecm.core.api.DocumentModel factoryCurrentContentRoot()
Specified by:
factoryCurrentContentRoot in interface org.nuxeo.ecm.platform.ui.web.api.NavigationContext

factoryCurrentDocument

@Factory(value="currentDocument",
         scope=EVENT)
public org.nuxeo.ecm.core.api.DocumentModel factoryCurrentDocument()
Specified by:
factoryCurrentDocument in interface org.nuxeo.ecm.platform.ui.web.api.NavigationContext

factoryCurrentDocumentChildren

public org.nuxeo.ecm.core.api.DocumentModelList factoryCurrentDocumentChildren()
                                                                        throws org.nuxeo.ecm.core.api.ClientException
Specified by:
factoryCurrentDocumentChildren in interface org.nuxeo.ecm.platform.ui.web.api.NavigationContext
Throws:
org.nuxeo.ecm.core.api.ClientException

factoryCurrentDomain

public org.nuxeo.ecm.core.api.DocumentModel factoryCurrentDomain()
Specified by:
factoryCurrentDomain in interface org.nuxeo.ecm.platform.ui.web.api.NavigationContext

factoryCurrentServerLocation

public org.nuxeo.ecm.platform.util.RepositoryLocation factoryCurrentServerLocation()
Specified by:
factoryCurrentServerLocation in interface org.nuxeo.ecm.platform.ui.web.api.NavigationContext

factoryCurrentSuperSpace

public org.nuxeo.ecm.core.api.DocumentModel factoryCurrentSuperSpace()
                                                              throws org.nuxeo.ecm.core.api.ClientException
Specified by:
factoryCurrentSuperSpace in interface org.nuxeo.ecm.platform.ui.web.api.NavigationContext
Throws:
org.nuxeo.ecm.core.api.ClientException

factoryCurrentWorkspace

public org.nuxeo.ecm.core.api.DocumentModel factoryCurrentWorkspace()
Specified by:
factoryCurrentWorkspace in interface org.nuxeo.ecm.platform.ui.web.api.NavigationContext

getActionResult

public String getActionResult(org.nuxeo.ecm.core.api.DocumentModel doc,
                              org.nuxeo.ecm.platform.ui.web.api.UserAction action)
                       throws org.nuxeo.ecm.core.api.ClientException
Specified by:
getActionResult in interface org.nuxeo.ecm.platform.ui.web.api.NavigationContext
Throws:
org.nuxeo.ecm.core.api.ClientException

getChangeableDocument

public org.nuxeo.ecm.core.api.DocumentModel getChangeableDocument()
Specified by:
getChangeableDocument in interface org.nuxeo.ecm.platform.ui.web.api.NavigationContext

getCurrentContentRoot

public org.nuxeo.ecm.core.api.DocumentModel getCurrentContentRoot()
Specified by:
getCurrentContentRoot in interface org.nuxeo.ecm.platform.ui.web.api.NavigationContext

getCurrentDocument

public org.nuxeo.ecm.core.api.DocumentModel getCurrentDocument()
Specified by:
getCurrentDocument in interface org.nuxeo.ecm.platform.ui.web.api.NavigationContext

getCurrentDocumentChildren

public org.nuxeo.ecm.core.api.DocumentModelList getCurrentDocumentChildren()
                                                                    throws org.nuxeo.ecm.core.api.ClientException
Specified by:
getCurrentDocumentChildren in interface org.nuxeo.ecm.platform.ui.web.api.NavigationContext
Throws:
org.nuxeo.ecm.core.api.ClientException

getCurrentDocumentChildrenPage

public org.nuxeo.ecm.core.api.DocumentModelList getCurrentDocumentChildrenPage()
                                                                        throws org.nuxeo.ecm.core.api.ClientException
Specified by:
getCurrentDocumentChildrenPage in interface org.nuxeo.ecm.platform.ui.web.api.NavigationContext
Throws:
org.nuxeo.ecm.core.api.ClientException

getCurrentDocumentFullUrl

public String getCurrentDocumentFullUrl()
Specified by:
getCurrentDocumentFullUrl in interface org.nuxeo.ecm.platform.ui.web.api.NavigationContext

getCurrentDocumentUrl

public String getCurrentDocumentUrl()
Specified by:
getCurrentDocumentUrl in interface org.nuxeo.ecm.platform.ui.web.api.NavigationContext

getCurrentDomain

public org.nuxeo.ecm.core.api.DocumentModel getCurrentDomain()
Specified by:
getCurrentDomain in interface org.nuxeo.ecm.platform.ui.web.api.NavigationContext

getCurrentDomainPath

public String getCurrentDomainPath()
                            throws org.nuxeo.ecm.core.api.ClientException
Specified by:
getCurrentDomainPath in interface org.nuxeo.ecm.platform.ui.web.api.NavigationContext
Throws:
org.nuxeo.ecm.core.api.ClientException

getCurrentPath

public org.nuxeo.ecm.core.api.DocumentModelList getCurrentPath()
                                                        throws org.nuxeo.ecm.core.api.ClientException
Specified by:
getCurrentPath in interface org.nuxeo.ecm.platform.ui.web.api.NavigationContext
Throws:
org.nuxeo.ecm.core.api.ClientException

getCurrentPathList

public List<org.nuxeo.ecm.platform.ui.web.pathelements.PathElement> getCurrentPathList()
                                                                                throws org.nuxeo.ecm.core.api.ClientException
Specified by:
getCurrentPathList in interface org.nuxeo.ecm.platform.ui.web.api.NavigationContext
Throws:
org.nuxeo.ecm.core.api.ClientException

getCurrentServerLocation

public org.nuxeo.ecm.platform.util.RepositoryLocation getCurrentServerLocation()
Specified by:
getCurrentServerLocation in interface org.nuxeo.ecm.platform.ui.web.api.NavigationContext

getCurrentSuperSpace

public org.nuxeo.ecm.core.api.DocumentModel getCurrentSuperSpace()
                                                          throws org.nuxeo.ecm.core.api.ClientException
Specified by:
getCurrentSuperSpace in interface org.nuxeo.ecm.platform.ui.web.api.NavigationContext
Throws:
org.nuxeo.ecm.core.api.ClientException

getCurrentWorkspace

public org.nuxeo.ecm.core.api.DocumentModel getCurrentWorkspace()
Specified by:
getCurrentWorkspace in interface org.nuxeo.ecm.platform.ui.web.api.NavigationContext

getOrCreateDocumentManager

public org.nuxeo.ecm.core.api.CoreSession getOrCreateDocumentManager()
                                                              throws org.nuxeo.ecm.core.api.ClientException
Specified by:
getOrCreateDocumentManager in interface org.nuxeo.ecm.platform.ui.web.api.NavigationContext
Throws:
org.nuxeo.ecm.core.api.ClientException

getSelectedServerLocation

public org.nuxeo.ecm.platform.util.RepositoryLocation getSelectedServerLocation()
Specified by:
getSelectedServerLocation in interface org.nuxeo.ecm.platform.ui.web.api.NavigationContext

goBack

public String goBack()
              throws org.nuxeo.ecm.core.api.ClientException
Specified by:
goBack in interface org.nuxeo.ecm.platform.ui.web.api.NavigationContext
Throws:
org.nuxeo.ecm.core.api.ClientException

goHome

public String goHome()
Specified by:
goHome in interface org.nuxeo.ecm.platform.ui.web.api.NavigationContext

init

public void init()
Specified by:
init in interface org.nuxeo.ecm.platform.ui.web.api.NavigationContext

invalidateChildrenProvider

public void invalidateChildrenProvider()
Specified by:
invalidateChildrenProvider in interface org.nuxeo.ecm.platform.ui.web.api.NavigationContext

invalidateCurrentDocument

public void invalidateCurrentDocument()
                               throws org.nuxeo.ecm.core.api.ClientException
Specified by:
invalidateCurrentDocument in interface org.nuxeo.ecm.platform.ui.web.api.NavigationContext
Throws:
org.nuxeo.ecm.core.api.ClientException

navigateTo

public String navigateTo(org.nuxeo.ecm.platform.util.RepositoryLocation serverLocation,
                         org.nuxeo.ecm.core.api.DocumentRef docRef)
                  throws org.nuxeo.ecm.core.api.ClientException
Specified by:
navigateTo in interface org.nuxeo.ecm.platform.ui.web.api.NavigationContext
Throws:
org.nuxeo.ecm.core.api.ClientException

navigateToDocument

public String navigateToDocument(org.nuxeo.ecm.core.api.DocumentModel doc)
                          throws org.nuxeo.ecm.core.api.ClientException
Specified by:
navigateToDocument in interface org.nuxeo.ecm.platform.ui.web.api.NavigationContext
Throws:
org.nuxeo.ecm.core.api.ClientException

navigateToDocument

public String navigateToDocument(org.nuxeo.ecm.core.api.DocumentModel doc,
                                 String viewId)
                          throws org.nuxeo.ecm.core.api.ClientException
Specified by:
navigateToDocument in interface org.nuxeo.ecm.platform.ui.web.api.NavigationContext
Throws:
org.nuxeo.ecm.core.api.ClientException

navigateToDocument

public String navigateToDocument(org.nuxeo.ecm.core.api.DocumentModel docModel,
                                 org.nuxeo.ecm.core.api.VersionModel versionModel)
                          throws org.nuxeo.ecm.core.api.ClientException
Specified by:
navigateToDocument in interface org.nuxeo.ecm.platform.ui.web.api.NavigationContext
Throws:
org.nuxeo.ecm.core.api.ClientException

navigateToDocumentWithView

public String navigateToDocumentWithView(org.nuxeo.ecm.core.api.DocumentModel doc,
                                         String viewId)
                                  throws org.nuxeo.ecm.core.api.ClientException
Specified by:
navigateToDocumentWithView in interface org.nuxeo.ecm.platform.ui.web.api.NavigationContext
Throws:
org.nuxeo.ecm.core.api.ClientException

navigateToId

public String navigateToId(String documentId)
                    throws org.nuxeo.ecm.core.api.ClientException
Specified by:
navigateToId in interface org.nuxeo.ecm.platform.ui.web.api.NavigationContext
Throws:
org.nuxeo.ecm.core.api.ClientException

navigateToRef

public String navigateToRef(org.nuxeo.ecm.core.api.DocumentRef docRef)
                     throws org.nuxeo.ecm.core.api.ClientException
Specified by:
navigateToRef in interface org.nuxeo.ecm.platform.ui.web.api.NavigationContext
Throws:
org.nuxeo.ecm.core.api.ClientException

navigateToURL

public String navigateToURL()
                     throws org.nuxeo.ecm.core.api.ClientException
Specified by:
navigateToURL in interface org.nuxeo.ecm.platform.ui.web.api.NavigationContext
Throws:
org.nuxeo.ecm.core.api.ClientException

navigateToURL

public String navigateToURL(String documentUrl)
                     throws org.nuxeo.ecm.core.api.ClientException
Specified by:
navigateToURL in interface org.nuxeo.ecm.platform.ui.web.api.NavigationContext
Throws:
org.nuxeo.ecm.core.api.ClientException

resetCurrentContext

public void resetCurrentContext()
Specified by:
resetCurrentContext in interface org.nuxeo.ecm.platform.ui.web.api.NavigationContext

resetCurrentDocumentChildrenCache

public void resetCurrentDocumentChildrenCache(org.nuxeo.ecm.core.api.DocumentModel targetDoc)

saveCurrentDocument

public void saveCurrentDocument()
                         throws org.nuxeo.ecm.core.api.ClientException
Specified by:
saveCurrentDocument in interface org.nuxeo.ecm.platform.ui.web.api.NavigationContext
Throws:
org.nuxeo.ecm.core.api.ClientException

selectionChanged

public void selectionChanged()
Specified by:
selectionChanged in interface org.nuxeo.ecm.platform.ui.web.api.NavigationContext

setChangeableDocument

public void setChangeableDocument(org.nuxeo.ecm.core.api.DocumentModel changeableDocument)
Specified by:
setChangeableDocument in interface org.nuxeo.ecm.platform.ui.web.api.NavigationContext

setCurrentContentRoot

public void setCurrentContentRoot(org.nuxeo.ecm.core.api.DocumentModel currentContentRoot)
Specified by:
setCurrentContentRoot in interface org.nuxeo.ecm.platform.ui.web.api.NavigationContext

setCurrentDocument

public void setCurrentDocument(org.nuxeo.ecm.core.api.DocumentModel documentModel)
                        throws org.nuxeo.ecm.core.api.ClientException
Specified by:
setCurrentDocument in interface org.nuxeo.ecm.platform.ui.web.api.NavigationContext
Throws:
org.nuxeo.ecm.core.api.ClientException

setCurrentDomain

public void setCurrentDomain(org.nuxeo.ecm.core.api.DocumentModel currentDomain)
                      throws org.nuxeo.ecm.core.api.ClientException
Specified by:
setCurrentDomain in interface org.nuxeo.ecm.platform.ui.web.api.NavigationContext
Throws:
org.nuxeo.ecm.core.api.ClientException

setCurrentResultsProvider

public void setCurrentResultsProvider(org.nuxeo.ecm.core.api.PagedDocumentsProvider resultsProvider)

setCurrentServerLocation

public void setCurrentServerLocation(org.nuxeo.ecm.platform.util.RepositoryLocation serverLocation)
                              throws org.nuxeo.ecm.core.api.ClientException
Specified by:
setCurrentServerLocation in interface org.nuxeo.ecm.platform.ui.web.api.NavigationContext
Throws:
org.nuxeo.ecm.core.api.ClientException

updateDocumentContext

public void updateDocumentContext(org.nuxeo.ecm.core.api.DocumentModel doc)
                           throws org.nuxeo.ecm.core.api.ClientException
Specified by:
updateDocumentContext in interface org.nuxeo.ecm.platform.ui.web.api.NavigationContext
Throws:
org.nuxeo.ecm.core.api.ClientException

getResultsProvider

public org.nuxeo.ecm.core.api.PagedDocumentsProvider getResultsProvider(String name)
                                                                 throws org.nuxeo.ecm.core.api.ClientException,
                                                                        org.nuxeo.ecm.platform.ui.web.pagination.ResultsProviderFarmUserException
Throws:
org.nuxeo.ecm.core.api.ClientException
org.nuxeo.ecm.platform.ui.web.pagination.ResultsProviderFarmUserException

getResultsProvider

public org.nuxeo.ecm.core.api.PagedDocumentsProvider getResultsProvider(String name,
                                                                        org.nuxeo.ecm.core.api.SortInfo sortInfo)
                                                                 throws org.nuxeo.ecm.core.api.ClientException,
                                                                        org.nuxeo.ecm.platform.ui.web.pagination.ResultsProviderFarmUserException
Throws:
org.nuxeo.ecm.core.api.ClientException
org.nuxeo.ecm.platform.ui.web.pagination.ResultsProviderFarmUserException

Nuxeo Enterprise Platform 5.4

Copyright © 2011 Nuxeo SAS. All Rights Reserved.