ipworksssl
Class CalFreeBusy

java.lang.Object
  ipworksssl.CalFreeBusy

public class CalFreeBusy
extends java.lang.Object

Describes a single free/busy element in the calendar event.

This type describes a FREEBUSY element contained in the calendar data. Each FREEBUSY element will contain a BusyType (BUSY, FREE, BUSY-TENTATIVE, etc.) and a BusyRange , which describes the date and time range for the FREEBUSY element.

BusyRange: Contains the date/time range when the calendar owner is busy. The format for this field is either "DATETIME/DATETIME" or "DATETIME/DURATION"

The date/time format is "YYYYMMDDThhmmss", where "T" indicates the break between date and time. You may also append a 1-character alpha code for the timezone. For instance, "20100104T123456Z" indicates January 4th, 2010 at 12:34:56 PM UTC.

Durations are represented by the format P <date> T <time>. The date component may contain a number of days or weeks (but not months or years), and the time component may consist of hours, minutes, and seconds. These are represented by an integer value followed by a letter representing the units, as specified by the table below:

P

is the duration designator (historically called "period") placed at the start of the duration representation.

W

is the week designator that follows the value for the number of weeks.

D

is the day designator that follows the value for the number of days.

T

is the time designator that precedes the time components of the representation.

H

is the hour designator that follows the value for the number of hours.

M

is the minute designator that follows the value for the number of minutes.

S

is the second designator that follows the value for the number of seconds.

For example, "P4DT12H30M5S" represents a duration of four days, twelve hours, thirty minutes, and five seconds. Unused date/time designators may be left out completely. (A five-minute duration may be represented as simply "PT5M"). Also note that "PT36H" and "P1DT12H" represent the same duration.

This format is based on ISO-8601, but unlike the ISO specification this duration property does not support durations measured in years or months.

BusyType: Indicates the busy status of the corresponding BusyRange . A calendar may use custom values for the BusyType , but the standard values include:

• BUSY
• FREE
• BUSY-TENTATIVE
• BUSY-UNAVAILABLE

See Also:

Atoms, Atoms.CalFreeBusy

Constructor Summary

CalFreeBusy()

Method Summary

java.lang.String	getBusyRange()
java.lang.String	getBusyType()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CalFreeBusy

public CalFreeBusy()

Method Detail

getBusyRange

public java.lang.String getBusyRange()

getBusyType

public java.lang.String getBusyType()