er.calendar
Interface ERCalendarEvent

All Known Implementing Classes:

ERSimpleEvent

public interface ERCalendarEvent

ERCalendarEvent is an interface for events used by the ERPublishCalendarPage component.

ERPublishCalendarPage can use objects of any class that implements this interface. Existing classes (for example EOCustomObject subclasses), that correspond to calendar events, can easily be modified to implement this interface and thus be added directly to ERPublishCalendarPage. If existing classes does not directly correspond to calendar events, create events from business data (or some algorithm) using either the included ERSimpleEvent class, a subclass of ERSimpleEvent, or any other class implementing this interface.

Version:

1.0, 2002-09-30

Author:

Johan Carlberg

Method Summary

NSTimestamp	endTime()
int	repeatCount()
int	repeatDayOfWeek()
int	repeatDayOfWeekInMonth()
NSArray	repeatDaysOfMonth()
int	repeatFrequency()
int	sequence()
NSTimestamp	startTime()
String	status()
String	summary()
String	uniqueId()
boolean	wholeDay()

Method Detail

wholeDay

public boolean wholeDay()

Returns:

false if this event have specified start and ending times. true if this event is a whole-day event without a specific starting and ending hour and minute.

See Also:

ERSimpleEvent.wholeDay

startTime

public NSTimestamp startTime()

Returns:

the start time of this event. For whole-day events, the time part of the NSTimestamp is ignored.

See Also:

endTime()

endTime

public NSTimestamp endTime()

Returns:

the end time of this event. For whole-day events, this should be a time on the day following the last day of this event (the time part of the NSTimestamp is ignored, and the iCalendar standard requires that the end time of an event is later than the start time.

See Also:

startTime()

sequence

public int sequence()

Returns:

the change counter of this event. The sequence of a calendar event is supposed to increase every time any information in the event is modified, so that updates to events can be ordered.

See Also:

ERSimpleEvent.sequence()

status

public String status()

Returns:

status of this event. Values defined by the iCalendar standard are: "TENTATIVE", "CONFIRMED", "CANCELLED". Return null if event status is unspecified.

summary

public String summary()

Returns:

summary or textual description of this event.

uniqueId

public String uniqueId()

Returns:

a persistent, globally unique identifier for this event. The unique identifier must be a globally unique identifier. The generator of the identifier must guarantee that the identifier is unique. There are several algorithms that can be used to accomplish this. The identifier is recommended to be the identical syntax to the RFC 822 addr-spec. A good method to assure uniqueness is to put the domain name or a domain literal IP address of the host on which the identifier was created on the right hand side of the "@", and on the left hand side, put a combination of the current calendar date and time of day (that is, formatted in as a date-time value) along with some other currently unique (perhaps sequential) identifier available on the system (for example, a process id number). Using a date/time value on the left hand side and a domain name or domain literal on the right hand side makes it possible to guarantee uniqueness since no two hosts should be using the same domain name or IP address at the same time. Though other algorithms will work, it is recommended that the right hand side contain some domain identifier (either of the host itself or otherwise) such that the generator of the message identifier can guarantee the uniqueness of the left hand side within the scope of that domain.

See Also:

ERSimpleEvent.sequence()

repeatFrequency

public int repeatFrequency()

Returns:

the frequency of a repeating event, or 0 for a one time event. Can be specified as one of the java.util.Calendar field numbers YEAR, MONTH, WEEK_OF_YEAR, DAY_OF_MONTH, HOUR_OF_DAY, MINUTE or SECOND.

See Also:

repeatCount()

repeatCount

public int repeatCount()

Returns:

the number of occurences of a repeating event. Ignored if repeatFrequency() returns 0.

See Also:

repeatFrequency()

repeatDayOfWeek

public int repeatDayOfWeek()

Returns:

the day of week of a repeating event, or 0 for unspecified day of week. Can be specified as one of the java.util.Calendar DAY_OF_WEEK field values SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY or as the value 0. Ignored if repeatFrequency() returns 0.

See Also:

repeatFrequency()

repeatDayOfWeekInMonth

public int repeatDayOfWeekInMonth()

Returns:

the ordinal number of day of the week within a month at which the event repeats. Together with repeatDayOfWeek() it uniquely specifies a day within the month. Ignored if repeatFrequency() returns 0.

See Also:

repeatDayOfWeek()

repeatDaysOfMonth

public NSArray repeatDaysOfMonth()

Returns:

an array of Integer indicating the days within a month, at which the event repeats, or null for not restricting repeating to certain days. Together with repeatDayOfWeek() it uniquely specifies a day within the month (Keep in mind that iCal 1.0 does not properly handle this). Ignored if repeatFrequency() returns 0.

See Also:

repeatDayOfWeek()