com.communote.plugins.api.rest.v30.resource.note

Class NoteBuildHelper

java.lang.Object

com.communote.plugins.api.rest.v30.resource.note.NoteBuildHelper

public class NoteBuildHelper
extends Object

Author:

Communote GmbH - http://www.communote.com/

Method Summary

Modifier and Type	Method and Description
static NoteResource	buildNoteResource(NoteData note) Create a resource object for a userListItem to send back only the values specified by the webservice definition
static javax.ws.rs.core.Response	buildNoteResponse(javax.ws.rs.core.Request request, NoteModificationResult result) Build the response of an note.
static void	setAttachmentsFromSession(String attribute, javax.servlet.http.HttpSession session, NoteStoringTO noteStoringTO) Adds an list with attachment identifier to NoteStoringTO.

Methods inherited from class java.lang.Object

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

Method Detail

buildNoteResource

public static NoteResource buildNoteResource(NoteData note)
                                      throws AuthorizationException,
                                             NoteNotFoundException

Create a resource object for a userListItem to send back only the values specified by the webservice definition

Parameters:

note - is a note object that contains also user/author specific data

Returns:

a noteResourceInstance that will be used to send back to the requester

Throws:

NoteNotFoundException - in case the note was removed after filling the NoteData object

AuthorizationException - in case the access rights to the topic/note were changed after filling the NoteData object

buildNoteResponse

public static javax.ws.rs.core.Response buildNoteResponse(javax.ws.rs.core.Request request,
                                                          NoteModificationResult result)
                                                   throws ResponseBuildException,
                                                          ExtensionNotSupportedException

Build the response of an note. Response status can be OK, WARNING or ERROR.

Parameters:

request - Request

result - NoteModificationStatus

Returns:

Response

Throws:

ResponseBuildException - exception while building the response

ExtensionNotSupportedException - extension is not supported

setAttachmentsFromSession

public static void setAttachmentsFromSession(String attribute,
                                             javax.servlet.http.HttpSession session,
                                             NoteStoringTO noteStoringTO)

Adds an list with attachment identifier to NoteStoringTO. The set of attachment identifier gets this function from an specific session attribute. The key of the attribute is the parameter of NoteResource.

Parameters:

attribute - of session

session - HttpSession

noteStoringTO - NoteStoringTO