org.nuxeo.ecm.webapp.contentbrowser

Class DocumentActionsBean

java.lang.Object

org.nuxeo.ecm.webapp.base.InputController

org.nuxeo.ecm.webapp.contentbrowser.DocumentActionsBean

All Implemented Interfaces:

Serializable, EventListener, SelectDataModelListener, DocumentActions

@Name(value="documentActions")
@Scope(value=CONVERSATION)
public class DocumentActionsBean
extends InputController
implements DocumentActions, Serializable

Handles creation and edition of a document.

Author:

Razvan Caraghin, M.-A. Darche

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SUMMARY_LAYOUT Deprecated. since 5.6: default layout can now be defined on the nxl:documentLayout tag
static String	LIFE_CYCLE_TRANSITION_KEY

Fields inherited from interface org.nuxeo.ecm.webapp.contentbrowser.DocumentActions

CHILDREN_DOCUMENT_LIST

Constructor Summary

Constructors

Constructor and Description
DocumentActionsBean()

Method Summary

Methods

Modifier and Type	Method and Description
String	checkCurrentDocAndProcessSelectPage(String providerName, String listName, Boolean selection, String currentDocRef) Deprecated.
String	checkCurrentDocAndProcessSelectRow(String docRef, String providerName, String listName, Boolean selection, String currentDocRef) Deprecated.
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.
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.
String	getComment() Deprecated.
String	getCurrentDocumentSummaryLayout() Deprecated.
Type	getCurrentType()
String	getFileName(DocumentModel doc)
SelectDataModel	getSectionChildrenSelectModel() Deprecated.
boolean	getWriteRight() Checks the current document write permission.
String	processSelectPage(String providerName, String listName, Boolean selection) Deprecated.
String	processSelectRow(String docRef, String providerName, String listName, Boolean selection) Deprecated.
void	processSelectRowEvent(SelectDataModelRowEvent event)
String	saveDocument() Creates the document from the changeableDocument put in request.
String	saveDocument(DocumentModel newDocument) Creates the given document.
void	setComment(String comment) Deprecated.
String	updateCurrentDocument() Updates document considering that current document model holds edited values.
String	updateDocument() Deprecated.
String	updateDocument(DocumentModel doc, 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.

Methods inherited from class org.nuxeo.ecm.webapp.base.InputController

computeOutcome, getAdministrator, logDocumentWithName, logDocumentWithTitle, removeDocumentFromList

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_SUMMARY_LAYOUT

@Deprecated
public static final String DEFAULT_SUMMARY_LAYOUT

Deprecated. since 5.6: default layout can now be defined on the nxl:documentLayout tag

See Also:

Constant Field Values

LIFE_CYCLE_TRANSITION_KEY

public static final String LIFE_CYCLE_TRANSITION_KEY

See Also:

Constant Field Values

Constructor Detail

DocumentActionsBean

public DocumentActionsBean()

Method Detail

getCurrentDocumentSummaryLayout

@Deprecated
@Factory(autoCreate=true,
         value="currentDocumentSummaryLayout",
         scope=EVENT)
public String getCurrentDocumentSummaryLayout()

Deprecated.

Specified by:

getCurrentDocumentSummaryLayout in interface DocumentActions

getCurrentType

@Factory(autoCreate=true,
         value="currentDocumentType",
         scope=EVENT)
public Type getCurrentType()

Specified by:

getCurrentType in interface DocumentActions

Returns:

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

getChangeableDocumentType

public Type getChangeableDocumentType()

Specified by:

getChangeableDocumentType in interface DocumentActions

editDocument

@Deprecated
public String editDocument()
                    throws ClientException

Deprecated.

Description copied from interface: DocumentActions

Returns the edit view of a document.

Specified by:

editDocument in interface DocumentActions

Throws:

ClientException

getFileName

public String getFileName(DocumentModel doc)
                   throws ClientException

Throws:

ClientException

download

@Deprecated
public String download()
                throws ClientException

Deprecated.

Specified by:

download in interface DocumentActions

Throws:

ClientException

download

public void download(DocumentView docView)
              throws ClientException

Description copied from interface: DocumentActions

Downloads file as described by given document view.

To be used by url pattern descriptors performing a download.

Specified by:

download in interface DocumentActions

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
public String downloadFromList()
                        throws ClientException

Deprecated.

Specified by:

downloadFromList in interface DocumentActions

Throws:

ClientException

updateDocument

public String updateDocument(DocumentModel doc,
                    Boolean restoreCurrentTabs)
                      throws ClientException

Description copied from interface: DocumentActions

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.

Specified by:

updateDocument in interface DocumentActions

Returns:

the JSF outcome for navigation after document edition.

Throws:

ClientException

updateCurrentDocument

public String updateCurrentDocument()
                             throws ClientException

Description copied from interface: DocumentActions

Updates document considering that current document model holds edited values.

Specified by:

updateCurrentDocument in interface DocumentActions

Throws:

ClientException

updateDocument

@Deprecated
public String updateDocument()
                      throws ClientException

Deprecated.

Description copied from interface: DocumentActions

Saves changes held by the changeableDocument document model.

Specified by:

updateDocument in interface DocumentActions

Throws:

ClientException

updateDocumentAsNewVersion

public String updateDocumentAsNewVersion()
                                  throws ClientException

Description copied from interface: DocumentActions

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

Specified by:

updateDocumentAsNewVersion in interface DocumentActions

Throws:

ClientException

createDocument

public String createDocument()
                      throws ClientException

Description copied from interface: DocumentActions

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.

Specified by:

createDocument in interface DocumentActions

Throws:

ClientException

createDocument

public String createDocument(String typeName)
                      throws ClientException

Description copied from interface: DocumentActions

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.

Specified by:

createDocument in interface DocumentActions

Throws:

ClientException

saveDocument

public String saveDocument()
                    throws ClientException

Description copied from interface: DocumentActions

Creates the document from the changeableDocument put in request.

Specified by:

saveDocument in interface DocumentActions

Throws:

ClientException

saveDocument

public String saveDocument(DocumentModel newDocument)
                    throws ClientException

Description copied from interface: DocumentActions

Creates the given document.

Specified by:

saveDocument in interface DocumentActions

Throws:

ClientException

getChildrenSelectModel

@Deprecated
@Factory(value="currentChildrenSelectModel",
         scope=EVENT)
public SelectDataModel getChildrenSelectModel()
                                       throws ClientException

Deprecated.

Specified by:

getChildrenSelectModel in interface DocumentActions

Throws:

ClientException

getSectionChildrenSelectModel

@Deprecated
public SelectDataModel getSectionChildrenSelectModel()
                                              throws ClientException

Deprecated.

Specified by:

getSectionChildrenSelectModel in interface DocumentActions

Throws:

ClientException

processSelectRowEvent

public void processSelectRowEvent(SelectDataModelRowEvent event)

Specified by:

processSelectRowEvent in interface SelectDataModelListener

checkCurrentDocAndProcessSelectRow

@Deprecated
@WebRemote
public String checkCurrentDocAndProcessSelectRow(String docRef,
                                                             String providerName,
                                                             String listName,
                                                             Boolean selection,
                                                             String currentDocRef)
                                          throws ClientException

Deprecated.

Description copied from interface: DocumentActions

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

Specified by:

checkCurrentDocAndProcessSelectRow in interface DocumentActions

Throws:

ClientException - if currentDocRef is not a valid document

processSelectRow

@Deprecated
@WebRemote
public String processSelectRow(String docRef,
                                           String providerName,
                                           String listName,
                                           Boolean selection)

Deprecated.

Specified by:

processSelectRow in interface DocumentActions

checkCurrentDocAndProcessSelectPage

@Deprecated
@WebRemote
public String checkCurrentDocAndProcessSelectPage(String providerName,
                                                              String listName,
                                                              Boolean selection,
                                                              String currentDocRef)
                                           throws ClientException

Deprecated.

Description copied from interface: DocumentActions

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

Specified by:

checkCurrentDocAndProcessSelectPage in interface DocumentActions

Throws:

ClientException - if currentDocRef is not a valid document

processSelectPage

@Deprecated
@WebRemote
public String processSelectPage(String providerName,
                                            String listName,
                                            Boolean selection)

Deprecated.

Specified by:

processSelectPage in interface DocumentActions

getWriteRight

public boolean getWriteRight()
                      throws ClientException

Description copied from interface: DocumentActions

Checks the current document write permission.

Specified by:

getWriteRight in interface DocumentActions

Returns:

true if the user has WRITE permission on current document

Throws:

ClientException

getComment

@Deprecated
public String getComment()

Deprecated.

Description copied from interface: DocumentActions

Returns the comment to attach to the document

Specified by:

getComment in interface DocumentActions

setComment

@Deprecated
public void setComment(String comment)

Deprecated.

Description copied from interface: DocumentActions

Sets the comment to attach to a document

Specified by:

setComment in interface DocumentActions

getCanUnpublish

public boolean getCanUnpublish()

Description copied from interface: DocumentActions

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

Specified by:

getCanUnpublish in interface DocumentActions

Returns:

true if the user can unpublish, false otherwise

followTransition

@Observer(value="beforeDocumentChanged")
public void followTransition(DocumentModel changedDocument)
                      throws ClientException

Specified by:

followTransition in interface DocumentActions

Throws:

ClientException