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, 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
protected ActionContextProvider	actionContextProvider
static String	BLOB_ACTIONS_CATEGORY
protected String	comment
protected DeleteActions	deleteActions
protected CoreSession	documentManager
protected DocumentsListsManager	documentsListsManager
protected String	fileFieldFullName
protected String	filename
protected String	filenameFieldFullName
static String	LIFE_CYCLE_TRANSITION_KEY
protected Map<String,String>	messages
protected String	parentDocumentPath
protected Boolean	restoreCurrentTabs Boolean request parameter used to restore current tabs (current tab and subtab) after edition.
protected WebActions	webActions

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

actionManager, currentDocument, currentUser, eventManager, facesMessages, navigationContext, resourcesAccessor, typeManager, typesTool

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

CHILDREN_DOCUMENT_LIST

Constructor Summary

Constructors

Constructor and Description
DocumentActionsBean()

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)
List<AppLink>	getAppLinks(String docId, String blobXPath)
List<Action>	getBlobActions(DocumentModel doc, String blobXPath, Blob blob)
boolean	getCanUnpublish() This method is used to test whether the logged user has enough rights for the unpublish support.
boolean	getCanUpdateMainBlob() Checks if the main blob can be updated by a user-initiated action.
Type	getChangeableDocumentType()
Type	getCurrentType()
String	getFileName(DocumentModel doc)
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.
protected String	updateDocument(DocumentModel doc)
String	updateDocument(DocumentModel doc, Boolean restoreCurrentTabs) Saves changes held by the given document, and updates the current document context with the new version.

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

computeOutcome, extractReferences, getAdministrator, logDocumentWithName, logDocumentWithTitle, removeDocumentFromList, setFacesMessage

Methods inherited from class java.lang.Object

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

Field Detail

LIFE_CYCLE_TRANSITION_KEY

public static final String LIFE_CYCLE_TRANSITION_KEY

See Also:

Constant Field Values

BLOB_ACTIONS_CATEGORY

public static final String BLOB_ACTIONS_CATEGORY

See Also:

Constant Field Values

fileFieldFullName

@RequestParameter
protected String fileFieldFullName

filenameFieldFullName

@RequestParameter
protected String filenameFieldFullName

filename

@RequestParameter
protected String filename

documentManager

@In(create=true,
    required=false)
protected transient CoreSession documentManager

documentsListsManager

@In(required=false,
    create=true)
protected transient DocumentsListsManager documentsListsManager

deleteActions

@In(create=true)
protected transient DeleteActions deleteActions

actionContextProvider

@In(create=true,
    required=false)
protected transient ActionContextProvider actionContextProvider

restoreCurrentTabs

@RequestParameter
protected Boolean restoreCurrentTabs

Boolean request parameter used to restore current tabs (current tab and subtab) after edition.

This is useful when editing the document from a layout toggled to edit mode from summary-like page.

Since:

5.6

webActions

@In(create=true)
protected transient WebActions webActions

comment

protected String comment

messages

@In(create=true)
protected Map<String,String> messages

parentDocumentPath

@RequestParameter
protected String parentDocumentPath

Constructor Detail

DocumentActionsBean

public DocumentActionsBean()

Method Detail

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

getFileName

public String getFileName(DocumentModel doc)

download

public void download(DocumentView docView)

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

updateDocument

public String updateDocument(DocumentModel doc,
                             Boolean restoreCurrentTabs)

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.

updateDocument

protected String updateDocument(DocumentModel doc)

updateCurrentDocument

public String updateCurrentDocument()

Description copied from interface: DocumentActions

Updates document considering that current document model holds edited values.

Specified by:

updateCurrentDocument in interface DocumentActions

createDocument

public String createDocument()

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

createDocument

public String createDocument(String typeName)

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

saveDocument

public String saveDocument()

Description copied from interface: DocumentActions

Creates the document from the changeableDocument put in request.

Specified by:

saveDocument in interface DocumentActions

saveDocument

public String saveDocument(DocumentModel newDocument)

Description copied from interface: DocumentActions

Creates the given document.

Specified by:

saveDocument in interface DocumentActions

getWriteRight

public boolean getWriteRight()

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

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)

Specified by:

followTransition in interface DocumentActions

getBlobActions

public List<Action> getBlobActions(DocumentModel doc,
                                   String blobXPath,
                                   Blob blob)

Since:

7.3

getAppLinks

@WebRemote
public List<AppLink> getAppLinks(String docId,
                                            String blobXPath)

Since:

7.3

getCanUpdateMainBlob

public boolean getCanUpdateMainBlob()

Checks if the main blob can be updated by a user-initiated action.

Since:

7.10