com.communote.plugins.activity.base.processor

Class ActivityNoteStoringPreProcessor

java.lang.Object

com.communote.plugins.activity.base.processor.ActivityNoteStoringPreProcessor

All Implemented Interfaces:

Orderable, NoteStoringImmutableContentPreProcessor

public class ActivityNoteStoringPreProcessor
extends Object
implements NoteStoringImmutableContentPreProcessor

Note storing pre processor which asserts that an activity message can be created. For activities that can not be created an exception is thrown. Creation will only be possible if the activity is active for the target topic. A TO is considered to be an activity if the templateId property is set and the property contentTypes.activity is set to activity.

Author:

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

Field Summary

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

DEFAULT_ORDER

Constructor Summary

Constructors

Constructor and Description
ActivityNoteStoringPreProcessor()

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

ActivityNoteStoringPreProcessor

public ActivityNoteStoringPreProcessor()

Method Detail

getOrder

public int getOrder()

Specified by:

getOrder in interface Orderable

Specified by:

getOrder in interface NoteStoringImmutableContentPreProcessor

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 NoteStoringImmutableContentPreProcessor

Returns:

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

process

public NoteStoringTO process(NoteStoringTO noteStoringTO)
                      throws ActivityDeactivatedNotePreProcessorException,
                             NoteStoringPreProcessorException,
                             NoteManagementAuthorizationException

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

Specified by:

process in interface NoteStoringImmutableContentPreProcessor

Parameters:

noteStoringTO - transfer object holding the data for creating the note

Returns:

The altered NoteStoringTO.

Throws:

ActivityDeactivatedNotePreProcessorException - Thrown, when the given activity is deactivated.

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: NoteStoringImmutableContentPreProcessor

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

Specified by:

processEdit in interface NoteStoringImmutableContentPreProcessor

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