org.alfresco.repo.web.scripts.calendar

Class AbstractCalendarListingWebScript

java.lang.Object

org.springframework.extensions.webscripts.AbstractWebScript

org.springframework.extensions.webscripts.DeclarativeWebScript

org.alfresco.repo.web.scripts.calendar.AbstractCalendarWebScript

org.alfresco.repo.web.scripts.calendar.AbstractCalendarListingWebScript

All Implemented Interfaces:

org.springframework.extensions.webscripts.WebScript

Direct Known Subclasses:

CalendarEntriesListGet, UserCalendarEntriesGet

public abstract class AbstractCalendarListingWebScript
extends AbstractCalendarWebScript

This class provides functionality common across the webscripts which list events.

Since:

4.0

Author:

Nick Burch

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.extensions.webscripts.AbstractWebScript

org.springframework.extensions.webscripts.AbstractWebScript.ScriptDetails

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	RESULT_END
protected static String	RESULT_EVENT
protected static String	RESULT_NAME
protected static String	RESULT_START
protected static String	RESULT_TITLE

Fields inherited from class org.alfresco.repo.web.scripts.calendar.AbstractCalendarWebScript

activityService, CALENDAR_SERVICE_ACTIVITY_APP_NAME, calendarService, MAX_QUERY_ENTRY_COUNT, MSG_EVENT_NOT_FOUND, MSG_INVALID_JSON, nodeService, PARAM_END_AT, PARAM_ISO8601, PARAM_START_AT, PARAM_TIMEZONE, siteService

Constructor Summary

Constructors

Constructor and Description
AbstractCalendarListingWebScript()

Method Summary

Modifier and Type	Method and Description
protected static Comparator<Map<String,Object>>	getEventDetailsSorter() Returns a Comparator for (re-)sorting events, typically used after expanding out recurring instances.
protected boolean	handleRecurring(CalendarEntry entry, Map<String,Object> entryResult, List<Map<String,Object>> allResults, Date from, Date until, boolean repeatingFirstOnly) Do what's needed for recurring events.

Methods inherited from class org.alfresco.repo.web.scripts.calendar.AbstractCalendarWebScript

addActivityEntry, buildError, buildPagingRequest, createIgnoreEvent, executeImpl, executeImpl, extractDates, getOrNull, parseDate, removeTimeZoneIfRequired, removeTimeZoneIfRequired, setActivityService, setCalendarService, setNodeService, setSiteService, useJSONErrors

Methods inherited from class org.springframework.extensions.webscripts.DeclarativeWebScript

execute, executeFinallyImpl, executeImpl, executeImpl, getTemplateModel, renderFormatTemplate

Methods inherited from class org.springframework.extensions.webscripts.AbstractWebScript

addModuleBundleToCache, checkModuleBundleCache, createArgs, createArgsM, createHeaders, createHeadersM, createScriptParameters, createStatusException, createTemplateParameters, executeScript, getContainer, getDescription, getExecuteScript, getResources, getStatusTemplate, init, renderString, renderString, renderTemplate, sendStatus, setURLModelFactory, toString

Methods inherited from class java.lang.Object

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

Field Detail

RESULT_EVENT

protected static final String RESULT_EVENT

See Also:

Constant Field Values

RESULT_NAME

protected static final String RESULT_NAME

See Also:

Constant Field Values

RESULT_TITLE

protected static final String RESULT_TITLE

See Also:

Constant Field Values

RESULT_START

protected static final String RESULT_START

See Also:

Constant Field Values

RESULT_END

protected static final String RESULT_END

See Also:

Constant Field Values

Constructor Detail

AbstractCalendarListingWebScript

public AbstractCalendarListingWebScript()

Method Detail

getEventDetailsSorter

protected static Comparator<Map<String,Object>> getEventDetailsSorter()

Returns a Comparator for (re-)sorting events, typically used after expanding out recurring instances.

handleRecurring

protected boolean handleRecurring(CalendarEntry entry,
                                  Map<String,Object> entryResult,
                                  List<Map<String,Object>> allResults,
                                  Date from,
                                  Date until,
                                  boolean repeatingFirstOnly)

Do what's needed for recurring events.

Returns:

If dates have been tweaked, and a sort may be required