public interface DocumentActions extends Serializable
Modifier and Type | Field and Description |
---|---|
static String |
CHILDREN_DOCUMENT_LIST |
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.
|
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.
|
static final String CHILDREN_DOCUMENT_LIST
@Deprecated String editDocument()
@Deprecated String updateDocument()
updateCurrentDocument()
should be used insteadString updateDocument(DocumentModel document, Boolean restoreCurrentTabs)
Makes it possible to specify whether current tabs should be restored or not after edition.
restoreCurrentTabs
- String updateDocumentAsNewVersion()
String updateCurrentDocument()
String createDocument()
TypesTool
and stores it in the context as the current changeable
document.
Returns the create view of given document type.
String createDocument(String typeName)
Returns the create view of given document type.
String saveDocument()
String saveDocument(DocumentModel newDocument)
void download(DocumentView docView)
To be used by url pattern descriptors performing a download.
docView
- the document view as generated through the url service@Deprecated String downloadFromList()
Type getCurrentType()
null
if current doc is null.Type getChangeableDocumentType()
boolean getWriteRight()
true
if the user has WRITE permission on current document@Deprecated String getComment()
@Deprecated void setComment(String comment)
boolean getCanUnpublish()
@Deprecated String getCurrentDocumentSummaryLayout()
void followTransition(DocumentModel changedDocument)
Copyright © 2015 Nuxeo SA. All rights reserved.