Component name: PARTICIPANT
Purpose: This component provides information about a participant in
an event or task.
Conformance: This component can be specified multiple times in a
"VEVENT", "VTODO", "VJOURNAL" or "VFREEBUSY" calendar component.
Description: This component provides information about a participant
in a calendar component. A participant may be an attendee in a
scheduling sense and the ATTENDEE property may be specified in
addition. Participants can be individuals or organizations, for
example a soccer team, the spectators or the musicians.
STRUCTURED-DATA properties if present may refer to definitions of
the participant - such as a vCard.
The CALENDAR-ADDRESS property if present will provide a cal-
address. If an ATTENDEE property has the same value the
participant is considered schedulable. The PARTICIPANT component
can be used to contain additional meta-data related to the
attendee.
Format Definition:
This property is defined by the following notation:
participantc = "BEGIN" ":" "PARTICIPANT" CRLF
( partprop / locationc / resourcec )
"END" ":" "PARTICIPANT" CRLF
partprop = ; the elements herein may appear in any order,
; and the order is not significant.
uid
participanttype
(calendaraddress)
(created)
(description)
(dtstamp)
(geo)
(last-mod)
(priority)
(seq)
(status)
(summary)
(url)
attach
categories
comment
contact
location
rstatus
related
resources
strucloc
strucres
styleddescription
sdataprop
iana-prop
Note: When the PRIORITY is supplied it defines the ordering of
PARTICIPANT components with the same value for the TYPE parameter.
| Modifier and Type | Class and Description |
|---|---|
| public static class |
| Modifier and Type | Field and Description |
|---|---|
| private static final long | |
| private final Validator |
| Access | Constructor and Description |
|---|---|
| public | |
| public | |
| public | Participant(final PropertyList
a list of properties properties, final ComponentList<? extends Component> components)Constructor. |
| Modifier and Type | Method and Description |
|---|---|
| public Participant | copy()
Overrides net. Implements net. Create a (deep) copy of this component. |
| public final Optional | Returns: the CALENDAR_ADDRESS property or null if not specifiedReturns the optional calendar address property. |
| public ComponentList | Returns: Returns the underlying component list.Implements net.
|
| public final Optional | Returns: the optional date-stamp property
Deprecated
use
ChangeManagementPropertyAccessor#getDateTimeStamp()
|
| public final Optional | Returns: the DESCRIPTION property or null if not specifiedReturns the optional description property. |
| public Optional | Returns: the PARTICIPANT-TYPE property or null if not specifiedReturns the mandatory PARTICIPANT-TYPE property. |
| public final Optional | |
| public final Optional | |
| public final Optional | Returns: the SUMMARY property or null if not specifiedReturns the optional summary property. |
| public final Optional | |
| protected ComponentFactory | newFactory()
Implements abstract net. Returns a new component factory used to create deep copies. |
| public void | setComponentList(ComponentList<Component> components)
Implements net.
|
| public ValidationResult | validate(final boolean
indicates whether to validate the component's properties recurse)Implements abstract net. Perform validation on a component. |
| serialVersionUID | back to summary |
|---|---|
| private static final long serialVersionUID | |
| validator | back to summary |
|---|---|
| private final Validator<Participant> validator | |
| Participant | back to summary |
|---|---|
| public Participant() Default constructor. | |
| Participant | back to summary |
|---|---|
| public Participant(final PropertyList properties) Constructor.
| |
| Participant | back to summary |
|---|---|
| public Participant(final PropertyList properties, final ComponentList<? extends Component> components) Constructor.
| |
| copy | back to summary |
|---|---|
| public Participant copy() Overrides net. Implements net. Doc from net. Create a (deep) copy of this component.
| |
| getCalendarAddress | back to summary |
|---|---|
| public final Optional Returns the optional calendar address property.
| |
| getComponentList | back to summary |
|---|---|
| public ComponentList Implements net.
| |
| getDateStamp | back to summary |
|---|---|
| public final Optional Deprecated | |
| getDescription | back to summary |
|---|---|
| public final Optional Returns the optional description property.
| |
| getParticipantType | back to summary |
|---|---|
| public Optional Returns the mandatory PARTICIPANT-TYPE property.
| |
| getPriority | back to summary |
|---|---|
| public final Optional | |
| getStatus | back to summary |
|---|---|
| public final Optional | |
| getSummary | back to summary |
|---|---|
| public final Optional Returns the optional summary property. | |
| getUrl | back to summary |
|---|---|
| public final Optional | |
| newFactory | back to summary |
|---|---|
| protected ComponentFactory Implements abstract net. Doc from net. Returns a new component factory used to create deep copies.
| |
| setComponentList | back to summary |
|---|---|
| public void setComponentList(ComponentList<Component> components) Implements net.
| |
| validate | back to summary |
|---|---|
| public ValidationResult validate(final boolean recurse) throws ValidationException Implements abstract net. Doc from net. Perform validation on a component.
| |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public Participant | |
| public Participant | createComponent(PropertyList properties)
Implements net.
|
| public Participant | createComponent(final PropertyList properties, final ComponentList<?> subComponents)
Overrides default net.
|
| Factory | back to summary |
|---|---|
| public Factory() | |
| createComponent | back to summary |
|---|---|
| public Participant createComponent() Implements net.
| |
| createComponent | back to summary |
|---|---|
| public Participant createComponent(PropertyList properties) Implements net.
| |
| createComponent | back to summary |
|---|---|
| public Participant createComponent(final PropertyList properties, final ComponentList<?> subComponents) Overrides default net.
| |