One person's invitation to, or registration for, a CalEvent, along with the participation status saying whether they have accepted. Each row links an event, referred to here as the organiser event, to either a Profile or, for someone without an account, the plain contact details held on the row itself. Only one of those is used: when attendee is set the first name, surname, email and organisation name columns stay null. Someone brought along by another attendee has guestOf pointing at the attendee who invited them. The participation status uses the iCalendar PARTSTAT values, and only rows set to ACCEPTED count towards an event's attendee total. Note that the name column is a randomly generated UUID, not a person's name.

Group: Database Entities

Implements: Serializable


Properties

PropertyReturnsDescription
acknowledgedbooleanWhether the attendee has seen this request, used to decide if it still needs to be shown as new. See getAckStatus for the display label built from this flag.
ackStatusStringA readable label for the acknowledged flag, either Acknowledged or Not acked. It is meant for display only; test isAcknowledged in code rather than comparing this string.
attendeeProfileThe profile being invited or registered. Null for an external attendee, in which case the first name, surname, email and organisation name columns on this row identify them instead.
attendeeEventCalEventThe copy of the event sitting in the attendee's own calendar, when one has been created for them. Null when the attendee has no calendar copy. Lazily loaded.
createdDateDateWhen this request was created, that is when the person was invited or registered.
firstNameStringFirst name of an external attendee. Only used when attendee is null; for a request linked to a profile the name comes from the profile instead.
guestOfProfileThe attendee who brought this person along as a guest. Null for someone who registered in their own right. Lazily loaded.
idLongThe database-assigned unique identifier for this request.
mailStringEmail address of an external attendee, and where their invitation and reminder emails are sent. Only used when attendee is null.
modifiedDateDateWhen this request was last changed, which for most requests is when the attendee last changed their participation status.
nameStringThe resource name for this request, a randomly generated UUID rather than anything to do with the person's name. It is unique across the whole system, enforced by a unique constraint, and is how the request is addressed from CalDAV and from a link. Required.
organiserEventCalEventThe event on the organiser's calendar that this request is for. Watch the spelling: this property is organiserEvent while the event's own owner property is spelled organisor. Lazily loaded.
orgNameStringName of the organisation an external attendee says they are from. This is free text captured on the registration form, not a link to an Organisation record, and is only used when attendee is null.
participationStatusStringThe attendee's iCalendar participation status: one of ACCEPTED, TENTATIVE, DECLINED or NEEDS-ACTION. New requests start at NEEDS-ACTION, and only ACCEPTED counts as actually attending, so it is the value the attendee count and the maximum attendees limit are based on.
scheduleAgentStringWhich side is responsible for sending scheduling messages for this request, normally the string SERVER or CLIENT, as defined by the CalDAV scheduling standard. May be null when it has not been set.
surNameStringSurname of an external attendee. Only used when attendee is null; for a request linked to a profile the name comes from the profile instead.

Methods

getId() · getName() · getOrganiserEvent() · getAttendeeEvent() · getAttendee() · isAcknowledged() · getParticipationStatus() · getFirstName() · getSurName() · getMail() · getOrgName() · getGuestOf() · getCreatedDate() · getModifiedDate() · getScheduleAgent() · getAckStatus()

getId()

Returns: Long

The database-assigned unique identifier for this request.

getName()

Returns: String

The resource name for this request, a randomly generated UUID rather than anything to do with the person's name. It is unique across the whole system, enforced by a unique constraint, and is how the request is addressed from CalDAV and from a link. Required.

getOrganiserEvent()

Returns: CalEvent

The event on the organiser's calendar that this request is for. Watch the spelling: this property is organiserEvent while the event's own owner property is spelled organisor. Lazily loaded.

getAttendeeEvent()

Returns: CalEvent

The copy of the event sitting in the attendee's own calendar, when one has been created for them. Null when the attendee has no calendar copy. Lazily loaded.

getAttendee()

Returns: Profile

The profile being invited or registered. Null for an external attendee, in which case the first name, surname, email and organisation name columns on this row identify them instead.

isAcknowledged()

Returns: boolean

Whether the attendee has seen this request, used to decide if it still needs to be shown as new. See getAckStatus for the display label built from this flag.

getParticipationStatus()

Returns: String

The attendee's iCalendar participation status: one of ACCEPTED, TENTATIVE, DECLINED or NEEDS-ACTION. New requests start at NEEDS-ACTION, and only ACCEPTED counts as actually attending, so it is the value the attendee count and the maximum attendees limit are based on.

getFirstName()

Returns: String

First name of an external attendee. Only used when attendee is null; for a request linked to a profile the name comes from the profile instead.

getSurName()

Returns: String

Surname of an external attendee. Only used when attendee is null; for a request linked to a profile the name comes from the profile instead.

getMail()

Returns: String

Email address of an external attendee, and where their invitation and reminder emails are sent. Only used when attendee is null.

getOrgName()

Returns: String

Name of the organisation an external attendee says they are from. This is free text captured on the registration form, not a link to an Organisation record, and is only used when attendee is null.

getGuestOf()

Returns: Profile

The attendee who brought this person along as a guest. Null for someone who registered in their own right. Lazily loaded.

getCreatedDate()

Returns: Date

When this request was created, that is when the person was invited or registered.

getModifiedDate()

Returns: Date

When this request was last changed, which for most requests is when the attendee last changed their participation status.

getScheduleAgent()

Returns: String

Which side is responsible for sending scheduling messages for this request, normally the string SERVER or CLIENT, as defined by the CalDAV scheduling standard. May be null when it has not been set.

getAckStatus()

Returns: String

A readable label for the acknowledged flag, either Acknowledged or Not acked. It is meant for display only; test isAcknowledged in code rather than comparing this string.

To get full access to the Kademi Hub existing customers can login here, or new customers can register here.