com.adobe.cq.social.calendar.client.api

Interface Calendar

All Superinterfaces:

CommentCollection<CalendarEvent,CalendarConfiguration>, Forum<CalendarEvent,CalendarConfiguration>, SocialCollectionComponent, SocialComponent

public interface Calendar
extends Forum<CalendarEvent,CalendarConfiguration>

Simply Social Calendar, a collection of CalendarEvent.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	RESOURCE_TYPE Calendar component resource type.
static java.lang.String	RESOURCE_TYPE_EVENT Calendar event resource type.
static java.lang.String	RESOURCE_TYPE_EVENT_REPLY Calendar event reply resource type.
static java.lang.String	SELECTOR_SEPARATOR Pagination and date filter selector's separator.

Fields inherited from interface com.adobe.cq.social.forum.client.api.Forum

REQ_PN_SUBJECT, RESOURCE_TYPE_POST, RESOURCE_TYPE_TOPIC, TOPIC_POSTFIX

Fields inherited from interface com.adobe.cq.social.scf.SocialComponent

CSV_SELECTOR, DEFAULT_SELECTOR, INDEX_SELECTOR, PROP_REFERER, QUERY_SELECTOR, TRANSLATE_SELECTOR

Method Summary

Modifier and Type	Method and Description
CalendarConfiguration	createConfiguration(Resource eventResource, Resource calendarResouce) Creates the configuration.
DateRangeFilter	getDateRangeFilter() Get the range of date applies to this calendar instance.
java.lang.String	getDefaultDateRangeFilterEnd() Get the default date range filter end date.
java.lang.String	getDefaultDateRangeFilterStart() Get the default date range filter start date.
java.lang.String	getLocaleDateFormat()
java.lang.String	getLocaleLongDateFormat()
java.lang.String	getLocaleTimeFormat()
java.lang.String	getName() Returns the title of this calendar.
java.lang.String	getPath() Returns the resource path of this calendar.
void	setDateRangeFilter(DateRangeFilter dateFilter) Set the date range filter.

Methods inherited from interface com.adobe.cq.social.forum.client.api.Forum

getTitle, isClosed

Methods inherited from interface com.adobe.cq.social.commons.comments.api.CommentCollection

getConfiguration, getCreated, getLastModified, getMayPost, getPageInfo, isTaggingAllowed

Methods inherited from interface com.adobe.cq.social.scf.SocialCollectionComponent

getItems, getTotalSize, setPagination, setSortedOrder

Methods inherited from interface com.adobe.cq.social.scf.SocialComponent

getAsMap, getFriendlyUrl, getId, getParentComponent, getProperties, getProperty, getProperty, getResource, getResourceType, getSourceComponent, getUrl, toJSONString

Field Detail

RESOURCE_TYPE

static final java.lang.String RESOURCE_TYPE

Calendar component resource type.

See Also:

Constant Field Values

RESOURCE_TYPE_EVENT

static final java.lang.String RESOURCE_TYPE_EVENT

Calendar event resource type.

See Also:

Constant Field Values

RESOURCE_TYPE_EVENT_REPLY

static final java.lang.String RESOURCE_TYPE_EVENT_REPLY

Calendar event reply resource type.

See Also:

Constant Field Values

SELECTOR_SEPARATOR

static final java.lang.String SELECTOR_SEPARATOR

Pagination and date filter selector's separator.

See Also:

Constant Field Values

Method Detail

getPath

java.lang.String getPath()

Returns the resource path of this calendar.

Returns:

- resource path of this calendar.

getName

java.lang.String getName()

Returns the title of this calendar.

Returns:

- title of this calendar.

getDateRangeFilter

DateRangeFilter getDateRangeFilter()

Get the range of date applies to this calendar instance.

Returns:

- date range filter.

setDateRangeFilter

void setDateRangeFilter(DateRangeFilter dateFilter)

Set the date range filter.

Parameters:

dateFilter - - Date Filter to set.

getDefaultDateRangeFilterStart

java.lang.String getDefaultDateRangeFilterStart()

Get the default date range filter start date.

Returns:

- date range filter start

getDefaultDateRangeFilterEnd

java.lang.String getDefaultDateRangeFilterEnd()

Get the default date range filter end date.

Returns:

- date range filter end

getLocaleDateFormat

java.lang.String getLocaleDateFormat()

getLocaleLongDateFormat

java.lang.String getLocaleLongDateFormat()

getLocaleTimeFormat

java.lang.String getLocaleTimeFormat()

createConfiguration

CalendarConfiguration createConfiguration(Resource eventResource,
                                          Resource calendarResouce)

Creates the configuration.

Parameters:

eventResource - the event resource

calendarResouce - the calendar resouce

Returns:

the calendar configuration