biweekly.property

Class Attendee

java.lang.Object

biweekly.property.ICalProperty

biweekly.property.ValuedProperty<String>

biweekly.property.TextProperty

biweekly.property.Attendee

public class Attendee
extends TextProperty

Defines an attendee (such as a person attending an event). This property has different meanings depending on the component that it belongs to:

• VAlarm (with "EMAIL" action) - An email address that is to receive the alarm.
• All others - An attendee of the event.

Code sample:

 VEvent event = new VEvent();
 
 Attendee attendee = Attendee.email("johndoe@example.com")
 attendee.setCommonName("John Doe");
 attendee.setRsvp(true);
 attendee.setRole(Role.CHAIR);
 attendee.setParticipationStatus(ParticipationStatus.ACCEPTED);
 event.addAttendee(attendee);
 

Author:

Michael Angstadt

See Also:

RFC 5545 p.107-9

Field Summary

Fields inherited from class biweekly.property.ValuedProperty

value

Fields inherited from class biweekly.property.ICalProperty

parameters

Constructor Summary

Constructors

Constructor and Description
Attendee(String uri) Creates an attendee property.

Method Summary

Methods

Modifier and Type	Method and Description
void	addDelegatedFrom(String uri) Adds a person who has delegated his or her responsibility to the attendee.
void	addDelegatedTo(String uri) Adds a person to which the attendee has delegated his or her responsibility.
void	addMember(String uri) Adds a group that the attendee is a member of.
static Attendee	email(String email) Creates an attendee property using an email address as its value.
CalendarUserType	getCalendarUserType() Gets the type of user the attendee is (for example, an "individual" or a "room").
String	getCommonName() Gets the display name of the person.
List<String>	getDelegatedFrom() Gets the people who have delegated their responsibility to the attendee.
List<String>	getDelegatedTo() Gets the people to which the attendee has delegated his or her responsibility.
String	getDirectoryEntry() Gets a URI that contains additional information about the person.
String	getLanguage() Gets the language that the common name parameter is written in.
List<String>	getMembers() Gets the groups that the attendee is a member of.
ParticipationStatus	getParticipationStatus() Gets the attendee's level of participation.
Role	getRole() Gets the attendee's role (for example, "chair" or "required participant").
Boolean	getRsvp() Gets whether the organizer requests a response from the attendee.
String	getSentBy() Gets a person that is acting on behalf of the person defined in the property.
void	setCalendarUserType(CalendarUserType cutype) Sets the type of user the attendee is (for example, an "individual" or a "room").
void	setCommonName(String commonName) Sets the display name of the person.
void	setDirectoryEntry(String uri) Sets a URI that contains additional information about the person.
void	setLanguage(String language) Sets the language that the common name parameter is written in.
void	setParticipationStatus(ParticipationStatus status) Sets the attendee's level of participation.
void	setRole(Role role) Sets the attendee's role (for example, "chair" or "required participant").
void	setRsvp(Boolean rsvp) Sets whether the organizer requests a response from the attendee.
void	setSentBy(String uri) Sets a person that is acting on behalf of the person defined in the property.

Methods inherited from class biweekly.property.ValuedProperty

getValue, setValue, validate

Methods inherited from class biweekly.property.ICalProperty

addParameter, getParameter, getParameters, getParameters, removeParameter, setParameter, setParameter, setParameters, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Attendee

public Attendee(String uri)

Creates an attendee property.

Parameters:

uri - a URI representing the attendee (typically, an email address, e.g. "mailto:johndoe@example.com")

Method Detail

email

public static Attendee email(String email)

Creates an attendee property using an email address as its value.

Parameters:

email - the email address (e.g. "johndoe@example.com")

Returns:

the property

getCalendarUserType

public CalendarUserType getCalendarUserType()

Gets the type of user the attendee is (for example, an "individual" or a "room").

Returns:

the calendar user type or null if not set

See Also:

RFC 5545 p.16

setCalendarUserType

public void setCalendarUserType(CalendarUserType cutype)

Sets the type of user the attendee is (for example, an "individual" or a "room").

Parameters:

cutype - the calendar user type or null to remove

See Also:

RFC 5545 p.16

getMembers

public List<String> getMembers()

Gets the groups that the attendee is a member of.

Returns:

the group URIs (typically, these are email address URIs, e.g. "mailto:mailinglist@example.com")

See Also:

RFC 5545 p.21-2

addMember

public void addMember(String uri)

Adds a group that the attendee is a member of.

Parameters:

uri - the group URI (typically, an email address URI, e.g. "mailto:mailinglist@example.com")

See Also:

RFC 5545 p.21-2

getRole

public Role getRole()

Gets the attendee's role (for example, "chair" or "required participant").

Returns:

the role or null if not set

See Also:

RFC 5545 p.25-6

setRole

public void setRole(Role role)

Sets the attendee's role (for example, "chair" or "required participant").

Parameters:

role - the role or null to remove

See Also:

RFC 5545 p.25-6

getParticipationStatus

public ParticipationStatus getParticipationStatus()

Gets the attendee's level of participation.

Returns:

the participation status or null if not set

See Also:

RFC 5545 p.22-3

setParticipationStatus

public void setParticipationStatus(ParticipationStatus status)

Sets the attendee's level of participation.

Parameters:

status - the participation status or null to remove

See Also:

RFC 5545 p.22-3

getRsvp

public Boolean getRsvp()

Gets whether the organizer requests a response from the attendee.

Returns:

true if an RSVP is requested, false if not, null if not set

See Also:

RFC 5545 p.26-7

setRsvp

public void setRsvp(Boolean rsvp)

Sets whether the organizer requests a response from the attendee.

Parameters:

rsvp - true if an RSVP has been requested, false if not, null to remove

See Also:

RFC 5545 p.26-7

getDelegatedFrom

public List<String> getDelegatedFrom()

Gets the people who have delegated their responsibility to the attendee.

Returns:

the delegators (typically email URIs, e.g. "mailto:janedoe@example.com")

See Also:

RFC 5545 p.17

addDelegatedFrom

public void addDelegatedFrom(String uri)

Adds a person who has delegated his or her responsibility to the attendee.

Parameters:

uri - the delegator (typically an email URI, e.g. "mailto:janedoe@example.com")

See Also:

RFC 5545 p.17

getDelegatedTo

public List<String> getDelegatedTo()

Gets the people to which the attendee has delegated his or her responsibility.

Returns:

the delegatees (typically email URIs, e.g. "mailto:janedoe@example.com")

See Also:

RFC 5545 p.17-8

addDelegatedTo

public void addDelegatedTo(String uri)

Adds a person to which the attendee has delegated his or her responsibility.

Parameters:

uri - the delegatee (typically an email URI, e.g. "mailto:janedoe@example.com")

See Also:

RFC 5545 p.17-8

getSentBy

public String getSentBy()

Description copied from class: ICalProperty

Gets a person that is acting on behalf of the person defined in the property.

Returns:

a URI representing the person (typically, an email URI, e.g. "mailto:janedoe@example.com") or null if not set

See Also:

RFC 5545 p.27

setSentBy

public void setSentBy(String uri)

Description copied from class: ICalProperty

Sets a person that is acting on behalf of the person defined in the property.

Parameters:

uri - a URI representing the person (typically, an email URI, e.g. "mailto:janedoe@example.com") or null to remove

See Also:

RFC 5545 p.27

getCommonName

public String getCommonName()

Description copied from class: ICalProperty

Gets the display name of the person.

Returns:

the display name (e.g. "John Doe") or null if not set

See Also:

RFC 5545 p.15-6

setCommonName

public void setCommonName(String commonName)

Description copied from class: ICalProperty

Sets the display name of the person.

Parameters:

commonName - the display name (e.g. "John Doe") or null to remove

See Also:

RFC 5545 p.15-6

getDirectoryEntry

public String getDirectoryEntry()

Description copied from class: ICalProperty

Gets a URI that contains additional information about the person.

Returns:

the URI (e.g. an LDAP URI) or null if not set

See Also:

RFC 5545 p.18

setDirectoryEntry

public void setDirectoryEntry(String uri)

Description copied from class: ICalProperty

Sets a URI that contains additional information about the person.

Parameters:

uri - the URI (e.g. an LDAP URI) or null to remove

See Also:

RFC 5545 p.18

getLanguage

public String getLanguage()

Gets the language that the common name parameter is written in.

Returns:

the language (e.g. "en" for English) or null if not set

See Also:

RFC 5545 p.21

setLanguage

public void setLanguage(String language)

Sets the language that the common name parameter is written in.

Parameters:

language - the language (e.g. "en" for English) or null to remove

See Also:

RFC 5545 p.21