com.communote.server.web.fe.widgets.blog

Class ChronologicalPostListWidget

java.lang.Object

com.communote.server.widgets.AbstractWidget

com.communote.server.widgets.AbstractMultipleResultWidget<I>

com.communote.server.web.fe.widgets.AbstractPagedListWidget<NoteData>

com.communote.server.web.fe.widgets.blog.ChronologicalPostListWidget

All Implemented Interfaces:

PagedWidget<NoteData>, RssSupportWidget, Widget

public class ChronologicalPostListWidget
extends AbstractPagedListWidget<NoteData>
implements RssSupportWidget

Widget for displaying a list of blog posts.

Author:

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

Field Summary

Fields inherited from class com.communote.server.web.fe.widgets.AbstractPagedListWidget

METADATA_KEY_ELEMENTS_CONTAINED, METADATA_KEY_MORE_AVAILABLE, PARAM_PAGING_INTERVAL

Fields inherited from class com.communote.server.widgets.AbstractWidget

METADATA_KEY_NO_CONTENT

Fields inherited from interface com.communote.server.web.fe.widgets.PagedWidget

PAGING_MASSAGE_KEY_PREFIX, PARAM_PAGING_MESSAGE_KEY_SUFFIX

Fields inherited from interface com.communote.server.widgets.Widget

PARAM_WIDGET_ID

Constructor Summary

Constructors

Constructor and Description
ChronologicalPostListWidget()

Method Summary

Modifier and Type	Method and Description
protected NoteQueryParameters	configureQueryInstance(NoteQuery definition)
Boolean	getBlogPropertyAsBoolean(Long blogId, String keyGroup, String key) Get an boolean blog property.
String	getClassName()
Locale	getCurrentUserLocale()
PageableList<NoteData>	getDiscussionNotes(long discussionId, boolean listViewMode, Locale locale) Helper which fetches the notes of a discussion and returns them a style dependent of the selected view.
String	getDiscussionTitle(NoteData note, Locale locale) Get the discussion title for the note (e.g.
String	getNoteActions(NoteData note) Return a CSV listing the actions that can be executed on a note.
String	getNoteItemTemplate(NoteData data) Return the location of a template to use for rendering the HTML of the provided note
String	getNoteMetaData(NoteData note) Create a JSON object containing some meta data about a note.
String	getNoteTitle(NoteData note, Locale locale) Get the note title for the note (e.g.
long	getParentPostFilter()
NoteQueryParameters	getQueryParameters()
String	getRssFeedLink()
String	getRssParameters() Get the Parameters relevant for the rss or news feed.
static String[]	getSuppliedParameters() Get the parameter names, which are necessary to save or retrieve the corresponding newsfeeds.
String	getTile(String outputType) Get the tile to be used for rendering
TimeZone	getTimeZone() Gets the effective time zone for the user
String	getTimeZoneId() Gets the effective time zone id for the user
protected PageableList<NoteData>	handleQueryList() hook that actually requests the list on the api
protected void	initParameters() init the widget parameters to these values: filter = '' offset = 0 maxCount = 30
void	postRenderList() Called after rendering the list

Methods inherited from class com.communote.server.web.fe.widgets.AbstractPagedListWidget

getDefaultPagingMessageKeySuffix, getPageInformation, getParameterDescriptions, getResultSpecification, getSortedResultSpecification, handleRequest, setCommonResponseMetadata, setPageInformation, setPageInformation, setPageInformation

Methods inherited from class com.communote.server.widgets.AbstractWidget

determineOutputType, getAttribute, getBooleanParameter, getGroupName, getIntParameter, getIntParameter, getLongArrayParameter, getLongParameter, getLongParameter, getParameter, getParameter, getParameterEscaped, getParameterEscaped, getParameters, getRequest, getResponse, getResponseMetadata, getStringArrayParameter, getViewIdentifier, getWidgetId, isSuccess, setAttribute, setGroupName, setParameter, setRequest, setResponse, setResponseMetadata, setSuccess

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.communote.server.widgets.Widget

getAttribute, getGroupName, getParameter, getParameters, getResponseMetadata, getViewIdentifier, getWidgetId, isSuccess, setGroupName, setParameter, setRequest, setResponse

Constructor Detail

ChronologicalPostListWidget

public ChronologicalPostListWidget()

Method Detail

getSuppliedParameters

public static String[] getSuppliedParameters()

Get the parameter names, which are necessary to save or retrieve the corresponding newsfeeds.

Returns:

Array with all required parameter names

configureQueryInstance

protected NoteQueryParameters configureQueryInstance(NoteQuery definition)

Parameters:

definition - the definition to use

Returns:

the configured tagging instance

getBlogPropertyAsBoolean

public Boolean getBlogPropertyAsBoolean(Long blogId,
                                        String keyGroup,
                                        String key)

Get an boolean blog property.

Parameters:

blogId - the id of the blog to get the property of

keyGroup - the key group of the property to get

key - the key of the property

Returns:

the boolean property or null if the property does not exists

getClassName

public String getClassName()

getCurrentUserLocale

public Locale getCurrentUserLocale()

Returns:

the userLocale

getDiscussionNotes

public PageableList<NoteData> getDiscussionNotes(long discussionId,
                                                 boolean listViewMode,
                                                 Locale locale)

Helper which fetches the notes of a discussion and returns them a style dependent of the selected view.

Parameters:

discussionId - If of the discussion.

locale - of the current user

Returns:

the found notes

getDiscussionTitle

public String getDiscussionTitle(NoteData note,
                                 Locale locale)

Get the discussion title for the note (e.g. "Max Mustermann (max) um 18:08). If no parent note is set then empty string is returned.

Parameters:

note - the note

locale - the locale

Returns:

the discussion title

getNoteActions

public String getNoteActions(NoteData note)

Return a CSV listing the actions that can be executed on a note.

Parameters:

note - the note

Returns:

a string containing the supported actions of a note separated by comma

getNoteItemTemplate

public String getNoteItemTemplate(NoteData data)

Return the location of a template to use for rendering the HTML of the provided note

Parameters:

data - the note details

Returns:

the template location

getNoteMetaData

public String getNoteMetaData(NoteData note)

Create a JSON object containing some meta data about a note.

Parameters:

note - the note

Returns:

the serialized JSON

getNoteTitle

public String getNoteTitle(NoteData note,
                           Locale locale)

Get the note title for the note (e.g. "Max Mustermann (max) um 18:08)

Parameters:

note - the note

locale - the locale

Returns:

title for the note

getParentPostFilter

public long getParentPostFilter()

Returns:

The parent post id as long.

getQueryParameters

public NoteQueryParameters getQueryParameters()

Returns:

the query parameters used for this widget

getRssFeedLink

public String getRssFeedLink()

getRssParameters

public String getRssParameters()

Get the Parameters relevant for the rss or news feed.

Specified by:

getRssParameters in interface RssSupportWidget

Returns:

String with the relevant parameters without starting & or ?

getTile

public String getTile(String outputType)

Get the tile to be used for rendering

Specified by:

getTile in interface Widget

Parameters:

outputType - the output type (rss, dhtml ...) without any '.'

Returns:

The tile to show

getTimeZone

public TimeZone getTimeZone()

Gets the effective time zone for the user

Returns:

the time zone of the current user

getTimeZoneId

public String getTimeZoneId()

Gets the effective time zone id for the user

Returns:

effective time zone id of current user

handleQueryList

protected PageableList<NoteData> handleQueryList()

hook that actually requests the list on the api

Specified by:

handleQueryList in class AbstractPagedListWidget<NoteData>

Returns:

list of items

initParameters

protected void initParameters()

init the widget parameters to these values: filter = '' offset = 0 maxCount = 30

Overrides:

initParameters in class AbstractPagedListWidget<NoteData>

postRenderList

public void postRenderList()

Called after rendering the list