CalendarEvent
insteand.@Deprecated public interface Event
Event
represents a single calendar event.Modifier and Type | Method and Description |
---|---|
void |
deleteFromRecurrence(boolean save)
Deprecated.
This will remove this event from its recurring event series (if present), but only this and not the whole
series.
|
CqCalendar |
getCalendar()
Deprecated.
Returns the calendar that contains this event.
|
Calendar |
getEnd()
Deprecated.
Returns the end date of the event.
|
Event |
getOriginal()
Deprecated.
Returns the original event of a recurring event.
|
String |
getPath()
Deprecated.
Returns the resource path of this event.
|
ValueMap |
getProperties()
Deprecated.
Returns a value map of the event content.
|
Iterator<Event> |
getRecurrences()
Deprecated.
Returns all recurring instances of this event found in the repository.
|
Calendar |
getStart()
Deprecated.
Returns the start date of the event.
|
String |
getUid()
Deprecated.
Returns the icalendar UID, which is a globally unique identifier for events.
|
boolean |
isDate()
Deprecated.
Returns if this event is an all-day event.
|
boolean |
isRecurrence()
Deprecated.
Returns whether this event is the recurring instance of an event with recurring rule(s).
|
boolean |
isRecurringSeries()
Deprecated.
Returns if this event is part of a recurring series.
|
void |
takeOutOfRecurrence(boolean save)
Deprecated.
This will take this single instance out of its recurring event series and create a separate event, if it is
part of a recurrence.
|
String |
toICalendarString()
Deprecated.
Returns this event serialized as iCalendar object (RFC-2445).
|
void |
updateRecurrences(boolean save)
Deprecated.
This will update the recurring instances of this event.
|
String getPath()
String getUid()
Calendar getStart()
isDate()
will return true and the time
part can be ignored.Calendar getEnd()
isDate()
will return true and the time
part can be ignored.boolean isDate()
ValueMap getProperties()
CqCalendar getCalendar()
boolean isRecurringSeries()
true
if this is the original
event that defines a recurrence or if it is a recurring event instance
.true
if this event is part of a recurring seriesisRecurrence()
,
getOriginal()
boolean isRecurrence()
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, usetrue
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.
isRecurringSeries()
,
getOriginal()
Event getOriginal()
null
. To find out if an event is part of a recurring series, use 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.
null
)isRecurringSeries()
,
isRecurrence()
Iterator<Event> getRecurrences()
isRecurrence()
== false
.void updateRecurrences(boolean save) throws CalendarException
This only works if this event is an original (
) event, if it
actually defines a recurrence rule and if the underlying JCR session allows write access.
isRecurrence()
== false
In detail, this will remove the existing set of recurrences and create new ones. But nothing might happen if the rule did not change.
save
- if true, will automatically save the underlying jcr sessionCalendarException
- if something goes wrong when savingvoid takeOutOfRecurrence(boolean save) throws CalendarException
save
- if true, will automatically save the underlying jcr sessionCalendarException
- if something goes wrongvoid deleteFromRecurrence(boolean save) throws CalendarException
save
- if true, will automatically save the underlying jcr sessionCalendarException
- if something goes wrongString toICalendarString()
Please note that in order to put this into a file, one has to ensure the correct folding of overlong
lines, using CalendarManager.printICSFoldedString(String, java.io.PrintWriter)
.
Example:
BEGIN:VEVENT DTSTAMP:20090220T175158Z UID:CCF41603-B770-11D7-8FBE-0050E4C50C66 DTSTART;VALUE=DATE:20031016 DTEND;VALUE=DATE:20031017 SUMMARY:Kill Bill Volume 1 END:VEVENT
"Copyright © 2006 - 2015 Adobe Systems Incorporated. All Rights Reserved"