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

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.
void	download(DocumentView docView) Downloads file as described by given document view.
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()
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.
String	updateCurrentDocument() Updates document considering that current document model holds edited values.
String	updateDocument(DocumentModel document, Boolean restoreCurrentTabs) Saves changes held by the given document, and updates the current document context with the new version.

Field Detail

CHILDREN_DOCUMENT_LIST

static final String CHILDREN_DOCUMENT_LIST

See Also:

Constant Field Values

Method Detail

updateDocument

String updateDocument(DocumentModel document,
                      Boolean restoreCurrentTabs)

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.

Since:

5.7

updateCurrentDocument

String updateCurrentDocument()

Updates document considering that current document model holds edited values.

createDocument

String createDocument()

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.

createDocument

String createDocument(String typeName)

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.

saveDocument

String saveDocument()

Creates the document from the changeableDocument put in request.

saveDocument

String saveDocument(DocumentModel newDocument)

Creates the given document.

download

void download(DocumentView docView)

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

getCurrentType

Type getCurrentType()

Returns:

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

getChangeableDocumentType

Type getChangeableDocumentType()

getWriteRight

boolean getWriteRight()

Checks the current document write permission.

Returns:

true if the user has WRITE permission on current 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

followTransition

void followTransition(DocumentModel changedDocument)