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

Class NoteResourceHelper

java.lang.Object

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

public final class NoteResourceHelper
extends Object

Helper for NoteResourceHandler

Author:

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

Method Summary

Modifier and Type	Method and Description
static void	buildNoteResourceAttachments(NoteData note, NoteResource newNoteResource) Build the attachment part of the note
static void	buildNoteResourceNotifications(NoteData note, NoteResource newNoteResource) Build the notification part of the note
static NoteStoringTO	buildNoteStoringTO(CreateNoteParameter createNoteParameter) Get note storing transfer object
static NoteStoringTO	buildNoteStoringTO(EditNoteParameter editNoteParameter) Get note storing transferobject
static TagResource[]	buildTags(Collection<TagData> tagListItems) Build TagResources form Collection of TagData
static NoteRenderContext	createNoteRenderContext(Boolean filterHtml, boolean beautifyPlainText, javax.ws.rs.core.Request request) Creates a suitable note render context.
static void	setToForParameterUnspecificElements(Boolean isHtml, NoteStoringTO noteStoringTO) Set elements of NoteStoringTO object that are the same in create or edit method

Methods inherited from class java.lang.Object

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

Method Detail

buildNoteResourceAttachments

public static void buildNoteResourceAttachments(NoteData note,
                                                NoteResource newNoteResource)

Build the attachment part of the note

Parameters:

note - note of NoteData

newNoteResource - NoteResource

buildNoteResourceNotifications

public static void buildNoteResourceNotifications(NoteData note,
                                                  NoteResource newNoteResource)

Build the notification part of the note

Parameters:

note - note of NoteData

newNoteResource - NoteResource

buildNoteStoringTO

public static NoteStoringTO buildNoteStoringTO(CreateNoteParameter createNoteParameter)
                                        throws IllegalRequestParameterException

Get note storing transfer object

Parameters:

createNoteParameter - parameters to create an note

Returns:

NoteStoringTO

Throws:

IllegalRequestParameterException - text value is wrong

buildNoteStoringTO

public static NoteStoringTO buildNoteStoringTO(EditNoteParameter editNoteParameter)
                                        throws IllegalRequestParameterException

Get note storing transferobject

Parameters:

editNoteParameter - parameters to edit an note

Returns:

NoteStoringTO

Throws:

IllegalRequestParameterException - text value is wrong

buildTags

public static TagResource[] buildTags(Collection<TagData> tagListItems)

Build TagResources form Collection of TagData

Parameters:

tagListItems - Collection of TagData

Returns:

array of TagResource

createNoteRenderContext

public static NoteRenderContext createNoteRenderContext(Boolean filterHtml,
                                                        boolean beautifyPlainText,
                                                        javax.ws.rs.core.Request request)

Creates a suitable note render context.

Parameters:

filterHtml - if true the content should be returned as plain text

beautifyPlainText - if true beautifications can be applied when creating the plain text. Will be ignored if filterHtml is false.

request - the current request

Returns:

the prepared note render context

setToForParameterUnspecificElements

public static void setToForParameterUnspecificElements(Boolean isHtml,
                                                       NoteStoringTO noteStoringTO)

Set elements of NoteStoringTO object that are the same in create or edit method

Parameters:

isHtml - is note text content html

noteStoringTO - NoteStoringTO