|
Nuxeo Enterprise Platform 5.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.nuxeo.ecm.webapp.base.InputController
org.nuxeo.ecm.webapp.contentbrowser.DocumentActionsBean
@Name(value="documentActions") @Scope(value=CONVERSATION) public class DocumentActionsBean
Field Summary | |
---|---|
static String |
DEFAULT_SUMMARY_LAYOUT
|
Fields inherited from interface org.nuxeo.ecm.webapp.contentbrowser.DocumentActions |
---|
CHILDREN_DOCUMENT_LIST |
Constructor Summary | |
---|---|
DocumentActionsBean()
|
Method Summary | |
---|---|
String |
checkCurrentDocAndProcessSelectPage(String providerName,
String listName,
Boolean selection,
String currentDocRef)
Handle complete table selection event after having ensured that the navigation context stills points to currentDocumentRef to protect against browsers' back button errors |
String |
checkCurrentDocAndProcessSelectRow(String docRef,
String providerName,
String listName,
Boolean selection,
String currentDocRef)
Handle row selection event after having ensured that the navigation context stills points to currentDocumentRef to protect against browsers' back button errors |
String |
createDocument()
Returns the create view of a document type. |
String |
createDocument(String typeName)
Returns the create view of given document type. |
void |
destroy()
|
String |
download()
|
void |
download(DocumentView docView)
Downloads file as described by given document view. |
String |
downloadFromList()
|
String |
editDocument()
Returns the edit view of a document. |
boolean |
getCanUnpublish()
This method is used to test wheter the looged user has enough rights for the unpublish support. |
Type |
getChangeableDocumentType()
|
SelectDataModel |
getChildrenSelectModel()
|
String |
getComment()
|
String |
getCurrentDocumentSummaryLayout()
|
Type |
getCurrentType()
|
String |
getFileName(DocumentModel doc)
|
SelectDataModel |
getSectionChildrenSelectModel()
|
boolean |
getWriteRight()
Checks the current document write permission. |
void |
initialize()
|
String |
processSelectPage(String providerName,
String listName,
Boolean selection)
|
String |
processSelectRow(String docRef,
String providerName,
String listName,
Boolean selection)
|
void |
processSelectRowEvent(SelectDataModelRowEvent event)
|
void |
readState()
Activate method. |
String |
saveDocument()
Badly named method that actually creates a document. |
String |
saveDocument(DocumentModel newDocument)
|
void |
saveState()
Passivate method. |
void |
setComment(String comment)
|
String |
updateCurrentDocument()
Deprecated. should update changeableDocument and use updateDocument |
String |
updateDocument()
Saves changes hold by the changeableDocument document model. |
String |
updateDocumentAsNewVersion()
Saves changes 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 |
---|
public static String DEFAULT_SUMMARY_LAYOUT
Constructor Detail |
---|
public DocumentActionsBean()
Method Detail |
---|
public void initialize()
initialize
in interface DocumentActions
@Destroy public void destroy()
destroy
in interface DocumentActions
public void saveState()
StatefulBaseLifeCycle
saveState
in interface StatefulBaseLifeCycle
public void readState()
StatefulBaseLifeCycle
readState
in interface StatefulBaseLifeCycle
@Factory(autoCreate=true, value="currentDocumentSummaryLayout", scope=EVENT) public String getCurrentDocumentSummaryLayout()
@Factory(autoCreate=true, value="currentDocumentType", scope=EVENT) public Type getCurrentType()
getCurrentType
in interface DocumentActions
null
if current doc
is null.public Type getChangeableDocumentType()
getChangeableDocumentType
in interface DocumentActions
public String editDocument() throws ClientException
editDocument
in interface DocumentActions
ClientException
public String getFileName(DocumentModel doc) throws ClientException
ClientException
public String download() throws ClientException
download
in interface DocumentActions
ClientException
public void download(DocumentView docView) throws ClientException
DocumentActions
To be used by url pattern descriptors performing a download.
download
in interface DocumentActions
docView
- the document view as generated through the url service
ClientException
- when document is not found or file is not
retrieved correctly.public String downloadFromList() throws ClientException
downloadFromList
in interface DocumentActions
ClientException
@Deprecated public String updateCurrentDocument() throws ClientException
Method called from page action.
updateCurrentDocument
in interface DocumentActions
ClientException
public String updateDocument() throws ClientException
updateDocument
in interface DocumentActions
ClientException
public String updateDocumentAsNewVersion() throws ClientException
updateDocumentAsNewVersion
in interface DocumentActions
ClientException
public String createDocument() throws ClientException
createDocument
in interface DocumentActions
ClientException
public String createDocument(String typeName) throws ClientException
createDocument
in interface DocumentActions
ClientException
public String saveDocument() throws ClientException
saveDocument
in interface DocumentActions
ClientException
public String saveDocument(DocumentModel newDocument) throws ClientException
saveDocument
in interface DocumentActions
ClientException
@Factory(value="currentChildrenSelectModel", scope=EVENT) public SelectDataModel getChildrenSelectModel() throws ClientException
getChildrenSelectModel
in interface DocumentActions
ClientException
public SelectDataModel getSectionChildrenSelectModel() throws ClientException
getSectionChildrenSelectModel
in interface DocumentActions
ClientException
public void processSelectRowEvent(SelectDataModelRowEvent event)
processSelectRowEvent
in interface SelectDataModelListener
@WebRemote public String checkCurrentDocAndProcessSelectRow(String docRef, String providerName, String listName, Boolean selection, String currentDocRef) throws ClientException
checkCurrentDocAndProcessSelectRow
in interface DocumentActions
ClientException
- if currentDocRef is not a valid document@WebRemote public String processSelectRow(String docRef, String providerName, String listName, Boolean selection)
processSelectRow
in interface DocumentActions
@WebRemote public String checkCurrentDocAndProcessSelectPage(String providerName, String listName, Boolean selection, String currentDocRef) throws ClientException
checkCurrentDocAndProcessSelectPage
in interface DocumentActions
ClientException
- if currentDocRef is not a valid document@WebRemote public String processSelectPage(String providerName, String listName, Boolean selection)
processSelectPage
in interface DocumentActions
public boolean getWriteRight() throws ClientException
DocumentActions
getWriteRight
in interface DocumentActions
true
if the user has WRITE permission on current
document
ClientException
public String getComment()
getComment
in interface DocumentActions
public void setComment(String comment)
setComment
in interface DocumentActions
public boolean getCanUnpublish()
DocumentActions
getCanUnpublish
in interface DocumentActions
- false otherwise
|
Nuxeo Enterprise Platform 5.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |