com.communote.server.core.template

Class TemplateNoteStoringPreProcessor

java.lang.Object

com.communote.server.core.template.TemplateNoteStoringPreProcessor

All Implemented Interfaces:

Orderable, NoteStoringEditableContentPreProcessor

public class TemplateNoteStoringPreProcessor
extends Object
implements NoteStoringEditableContentPreProcessor

Note storing pre-processor which will set the default content of a template note by rendering the template with default language and plain text render mode.

Author:

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

Field Summary

Fields inherited from interface com.communote.server.api.core.note.processor.NoteStoringEditableContentPreProcessor

DEFAULT_ORDER

Constructor Summary

Constructors

Constructor and Description
TemplateNoteStoringPreProcessor()

Method Summary

Modifier and Type	Method and Description
int	getOrder()
boolean	isProcessAutosave()
NoteStoringTO	process(NoteStoringTO noteStoringTO) Processing function which is invoked before a new note is created.
NoteStoringTO	processEdit(Note noteToEdit, NoteStoringTO noteStoringTO) Processing function which is invoked before an existing note is updated.

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateNoteStoringPreProcessor

public TemplateNoteStoringPreProcessor()

Method Detail

getOrder

public int getOrder()

Specified by:

getOrder in interface Orderable

Specified by:

getOrder in interface NoteStoringEditableContentPreProcessor

Returns:

the order value which is interpreted as the priority of the processor. The higher the priority, the earlier this extension will be called.

isProcessAutosave

public boolean isProcessAutosave()

Specified by:

isProcessAutosave in interface NoteStoringEditableContentPreProcessor

Returns:

whether the PreProcessor should also be called when doing an autosave. This is normally not required.

process

public NoteStoringTO process(NoteStoringTO noteStoringTO)
                      throws NoteStoringPreProcessorException,
                             NoteManagementAuthorizationException

Description copied from interface: NoteStoringEditableContentPreProcessor

Processing function which is invoked before a new note is created.

Specified by:

process in interface NoteStoringEditableContentPreProcessor

Parameters:

noteStoringTO - transfer object holding the data for creating the note

Returns:

The altered NoteStoringTO.

Throws:

NoteStoringPreProcessorException - thrown to indicate that the pre-processing failed and the note cannot be created

NoteManagementAuthorizationException - thrown to indicate that the note cannot be created because of access restrictions

processEdit

public NoteStoringTO processEdit(Note noteToEdit,
                                 NoteStoringTO noteStoringTO)
                          throws NoteStoringPreProcessorException,
                                 NoteManagementAuthorizationException

Description copied from interface: NoteStoringEditableContentPreProcessor

Processing function which is invoked before an existing note is updated.

Specified by:

processEdit in interface NoteStoringEditableContentPreProcessor

Parameters:

noteToEdit - the note which should be edited. Implementors should not modify the note.

noteStoringTO - transfer object holding the data for updating the note

Returns:

The altered NoteStoringTO.

Throws:

NoteStoringPreProcessorException - thrown to indicate that the pre-processing failed and the note cannot be created

NoteManagementAuthorizationException - thrown to indicate that the note cannot be created because of access restrictions