org.nuxeo.ecm.social.workspace.gadgets.webengine

Class SocialWebEngineRoot

java.lang.Object

org.nuxeo.ecm.webengine.model.impl.AbstractResource<ResourceTypeImpl>

org.nuxeo.ecm.webengine.model.impl.DefaultObject

org.nuxeo.ecm.webengine.model.impl.ModuleRoot

org.nuxeo.ecm.social.workspace.gadgets.webengine.SocialWebEngineRoot

All Implemented Interfaces:

ModuleResource, Resource, Adaptable

public class SocialWebEngineRoot
extends ModuleRoot

Author:

rlegall

Constructor Summary

Constructors

Constructor and Description
SocialWebEngineRoot()

Method Summary

Methods

Modifier and Type	Method and Description
Object	addComment() Add comment to the related document and parent comment
String	computeDocumentURL(DocumentModel doc) Computes and returns the URL for the given doc, using the document link builder sets in the WebContext.
Object	createDocument(javax.servlet.http.HttpServletRequest request) Create the document given a post request where input item name is the field name ("dc:title", ...) and "docRef" value is the target document where to create the given document
Object	createDocumentForm(String ref, String docTypeId, String lang) Return the html form for creation of a document
Object	deleteDocument(javax.servlet.http.HttpServletRequest request) Remove the document specified in request
Object	docLike(String docRef) Like/Unlike the related document
Object	documentCommentList(String ref)
Object	documentList(javax.servlet.http.HttpServletRequest request) Main method that return a html snipped with the list of documents specified in request.
Object	documentListGet(javax.servlet.http.HttpServletRequest request)
String	escape(String text)
String	escapePath(String text)
Blob	getAttachment(DocumentModel doc) Returns the main blob for the given doc, null if there is no main file available.
String	getAvatarURL(String commentUser) Get the related user avatar to display in the UI comment
List<DocumentModel>	getCommentChildren(DocumentModel doc, DocumentModel parent)
List<DocumentModel>	getComments(DocumentModel doc)
long	getLikesCount(DocumentModel doc)
String	getTranslatedLabel(String label)
boolean	hasAddChildrenRight(String docId) Indicates if the current user has the right to Add Children to the current Document
boolean	hasUserLiked(DocumentModel doc)
Object	index(javax.servlet.http.HttpServletRequest request)
Object	publishDocument(javax.servlet.http.HttpServletRequest request)
Object	search(javax.servlet.http.HttpServletRequest request)
Object	selectDocTypeToCreate(String ref, String lang) return a form to select a doctype the user wants to create

Methods inherited from class org.nuxeo.ecm.webengine.model.impl.ModuleRoot

getLink, getSkinResource, handleError, setHttpHeaders, setHttpRequest, setUriInfo

Methods inherited from class org.nuxeo.ecm.webengine.model.impl.DefaultObject

disptachAdapter, isAdapter

Methods inherited from class org.nuxeo.ecm.webengine.model.impl.AbstractResource

checkGuard, dispose, getActiveAdapter, getAdapter, getContext, getFacets, getLinks, getModule, getName, getNext, getNextSegment, getPath, getPrevious, getTemplate, getTrailingPath, getType, getURL, getView, hasFacet, initialize, isInstanceOf, isRoot, newAdapter, newObject, redirect, setNext, setPrevious, setRoot, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.ecm.webengine.model.Resource

checkGuard, dispose, getActiveAdapter, getContext, getFacets, getLinks, getModule, getName, getNext, getNextSegment, getPath, getPrevious, getTemplate, getTrailingPath, getType, getURL, getView, hasFacet, initialize, isAdapter, isInstanceOf, isRoot, newAdapter, newObject, redirect, setNext, setPrevious, setRoot

Methods inherited from interface org.nuxeo.runtime.model.Adaptable

getAdapter

Constructor Detail

SocialWebEngineRoot

public SocialWebEngineRoot()

Method Detail

index

public Object index(@Context
           javax.servlet.http.HttpServletRequest request)
             throws Exception

Throws:

Exception

documentList

public Object documentList(@Context
                  javax.servlet.http.HttpServletRequest request)
                    throws Exception

Main method that return a html snipped with the list of documents specified in request.

parameters:

• docRef: parent document identifier (may be a path or an id)
• limit: number of documents per page
• page: index of the current page
• queryText (optional): search term

Throws:

Exception

documentListGet

public Object documentListGet(@Context
                     javax.servlet.http.HttpServletRequest request)
                       throws Exception

Throws:

Exception

search

public Object search(@Context
            javax.servlet.http.HttpServletRequest request)
              throws Exception

Throws:

Exception

Since:

5.6

publishDocument

public Object publishDocument(@Context
                     javax.servlet.http.HttpServletRequest request)
                       throws Exception

Throws:

Exception

deleteDocument

public Object deleteDocument(@Context
                    javax.servlet.http.HttpServletRequest request)
                      throws Exception

Remove the document specified in request

Throws:

Exception

createDocumentForm

public Object createDocumentForm(String ref,
                        String docTypeId,
                        String lang)
                          throws Exception

Return the html form for creation of a document

Throws:

Exception

selectDocTypeToCreate

public Object selectDocTypeToCreate(String ref,
                           String lang)
                             throws ClientException

return a form to select a doctype the user wants to create

Throws:

ClientException

createDocument

public Object createDocument(@Context
                    javax.servlet.http.HttpServletRequest request)
                      throws Exception

Create the document given a post request where input item name is the field name ("dc:title", ...) and "docRef" value is the target document where to create the given document

Throws:

Exception

getTranslatedLabel

public String getTranslatedLabel(String label)

getAttachment

public Blob getAttachment(DocumentModel doc)
                   throws ClientException

Returns the main blob for the given doc, null if there is no main file available.

Throws:

ClientException

escape

public String escape(String text)

escapePath

public String escapePath(String text)

hasAddChildrenRight

public boolean hasAddChildrenRight(String docId)

Indicates if the current user has the right to Add Children to the current Document

Parameters:

docId - the reference of the document

Returns:

true if the current user has the right to Add Children to the current Document and false otherwise

getComments

public List<DocumentModel> getComments(DocumentModel doc)
                                throws ClientException

Throws:

ClientException

documentCommentList

public Object documentCommentList(String ref)
                           throws Exception

Throws:

Exception

getCommentChildren

public List<DocumentModel> getCommentChildren(DocumentModel doc,
                                     DocumentModel parent)
                                       throws ClientException

Throws:

ClientException

addComment

public Object addComment()
                  throws ClientException

Add comment to the related document and parent comment

Throws:

ClientException

docLike

public Object docLike(String docRef)
               throws Exception

Like/Unlike the related document

Throws:

Exception

hasUserLiked

public boolean hasUserLiked(DocumentModel doc)

getLikesCount

public long getLikesCount(DocumentModel doc)

getAvatarURL

public String getAvatarURL(String commentUser)
                    throws ClientException

Get the related user avatar to display in the UI comment

Throws:

ClientException

computeDocumentURL

public String computeDocumentURL(DocumentModel doc)

Computes and returns the URL for the given doc, using the document link builder sets in the WebContext.