org.nuxeo.ecm.webapp.contentbrowser
Interface DocumentActions

All Superinterfaces:

java.util.EventListener, SelectDataModelListener, StatefulBaseLifeCycle

All Known Implementing Classes:

DocumentActionsBean

public interface DocumentActions
extends StatefulBaseLifeCycle, SelectDataModelListener

Author:

Razvan Caraghin

Field Summary

static java.lang.String

CHILDREN_DOCUMENT_LIST

Method Summary

java.lang.String	checkCurrentDocAndProcessSelectPage(java.lang.String providerName, java.lang.String listName, java.lang.Boolean selection, java.lang.String currentDocRef) Handle complete table selection event after having ensured that the navigation context stills points to currentDocumentRef to protect against browsers' back button errors
java.lang.String	checkCurrentDocAndProcessSelectRow(java.lang.String docRef, java.lang.String providerName, java.lang.String listName, java.lang.Boolean selection, java.lang.String currentDocRef) Handle complete row selection event after having ensured that the navigation context stills points to currentDocumentRef to protect against browsers' back button errors
java.lang.String	createDocument()
java.lang.String	createDocument(java.lang.String typeName)
void	destroy()
java.lang.String	download() Deprecated.
void	download(DocumentView docView) Downloads file as described by given document view.
java.lang.String	downloadFromList() Deprecated.
java.lang.String	editDocument()
boolean	getCanUnpublish() This method is used to test wheter the looged user has enough rights for the unpublish support.
Type	getChangeableDocumentType()
SelectDataModel	getChildrenSelectModel()
java.lang.String	getComment()
Type	getCurrentType()
SelectDataModel	getSectionChildrenSelectModel()
boolean	getWriteRight() Checks the current document write permission.
void	initialize()
java.lang.String	processSelectPage(java.lang.String providerName, java.lang.String listName, java.lang.Boolean selection)
java.lang.String	processSelectRow(java.lang.String docRef, java.lang.String providerName, java.lang.String listName, java.lang.Boolean selection)
java.lang.String	saveDocument()
java.lang.String	saveDocument(DocumentModel newDocument)
void	setComment(java.lang.String comment)
java.lang.String	updateCurrentDocument()
java.lang.String	updateDocument()
java.lang.String	updateDocumentAsNewVersion()

Methods inherited from interface org.nuxeo.ecm.webapp.base.StatefulBaseLifeCycle

readState, saveState

Methods inherited from interface org.nuxeo.ecm.platform.ui.web.model.SelectDataModelListener

processSelectRowEvent

Field Detail

CHILDREN_DOCUMENT_LIST

static final java.lang.String CHILDREN_DOCUMENT_LIST

See Also:

Constant Field Values

Method Detail

initialize

void initialize()

destroy

@Destroy
void destroy()

editDocument

java.lang.String editDocument()
                              throws ClientException

Throws:

ClientException

updateDocument

java.lang.String updateDocument()
                                throws ClientException

Throws:

ClientException

updateDocumentAsNewVersion

java.lang.String updateDocumentAsNewVersion()
                                            throws ClientException

Throws:

ClientException

updateCurrentDocument

java.lang.String updateCurrentDocument()
                                       throws ClientException

Throws:

ClientException

createDocument

java.lang.String createDocument()
                                throws ClientException

Throws:

ClientException

createDocument

java.lang.String createDocument(java.lang.String typeName)
                                throws ClientException

Throws:

ClientException

saveDocument

java.lang.String saveDocument()
                              throws ClientException

Throws:

ClientException

saveDocument

java.lang.String saveDocument(DocumentModel newDocument)
                              throws ClientException

Throws:

ClientException

download

@Deprecated
java.lang.String download()
                          throws ClientException

Deprecated.

Throws:

ClientException

download

void download(DocumentView docView)
              throws ClientException

Downloads file as described by given document view.

To be used by url pattern descriptors performing a download.

Parameters:

docView - the document view as generated through the url service

Throws:

ClientException - when document is not found or file is not retrieved correctly.

downloadFromList

@Deprecated
java.lang.String downloadFromList()
                                  throws ClientException

Deprecated.

Throws:

ClientException

getCurrentType

Type getCurrentType()

Returns:

ecm type for current document, null if current doc is null.

getChangeableDocumentType

Type getChangeableDocumentType()

getChildrenSelectModel

SelectDataModel getChildrenSelectModel()
                                       throws ClientException

Throws:

ClientException

getSectionChildrenSelectModel

SelectDataModel getSectionChildrenSelectModel()
                                              throws ClientException

Throws:

ClientException

getWriteRight

boolean getWriteRight()
                      throws ClientException

Checks the current document write permission.

Returns:

true if the user has WRITE permission on current document

Throws:

ClientException

checkCurrentDocAndProcessSelectRow

@WebRemote
java.lang.String checkCurrentDocAndProcessSelectRow(java.lang.String docRef,
                                                              java.lang.String providerName,
                                                              java.lang.String listName,
                                                              java.lang.Boolean selection,
                                                              java.lang.String currentDocRef)
                                                    throws ClientException

Handle complete row selection event after having ensured that the navigation context stills points to currentDocumentRef to protect against browsers' back button errors

Throws:

ClientException - if currentDocRef is not a valid document

processSelectRow

@WebRemote
java.lang.String processSelectRow(java.lang.String docRef,
                                            java.lang.String providerName,
                                            java.lang.String listName,
                                            java.lang.Boolean selection)

checkCurrentDocAndProcessSelectPage

@WebRemote
java.lang.String checkCurrentDocAndProcessSelectPage(java.lang.String providerName,
                                                               java.lang.String listName,
                                                               java.lang.Boolean selection,
                                                               java.lang.String currentDocRef)
                                                     throws ClientException

Handle complete table selection event after having ensured that the navigation context stills points to currentDocumentRef to protect against browsers' back button errors

Throws:

ClientException - if currentDocRef is not a valid document

processSelectPage

@WebRemote
java.lang.String processSelectPage(java.lang.String providerName,
                                             java.lang.String listName,
                                             java.lang.Boolean selection)

getComment

java.lang.String getComment()

setComment

void setComment(java.lang.String comment)

getCanUnpublish

boolean getCanUnpublish()

This method is used to test wheter the looged user has enough rights for the unpublish support.

Returns:

- true if the user can unpublish

- false otherwise

Throws:

ClientException