Class Participant
- java.lang.Object
-
- net.fortuna.ical4j.model.Component
-
- net.fortuna.ical4j.model.component.Participant
-
- All Implemented Interfaces:
Serializable
,ComponentContainer<Component>
,PropertyContainer
public class Participant extends Component implements ComponentContainer<Component>
$Id$ [May 1 2017] Defines an iCalendar PARTICIPANT component.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.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Participant.Factory
-
Field Summary
-
Fields inherited from class net.fortuna.ical4j.model.Component
AVAILABLE, BEGIN, components, END, EXPERIMENTAL_PREFIX, PARTICIPANT, VALARM, VAVAILABILITY, VEVENT, VFREEBUSY, VJOURNAL, VLOCATION, VRESOURCE, VTIMEZONE, VTODO, VVENUE
-
-
Constructor Summary
Constructors Constructor Description Participant()
Default constructor.Participant(PropertyList<Property> properties)
Constructor.Participant(PropertyList<Property> properties, ComponentList<Component> components)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CalendarAddress
getCalendarAddress()
Returns the optional calendar address property.ComponentList<Component>
getComponents()
Created
getCreated()
DtStamp
getDateStamp()
Description
getDescription()
Returns the optional description property.LastModified
getLastModified()
ParticipantType
getParticipantType()
Returns the mandatory PARTICIPANT-TYPE property.Priority
getPriority()
Sequence
getSequence()
Status
getStatus()
Summary
getSummary()
Returns the optional summary property.Uid
getUid()
Returns the UID property of this component if available.Url
getUrl()
ValidationResult
validate(boolean recurse)
Perform validation on a component.-
Methods inherited from class net.fortuna.ical4j.model.Component
calculateRecurrenceSet, copy, equals, getName, getProperties, getRequiredProperty, hashCode, toString, validate, validateProperties
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface net.fortuna.ical4j.model.ComponentContainer
getComponent, getComponents
-
Methods inherited from interface net.fortuna.ical4j.model.PropertyContainer
getProperties, getProperty
-
-
-
-
Constructor Detail
-
Participant
public Participant()
Default constructor.
-
Participant
public Participant(PropertyList<Property> properties)
Constructor.- Parameters:
properties
- a list of properties
-
Participant
public Participant(PropertyList<Property> properties, ComponentList<Component> components)
Constructor.- Parameters:
properties
- a list of properties
-
-
Method Detail
-
validate
public final ValidationResult validate(boolean recurse) throws ValidationException
Perform validation on a component.- Specified by:
validate
in classComponent
- Parameters:
recurse
- indicates whether to validate the component's properties- Throws:
ValidationException
- where the component is not in a valid state
-
getComponents
public ComponentList<Component> getComponents()
- Specified by:
getComponents
in interfaceComponentContainer<Component>
-
getCalendarAddress
public final CalendarAddress getCalendarAddress()
Returns the optional calendar address property.- Returns:
- the CALENDAR_ADDRESS property or null if not specified
-
getCreated
public final Created getCreated()
- Returns:
- the optional creation-time property for an event
-
getDateStamp
public final DtStamp getDateStamp()
- Returns:
- the optional date-stamp property
-
getDescription
public final Description getDescription()
Returns the optional description property.- Returns:
- the DESCRIPTION property or null if not specified
-
getLastModified
public final LastModified getLastModified()
- Returns:
- the optional last-modified property for an event
-
getParticipantType
public ParticipantType getParticipantType()
Returns the mandatory PARTICIPANT-TYPE property.- Returns:
- the PARTICIPANT-TYPE property or null if not specified
-
getPriority
public final Priority getPriority()
- Returns:
- the optional priority property for an event
-
getSequence
public final Sequence getSequence()
- Returns:
- the optional sequence number property for an event
-
getStatus
public final Status getStatus()
- Returns:
- the optional status property for an event
-
getSummary
public final Summary getSummary()
Returns the optional summary property.- Returns:
- the SUMMARY property or null if not specified
-
getUid
public final Uid getUid()
Returns the UID property of this component if available.- Returns:
- a Uid instance, or null if no UID property exists
-
getUrl
public final Url getUrl()
- Returns:
- the optional URL property for an event
-
-