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

Interface CalendarEvent

All Superinterfaces:

Comment<CalendarConfiguration>, Post<CalendarConfiguration>, SocialCollectionComponent, SocialComponent

public interface CalendarEvent
extends Post<CalendarConfiguration>

The Interface CalendarEvent.

Nested Class Summary

Nested classes/interfaces inherited from interface com.adobe.cq.social.commons.comments.api.Comment

Comment.ModeratorActions, Comment.ModeratorStatus, Comment.Tag

Field Summary

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

LAST_SELF_MOD_BY, PN_COMPOSED_BY, PN_COMPOSED_FOR, PN_SUBJECT, POST_POSTFIX

Fields inherited from interface com.adobe.cq.social.commons.comments.api.Comment

COMMENT_RESOURCETYPE, COMMENTCOLLECTION_RESOURCETYPE, JSON_EXTENSION, NODE_TYPE, PROP_APPROVED, PROP_REFERER, PROP_SPAM, PROP_USE_REFERRER_URL, SOCO_SELECTOR

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

CSV_SELECTOR, DEFAULT_SELECTOR, INDEX_SELECTOR, QUERY_SELECTOR, TRANSLATE_SELECTOR

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCalendarId() Get this Event parent id.
java.util.Calendar	getEnd() Returns the end date of the event.
boolean	getIsMultiday() Checks if the event is multiday event.
java.lang.String	getLocaleDateFormat()
java.lang.String	getLocaleLongDateFormat()
java.lang.String	getLocaleTimeFormat()
java.util.Calendar	getStart() Returns the start date of the event.
java.lang.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.forum.client.api.Post

getForumId, getFriendlyUrl, getLastModifiedUser, getLatestPost, getPageInfo, getSubject, getViewCounts, isClosed, isForumClosed, isTopic, isTopicClosed, setLatestPost, setNumReplies

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

getAttachment, getAttachments, getAuthor, getCanDelete, getCanEdit, getCanReply, getCanTranslate, getConfiguration, getCreated, getCurrentUserFlagText, getFlagReasons, getMessage, getModeratorActions, getModeratorStatus, getParentId, getPublishDate, getReferrerUrl, getSourceComponentId, getState, getTags, getTranslationAttribution, getTranslationDescription, getTranslationDisplay, getTranslationTitle, getUseFlagReasons, getVotes, isApproved, isDraft, isFeatured, isFlaggedByUser, isPinned, isScheduled, isTopLevel, isUserModerator, isVisible

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, getId, getParentComponent, getProperties, getProperty, getProperty, getResource, getResourceType, getSourceComponent, getUrl, toJSONString

Method Detail

getUid

java.lang.String getUid()

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

Returns:

the uid

getStart

java.util.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

java.util.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

isRecurrence

boolean isRecurrence()

Returns whether this event is the recurring instance of an event with recurring rule(s). 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()

getIsMultiday

boolean getIsMultiday()

Checks if the event is multiday event.

Returns:

true, if is multiday

getCalendarId

java.lang.String getCalendarId()

Get this Event parent id.

Returns:

this Event parent id.

getLocaleDateFormat

java.lang.String getLocaleDateFormat()

getLocaleLongDateFormat

java.lang.String getLocaleLongDateFormat()

getLocaleTimeFormat

java.lang.String getLocaleTimeFormat()