Class VFreeBusy

java.lang.Object
jfxtras.icalendarfx.VElementBase
jfxtras.icalendarfx.VParentBase<VFreeBusy>
jfxtras.icalendarfx.components.VComponentBase<VFreeBusy>
jfxtras.icalendarfx.components.VCommon<VFreeBusy>
jfxtras.icalendarfx.components.VPrimary<VFreeBusy>
jfxtras.icalendarfx.components.VPersonal<VFreeBusy>
jfxtras.icalendarfx.components.VFreeBusy
All Implemented Interfaces:
VAttendee<VFreeBusy>, VComponent, VDateTimeEnd<VFreeBusy>, VChild, VElement, VParent
public class VFreeBusy extends VPersonal<VFreeBusy> implements VDateTimeEnd<VFreeBusy>
VFREEBUSY Free/Busy Component RFC 5545 iCalendar 3.6.4. page 59 A "VFREEBUSY" calendar component is a grouping of component properties that represents either a request for free or busy time information, a reply to a request for free or busy time information, or a published set of busy time information. When used to request free/busy time information, the "ATTENDEE" property specifies the calendar users whose free/busy time is being requested; the "ORGANIZER" property specifies the calendar user who is requesting the free/busy time; the "DTSTART" and "DTEND" properties specify the window of time for which the free/ busy time is being requested; the "UID" and "DTSTAMP" properties are specified to assist in proper sequencing of multiple free/busy time requests. When used to reply to a request for free/busy time, the "ATTENDEE" property specifies the calendar user responding to the free/busy time request; the "ORGANIZER" property specifies the calendar user that originally requested the free/busy time; the "FREEBUSY" property specifies the free/busy time information (if it exists); and the "UID" and "DTSTAMP" properties are specified to assist in proper sequencing of multiple free/busy time replies. When used to publish busy time, the "ORGANIZER" property specifies the calendar user associated with the published busy time; the "DTSTART" and "DTEND" properties specify an inclusive time window that surrounds the busy time information; the "FREEBUSY" property specifies the published busy time information; and the "DTSTAMP" property specifies the DATE-TIME that iCalendar object was created. The "VFREEBUSY" calendar component cannot be nested within another calendar component. Multiple "VFREEBUSY" calendar components can be specified within an iCalendar object. This permits the grouping of free/busy information into logical collections, such as monthly groups of busy time information. The "VFREEBUSY" calendar component is intended for use in iCalendar object methods involving requests for free time, requests for busy time, requests for both free and busy, and the associated replies. Free/Busy information is represented with the "FREEBUSY" property. This property provides a terse representation of time periods. One or more "FREEBUSY" properties can be specified in the "VFREEBUSY" calendar component. When present in a "VFREEBUSY" calendar component, the "DTSTART" and "DTEND" properties SHOULD be specified prior to any "FREEBUSY" properties. The recurrence properties ("RRULE", "RDATE", "EXDATE") are not permitted within a "VFREEBUSY" calendar component. Any recurring events are resolved into their individual busy time periods using the "FREEBUSY" property. Example: The following is an example of a "VFREEBUSY" calendar component used to request free or busy time information: BEGIN:VFREEBUSY UID:19970901T082949Z-FA43EF@example.com ORGANIZER:mailto:jane_doe@example.com ATTENDEE:mailto:john_public@example.com DTSTART:19971015T050000Z DTEND:19971016T050000Z DTSTAMP:19970901T083000Z END:VFREEBUSY
Author:
David Bal

  • Constructor Details

    • VFreeBusy

      public VFreeBusy()

    • VFreeBusy

      public VFreeBusy(VFreeBusy source)
      Copy constructor

  • Method Details

    • getContact

      public Contact getContact()

    • setContact

      public void setContact(String contact)

    • setContact

      public void setContact(Contact contact)

    • withContact

      public VFreeBusy withContact(Contact contact)

    • withContact

      public VFreeBusy withContact(String contact)

    • getDateTimeEnd

      public DateTimeEnd getDateTimeEnd()
      DTEND Date-Time End (for local-date) RFC 5545, 3.8.2.2, page 95 This property specifies when the calendar component ends. The value type of this property MUST be the same as the "DTSTART" property, and its value MUST be later in time than the value of the "DTSTART" property. Example: DTEND;VALUE=DATE:19980704
      Specified by:
      getDateTimeEnd in interface VDateTimeEnd<VFreeBusy>

    • setDateTimeEnd

      public void setDateTimeEnd(DateTimeEnd dateTimeEnd)
      Specified by:
      setDateTimeEnd in interface VDateTimeEnd<VFreeBusy>

    • getFreeBusyTime

      public FreeBusyTime getFreeBusyTime()

    • setFreeBusyTime

      public void setFreeBusyTime(String freeBusyTime)

    • setFreeBusyTime

      public void setFreeBusyTime(List<Pair<ZonedDateTime, TemporalAmount>> freeBusyTime)

    • setFreeBusyTime

      public void setFreeBusyTime(FreeBusyTime freeBusyTime)

    • withFreeBusyTime

      public VFreeBusy withFreeBusyTime(FreeBusyTime freeBusyTime)

    • withFreeBusyTime

      public VFreeBusy withFreeBusyTime(List<Pair<ZonedDateTime, TemporalAmount>> freeBusyTime)

    • withFreeBusyTime

      public VFreeBusy withFreeBusyTime(String freeBusyTime)

    • calendarList

      public List<VFreeBusy> calendarList()
      Specified by:
      calendarList in interface VComponent

    • errors

      public List<String> errors()
      Description copied from class: VPersonal
      / if (useRequestStatus) / { // Set REQUEST-STATUS for each message / statusMessages.entrySet() / .stream() / .flatMap(e -> e.getValue().stream()) / .forEach(e -> addChild(RequestStatus.parse(e))); / }
      Specified by:
      errors in interface VElement
      Overrides:
      errors in class VPersonal<VFreeBusy>
      Returns:
      - list of error messages

    • parse

      public static VFreeBusy parse(String content)
      Creates a new VFreeBusy calendar component by parsing a String of iCalendar content lines
      Parameters:
      content - the text to parse, not null
      Returns:
      the parsed VFreeBusy