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

Interface CalendarEvent

All Superinterfaces:

SocialComponent

public interface CalendarEvent
extends SocialComponent

The Interface CalendarEvent.

Field Summary

Fields

Modifier and Type	Field and Description
static String	NODE_TYPE The node type.

Method Summary

Methods

Modifier and Type	Method and Description
CalendarConfiguration	createConfiguration(Resource eventResource, Resource calendarResouce) Creates the configuration.
String	getCalendarId() Get this Event parent id.
CalendarConfiguration	getConfiguration() Get the configuration for this comment
Calendar	getEnd() Returns the end date of the event.
boolean	getIsMultiday() Checks if the event is multiday event.
String	getMessage() Gets the description.
Calendar	getStart() Returns the start date of the event.
String	getSubject() Gets the subject.
List<Comment.Tag>	getTags() Gets the tags.
String	getUid() Returns the icalendar UID, which is a globally unique identifier for events.
boolean	isDate() Returns if this event is an all-day event.
boolean	isRecurrence() Returns whether this event is the recurring instance of an event with recurring rule(s).
boolean	isRecurringSeries() Returns if this event is part of a recurring series.

Methods inherited from interface com.adobe.cq.social.commons.client.api.SocialComponent

getAsMap, getId, getProperties, getResource, getResourceType, getUrl, toJSONString

Field Detail

NODE_TYPE

static final String NODE_TYPE

The node type.

See Also:

Constant Field Values

Method Detail

getUid

String getUid()

Returns the icalendar UID, which is a globally unique identifier for events.

Returns:

the uid

getSubject

String getSubject()

Gets the subject.

Returns:

the subject

getMessage

String getMessage()

Gets the description.

Returns:

the description

getStart

Calendar getStart()

Returns the start date of the event. If it is an all-day event, isDate() will return true and the time part can be ignored.

Returns:

the start

getEnd

Calendar getEnd()

Returns the end date of the event. If it is an all-day event, isDate() will return true and the time part can be ignored.

Returns:

the end

isDate

boolean isDate()

Returns if this event is an all-day event.

Returns:

true, if is date

isRecurringSeries

boolean isRecurringSeries()

Returns if this event is part of a recurring series. This will return true if this is the original event that defines a recurrence or if it is a recurring event instance.

Returns:

true if this event is part of a recurring series

See Also:

#CalendarRecurrenceEvent.isRecurrence(), #CalendarRecurrenceEvent.getOriginal()

isRecurrence

boolean isRecurrence()

Returns whether this event is the recurring instance of an event with recurring rule(s). To get the original event, use #getOriginal(). Note that for the original event, which is also part of the recurring event series, this will return false. To find out if an event is part of a recurring series, use

Returns:

true if this is a recurrence, false if this is the original event isRecurringSeries().

Recurring events are copied into the JCR for each instance to allow for simpler display and search, without the need to dynamically re-calculate the recurrence on each read access.

See Also:

isRecurringSeries(), #getOriginal()

getIsMultiday

boolean getIsMultiday()

Checks if the event is multiday event.

Returns:

true, if is multiday

getTags

List<Comment.Tag> getTags()

Gets the tags.

Returns:

the tags

getConfiguration

CalendarConfiguration getConfiguration()

Get the configuration for this comment

Returns:

the configuration

createConfiguration

CalendarConfiguration createConfiguration(Resource eventResource,
                                        Resource calendarResouce)

Creates the configuration.

Parameters:

eventResource - the event resource

calendarResouce - the calendar resouce

Returns:

the calendar configuration

getCalendarId

String getCalendarId()

Get this Event parent id.

Returns:

this Event parent id.