org.nuxeo.ecm.webapp.contentbrowser

Interface DocumentActions

All Superinterfaces:

Serializable

All Known Implementing Classes:

DocumentActionsBean

public interface DocumentActions
extends Serializable

Author:

Razvan Caraghin

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHILDREN_DOCUMENT_LIST

Method Summary

Methods

Modifier and Type	Method and Description
String	createDocument() Creates a document with type given by TypesTool and stores it in the context as the current changeable document.
String	createDocument(String typeName) Creates a document with given type and stores it in the context as the current changeable document.
String	download() Deprecated.
void	download(DocumentView docView) Downloads file as described by given document view.
String	downloadFromList() Deprecated.
String	editDocument() Deprecated. since 5.3: edit views are managed through tabs, the edit view is not used.
void	followTransition(DocumentModel changedDocument)
boolean	getCanUnpublish() This method is used to test whether the logged user has enough rights for the unpublish support.
Type	getChangeableDocumentType()
String	getComment() Deprecated. since 5.4: comment can be put directly in the document context data using key 'request/comment'.
String	getCurrentDocumentSummaryLayout() Deprecated. since 5.6: nxl:documentLayout tag now offers the same features
Type	getCurrentType()
boolean	getWriteRight() Checks the current document write permission.
String	saveDocument() Creates the document from the changeableDocument put in request.
String	saveDocument(DocumentModel newDocument) Creates the given document.
void	setComment(String comment) Deprecated. since 5.4: comment can be put directly in the document context data using key 'request/comment'.
String	updateCurrentDocument() Updates document considering that current document model holds edited values.
String	updateDocument() Deprecated. since 5.4.2, currentDocument should be used in edition screens instead of changeableDocument, so updateCurrentDocument() should be used instead
String	updateDocument(DocumentModel document, Boolean restoreCurrentTabs) Saves changes held by the given document, and updates the current document context with the new version.
String	updateDocumentAsNewVersion() Saves changes held by the changeableDocument document model in current version and then create a new current one.

Field Detail

CHILDREN_DOCUMENT_LIST

static final String CHILDREN_DOCUMENT_LIST

See Also:

Constant Field Values

Method Detail

editDocument

@Deprecated
String editDocument()
                    throws ClientException

Deprecated. since 5.3: edit views are managed through tabs, the edit view is not used.

Returns the edit view of a document.

Throws:

ClientException

updateDocument

@Deprecated
String updateDocument()
                      throws ClientException

Deprecated. since 5.4.2, currentDocument should be used in edition screens instead of changeableDocument, so updateCurrentDocument() should be used instead

Saves changes held by the changeableDocument document model.

Throws:

ClientException

updateDocument

String updateDocument(DocumentModel document,
                    Boolean restoreCurrentTabs)
                      throws ClientException

Saves changes held by the given document, and updates the current document context with the new version.

Makes it possible to specify whether current tabs should be restored or not after edition.

Parameters:

restoreCurrentTabs -

Returns:

the JSF outcome for navigation after document edition.

Throws:

ClientException

Since:

5.7

updateDocumentAsNewVersion

String updateDocumentAsNewVersion()
                                  throws ClientException

Saves changes held by the changeableDocument document model in current version and then create a new current one.

Throws:

ClientException

updateCurrentDocument

String updateCurrentDocument()
                             throws ClientException

Updates document considering that current document model holds edited values.

Throws:

ClientException

createDocument

String createDocument()
                      throws ClientException

Creates a document with type given by TypesTool and stores it in the context as the current changeable document.

Returns the create view of given document type.

Throws:

ClientException

createDocument

String createDocument(String typeName)
                      throws ClientException

Creates a document with given type and stores it in the context as the current changeable document.

Returns the create view of given document type.

Throws:

ClientException

saveDocument

String saveDocument()
                    throws ClientException

Creates the document from the changeableDocument put in request.

Throws:

ClientException

saveDocument

String saveDocument(DocumentModel newDocument)
                    throws ClientException

Creates the given document.

Throws:

ClientException

download

@Deprecated
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
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()

getWriteRight

boolean getWriteRight()
                      throws ClientException

Checks the current document write permission.

Returns:

true if the user has WRITE permission on current document

Throws:

ClientException

getComment

@Deprecated
String getComment()

Deprecated. since 5.4: comment can be put directly in the document context data using key 'request/comment'.

Returns the comment to attach to the document

setComment

@Deprecated
void setComment(String comment)

Deprecated. since 5.4: comment can be put directly in the document context data using key 'request/comment'.

Sets the comment to attach to a document

getCanUnpublish

boolean getCanUnpublish()

This method is used to test whether the logged user has enough rights for the unpublish support.

Returns:

true if the user can unpublish, false otherwise

Throws:

ClientException

getCurrentDocumentSummaryLayout

@Deprecated
String getCurrentDocumentSummaryLayout()

Deprecated. since 5.6: nxl:documentLayout tag now offers the same features

followTransition

void followTransition(DocumentModel changedDocument)
                      throws ClientException

Throws:

ClientException