Package org.exoplatform.agenda.model

Record Class MailInvitationEvent

java.lang.Object
java.lang.Record
org.exoplatform.agenda.model.MailInvitationEvent
Record Components:
uid - the event's UID
method - the object's METHOD, upper-cased, null when it names none
sequence - the SEQUENCE, 0 when absent
cancelled - whether the component's STATUS is CANCELLED
organizer - the organiser's bare address, lower-cased, null when the component names none
summary - the title, plain text, may be null
description - the description, plain text, may be null
location - the location, plain text, may be null
url - the URL property as written, may be null
allDay - whether the event spans whole days
start - the start; for an all-day event, its first day at UTC midnight
end - the end; for an all-day event, its last day at UTC midnight
timeZone - the zone the event is expressed in
availability - FREE for a transparent event, BUSY for an opaque one, DEFAULT when the object says nothing
recurrence - the series' rule, null for a single event or an occurrence
occurrenceId - the occurrence an override replaces, in the event's zone; null for the master
excludedOccurrences - the occurrences the series' EXDATEs remove, in the event's zone; empty for an occurrence
overrides - the occurrences the object replaces, each with its occurrenceId; empty for an occurrence
public record MailInvitationEvent(String uid, String method, int sequence, boolean cancelled, String organizer, String summary, String description, String location, String url, boolean allDay, ZonedDateTime start, ZonedDateTime end, ZoneId timeZone, org.exoplatform.agenda.constant.EventAvailability availability, org.exoplatform.agenda.model.EventRecurrence recurrence, ZonedDateTime occurrenceId, List<ZonedDateTime> excludedOccurrences, List<MailInvitationEvent> overrides) extends Record
The event an invitation received by mail describes, as agenda reads it from the iCalendar object (EXO-90866): the master component, the occurrences its series excludes and the occurrences it overrides. Read from the sender's content, capped and narrowed to plain text; nothing in it names a person of this platform.

  • Constructor Details

    • MailInvitationEvent

      public MailInvitationEvent(String uid, String method, int sequence, boolean cancelled, String organizer, String summary, String description, String location, String url, boolean allDay, ZonedDateTime start, ZonedDateTime end, ZoneId timeZone, org.exoplatform.agenda.constant.EventAvailability availability, org.exoplatform.agenda.model.EventRecurrence recurrence, ZonedDateTime occurrenceId, List<ZonedDateTime> excludedOccurrences, List<MailInvitationEvent> overrides)
      Creates an instance of a MailInvitationEvent record class.
      Parameters:
      uid - the value for the uid record component
      method - the value for the method record component
      sequence - the value for the sequence record component
      cancelled - the value for the cancelled record component
      organizer - the value for the organizer record component
      summary - the value for the summary record component
      description - the value for the description record component
      location - the value for the location record component
      url - the value for the url record component
      allDay - the value for the allDay record component
      start - the value for the start record component
      end - the value for the end record component
      timeZone - the value for the timeZone record component
      availability - the value for the availability record component
      recurrence - the value for the recurrence record component
      occurrenceId - the value for the occurrenceId record component
      excludedOccurrences - the value for the excludedOccurrences record component
      overrides - the value for the overrides record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • uid

      public String uid()
      Returns the value of the uid record component.
      Returns:
      the value of the uid record component

    • method

      public String method()
      Returns the value of the method record component.
      Returns:
      the value of the method record component

    • sequence

      public int sequence()
      Returns the value of the sequence record component.
      Returns:
      the value of the sequence record component

    • cancelled

      public boolean cancelled()
      Returns the value of the cancelled record component.
      Returns:
      the value of the cancelled record component

    • organizer

      public String organizer()
      Returns the value of the organizer record component.
      Returns:
      the value of the organizer record component

    • summary

      public String summary()
      Returns the value of the summary record component.
      Returns:
      the value of the summary record component

    • description

      public String description()
      Returns the value of the description record component.
      Returns:
      the value of the description record component

    • location

      public String location()
      Returns the value of the location record component.
      Returns:
      the value of the location record component

    • url

      public String url()
      Returns the value of the url record component.
      Returns:
      the value of the url record component

    • allDay

      public boolean allDay()
      Returns the value of the allDay record component.
      Returns:
      the value of the allDay record component

    • start

      public ZonedDateTime start()
      Returns the value of the start record component.
      Returns:
      the value of the start record component

    • end

      public ZonedDateTime end()
      Returns the value of the end record component.
      Returns:
      the value of the end record component

    • timeZone

      public ZoneId timeZone()
      Returns the value of the timeZone record component.
      Returns:
      the value of the timeZone record component

    • availability

      public org.exoplatform.agenda.constant.EventAvailability availability()
      Returns the value of the availability record component.
      Returns:
      the value of the availability record component

    • recurrence

      public org.exoplatform.agenda.model.EventRecurrence recurrence()
      Returns the value of the recurrence record component.
      Returns:
      the value of the recurrence record component

    • occurrenceId

      public ZonedDateTime occurrenceId()
      Returns the value of the occurrenceId record component.
      Returns:
      the value of the occurrenceId record component

    • excludedOccurrences

      public List<ZonedDateTime> excludedOccurrences()
      Returns the value of the excludedOccurrences record component.
      Returns:
      the value of the excludedOccurrences record component

    • overrides

      public List<MailInvitationEvent> overrides()
      Returns the value of the overrides record component.
      Returns:
      the value of the overrides record component