|
Nuxeo Enterprise Platform 5.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DocumentActions
Field Summary | |
---|---|
static String |
CHILDREN_DOCUMENT_LIST
|
Method Summary | |
---|---|
String |
checkCurrentDocAndProcessSelectPage(String providerName,
String listName,
Boolean selection,
String currentDocRef)
Deprecated. since 5.4, use DocumentListingActionsBean.checkCurrentDocAndProcessSelectPage(String, String, Boolean, String)
as selection is now done through ajax |
String |
checkCurrentDocAndProcessSelectRow(String docRef,
String providerName,
String listName,
Boolean selection,
String currentDocRef)
Deprecated. since 5.4, use DocumentListingActionsBean.checkCurrentDocAndProcessSelectRow(String, String, String, Boolean, String)
as selection is now done through ajax |
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 |
destroy()
|
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()
|
SelectDataModel |
getChildrenSelectModel()
Deprecated. since 5.4: SelectDataModel usage is now useless
since content views provide selection wrappers. |
String |
getComment()
Deprecated. since 5.4: comment can be put directly in the document context data using key 'request/comment'. |
String |
getCurrentDocumentSummaryLayout()
|
Type |
getCurrentType()
|
SelectDataModel |
getSectionChildrenSelectModel()
Deprecated. since 5.4: SelectDataModel usage is now useless
since content views provide selection wrappers. |
boolean |
getWriteRight()
Checks the current document write permission. |
void |
initialize()
|
String |
processSelectPage(String providerName,
String listName,
Boolean selection)
Deprecated. since 5.4, use DocumentListingActionsBean.processSelectPage(String, String, Boolean)
as selection is now done through ajax |
String |
processSelectRow(String docRef,
String providerName,
String listName,
Boolean selection)
Deprecated. since 5.4, use DocumentListingActionsBean.processSelectRow(String, String, String, Boolean)
as selection is now done through ajax |
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 |
updateDocumentAsNewVersion()
Saves changes held by the changeableDocument document model in current version and then create a new current one. |
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 |
---|
static final String CHILDREN_DOCUMENT_LIST
Method Detail |
---|
void initialize()
@Destroy void destroy()
@Deprecated String editDocument() throws ClientException
ClientException
@Deprecated String updateDocument() throws ClientException
updateCurrentDocument()
should be used instead
ClientException
String updateDocumentAsNewVersion() throws ClientException
ClientException
String updateCurrentDocument() throws ClientException
ClientException
String createDocument() throws ClientException
TypesTool
and stores it in
the context as the current changeable document.
Returns the create view of given document type.
ClientException
String createDocument(String typeName) throws ClientException
Returns the create view of given document type.
ClientException
String saveDocument() throws ClientException
ClientException
String saveDocument(DocumentModel newDocument) throws ClientException
ClientException
@Deprecated String download() throws ClientException
ClientException
void download(DocumentView docView) throws ClientException
To be used by url pattern descriptors performing a download.
docView
- the document view as generated through the url service
ClientException
- when document is not found or file is not
retrieved correctly.@Deprecated String downloadFromList() throws ClientException
ClientException
Type getCurrentType()
null
if current
doc is null.Type getChangeableDocumentType()
@Deprecated SelectDataModel getChildrenSelectModel() throws ClientException
SelectDataModel
usage is now useless
since content views provide selection wrappers.
ClientException
@Deprecated SelectDataModel getSectionChildrenSelectModel() throws ClientException
SelectDataModel
usage is now useless
since content views provide selection wrappers.
ClientException
boolean getWriteRight() throws ClientException
true
if the user has WRITE permission on current
document
ClientException
@WebRemote @Deprecated String checkCurrentDocAndProcessSelectRow(String docRef, String providerName, String listName, Boolean selection, String currentDocRef) throws ClientException
DocumentListingActionsBean.checkCurrentDocAndProcessSelectRow(String, String, String, Boolean, String)
as selection is now done through ajax
ClientException
- if currentDocRef is not a valid document@WebRemote @Deprecated String processSelectRow(String docRef, String providerName, String listName, Boolean selection)
DocumentListingActionsBean.processSelectRow(String, String, String, Boolean)
as selection is now done through ajax
@Deprecated @WebRemote String checkCurrentDocAndProcessSelectPage(String providerName, String listName, Boolean selection, String currentDocRef) throws ClientException
DocumentListingActionsBean.checkCurrentDocAndProcessSelectPage(String, String, Boolean, String)
as selection is now done through ajax
ClientException
- if currentDocRef is not a valid document@Deprecated @WebRemote String processSelectPage(String providerName, String listName, Boolean selection)
DocumentListingActionsBean.processSelectPage(String, String, Boolean)
as selection is now done through ajax
@Deprecated String getComment()
@Deprecated void setComment(String comment)
boolean getCanUnpublish()
ClientException
String getCurrentDocumentSummaryLayout()
void followTransition(DocumentModel changedDocument) throws ClientException
ClientException
|
Nuxeo Enterprise Platform 5.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |