org.nuxeo.ecm.core.rest

Class CommentService

java.lang.Object

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

org.nuxeo.ecm.webengine.model.impl.DefaultAdapter

org.nuxeo.ecm.core.rest.CommentService

All Implemented Interfaces:

AdapterResource, Resource, Adaptable

public class CommentService
extends DefaultAdapter

Comment Service - manages document comments.

Accepts the following methods:

• POST - create a new comment

Author:

Bogdan Stefanescu, Sun Seng David TAN, rux allow extending the service for the possible customizations. Some atomic actions are provided with default implementation but allowed for overwriting.

Field Summary

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

ctx, next, path, prev, type

Constructor Summary

Constructors

Constructor and Description
CommentService()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	approve()
protected void	approveComent(CoreSession session, DocumentModel target, DocumentModel comment) Can be overwritten to allow workflow.
protected DocumentModel	createCommentDocument(CoreSession session, DocumentModel target, DocumentModel comment) Can be overwritten to allow creation of localized comment.
javax.ws.rs.core.Response	deleteComment()
protected void	deleteComment(DocumentModel target, DocumentModel comment) Can be overwritten to allow workflow.
javax.ws.rs.core.Response	doPost(String cText)
static CommentManager	getCommentManager()
static CommentsModerationService	getCommentsModerationService()
protected void	publishComment(CoreSession session, DocumentModel target, DocumentModel comment) Can be overwritten to allow workflow.
javax.ws.rs.core.Response	reject()
protected void	rejectComment(CoreSession session, DocumentModel target, DocumentModel comment) Can be overwritten to allow workflow.
javax.ws.rs.core.Response	remove()

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

disptachAdapter, getTarget, 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, initialize, isInstanceOf, isRoot, newAdapter, newObject, redirect, setNext, setPrevious, setRoot, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, 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, isInstanceOf, isRoot, newAdapter, newObject, redirect, setNext, setPrevious, setRoot

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

getAdapter

Constructor Detail

CommentService

public CommentService()

Method Detail

doPost

public javax.ws.rs.core.Response doPost(String cText)

reject

public javax.ws.rs.core.Response reject()

approve

public javax.ws.rs.core.Response approve()

remove

public javax.ws.rs.core.Response remove()

deleteComment

public javax.ws.rs.core.Response deleteComment()
                                        throws Exception

Throws:

Exception

getCommentManager

public static CommentManager getCommentManager()
                                        throws Exception

Throws:

Exception

getCommentsModerationService

public static CommentsModerationService getCommentsModerationService()
                                                              throws Exception

Throws:

Exception

createCommentDocument

protected DocumentModel createCommentDocument(CoreSession session,
                                              DocumentModel target,
                                              DocumentModel comment)
                                       throws Exception

Can be overwritten to allow creation of localized comment. Defaults to create comment in comments root.

Parameters:

session - the core session

target - commented document

comment - comment itself

Returns:

the comment created

Throws:

Exception

publishComment

protected void publishComment(CoreSession session,
                              DocumentModel target,
                              DocumentModel comment)
                       throws Exception

Can be overwritten to allow workflow. Defaults to publish right away.

Parameters:

session - the core session

target - commented document

comment - comment itself

Throws:

Exception

deleteComment

protected void deleteComment(DocumentModel target,
                             DocumentModel comment)
                      throws Exception

Can be overwritten to allow workflow. Defaults to delete right away.

Parameters:

target - commented document

comment - comment itself

Throws:

Exception

rejectComment

protected void rejectComment(CoreSession session,
                             DocumentModel target,
                             DocumentModel comment)
                      throws Exception

Can be overwritten to allow workflow. Defaults to reject and delete right away.

Parameters:

target - commented document

comment - comment itself

Throws:

Exception

approveComent

protected void approveComent(CoreSession session,
                             DocumentModel target,
                             DocumentModel comment)
                      throws Exception

Can be overwritten to allow workflow. Defaults to approve right away.

Parameters:

target - commented document

comment - comment itself

Throws:

Exception