com.communote.server.web.fe.widgets.extension.note

Class CPLNoteMetaDataProvider

java.lang.Object

com.communote.server.web.fe.widgets.extension.note.CPLNoteMetaDataProvider

All Implemented Interfaces:

Orderable, WidgetExtension<CPLNoteMetaDataProvider,CPLNoteMetaDataProviderManagement>

Direct Known Subclasses:

EmbedMediaMetadataProvider

public abstract class CPLNoteMetaDataProvider
extends Object
implements WidgetExtension<CPLNoteMetaDataProvider,CPLNoteMetaDataProviderManagement>

Extension for the ChronologicalPostListWidget which allows adding meta-data to a note which should be available in the JavaScript frontend, for example in a NoteActionHandler or a note click handler.

Author:

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

Field Summary

Fields inherited from interface com.communote.server.web.fe.widgets.extension.WidgetExtension

DEFAULT_ORDER_VALUE

Constructor Summary

Constructors

Constructor and Description
CPLNoteMetaDataProvider()

Method Summary

Modifier and Type	Method and Description
abstract void	addMetaData(Map<String,String> requestParameters, NoteData data, Map<String,Object> metaData) Add additional meta-data for the given note.
Class<CPLNoteMetaDataProviderManagement>	getManagementType()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.communote.common.util.Orderable

getOrder

Constructor Detail

CPLNoteMetaDataProvider

public CPLNoteMetaDataProvider()

Method Detail

addMetaData

public abstract void addMetaData(Map<String,String> requestParameters,
                                 NoteData data,
                                 Map<String,Object> metaData)

Add additional meta-data for the given note. The meta-data, which is transported in JSON to the JavaScript frontend, can be retrieved from the JavaScript widget instance by invoking getNoteMetaData(noteId). For performance reasons implementors are advised to only add String, Boolean and Number meta-data values to the map.

Parameters:

requestParameters - the parameters of the current request (e.g. full or partial widget refresh)

data - object holding details of the note

metaData - mapping from meta data key to value. Values should be of a simple type like String, Number and Boolean.

getManagementType

public Class<CPLNoteMetaDataProviderManagement> getManagementType()

Specified by:

getManagementType in interface WidgetExtension<CPLNoteMetaDataProvider,CPLNoteMetaDataProviderManagement>

Returns:

the type of the management that handles this extension