Attendee (biweekly 0.4.2 API)

java.lang.Object
- biweekly.property.ICalProperty
- - biweekly.property.Attendee

```
public class Attendee
extends ICalProperty
```
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 calendar entity.
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, RFC 2445 p.102-4, vCal 1.0 p.25-7

Field Summary
- Fields inherited from class biweekly.property.ICalProperty
  parameters

Constructor Summary

Constructors
Constructor and Description

Attendee(String uri)
Creates an attendee property.

Attendee(String name, String email)
Creates an attendee property.

Constructors
Constructor and Description
`Attendee(String uri)` Creates an attendee property.
`Attendee(String name, String email)` 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.
`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`	`getEmail()` Gets the attendee's email
`String`	`getLanguage()` Gets the language that the common name is written in.
`List<String>`	`getMembers()` Gets the groups that the attendee is a member of.
`ParticipationLevel`	`getParticipationLevel()` Gets an attendee's level of participation.
`ParticipationStatus`	`getParticipationStatus()` Gets an attendee's participation status
`Role`	`getRole()` Gets an attendee's role (for example, "chair" or "attendee").
`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.
`String`	`getUri()` Gets a URI representing the attendee.
`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`	`setEmail(String email)` Sets the attendee's email
`void`	`setLanguage(String language)` Sets the language that the common name is written in.
`void`	`setParticipationLevel(ParticipationLevel level)` Sets an attendee's level of participation.
`void`	`setParticipationStatus(ParticipationStatus status)` Sets an attendee's participation status.
`void`	`setRole(Role role)` Sets an attendee's role (for example, "chair" or "attendee").
`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.
`void`	`setUri(String uri)` Sets a URI representing the attendee.
`protected void`	`validate(List<ICalComponent> components, ICalVersion version, List<Warning> warnings)` Checks the property for data consistency problems or deviations from the spec.

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 name,
        String email)
```
    Creates an attendee property.
    
    Parameters:
    name - the attendee's name (e.g. "John Doe")
    email - the attendee's email (e.g. "jdoe@example.com")
  - 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
  - getEmail
```
public String getEmail()
```
    Gets the attendee's email
    
    Returns:
    the email (e.g. "jdoe@company.com")
  - setEmail
```
public void setEmail(String email)
```
    Sets the attendee's email
    
    Parameters:
    email - the email (e.g. "jdoe@company.com")
  - getUri
```
public String getUri()
```
    Gets a URI representing the attendee.
    
    Returns:
    the URI (e.g. "mailto:jdoe@company.com")
  - setUri
```
public void setUri(String uri)
```
    Sets a URI representing the attendee.
    
    Parameters:
    uri - the URI (e.g. "mailto:jdoe@company.com")
  - getCalendarUserType
```
public CalendarUserType getCalendarUserType()
```
    Gets the type of user the attendee is (for example, an "individual" or a "room").
    
    Supported versions: 2.0
    
    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").
    
    Supported versions: 2.0
    
    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.
    
    Supported versions: 2.0
    
    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.
    
    Supported versions: 2.0
    
    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 an attendee's role (for example, "chair" or "attendee").
    
    Returns:
    the role or null if not set
    See Also:
    RFC 5545 p.25-6, vCal 1.0 p.25
  - setRole
```
public void setRole(Role role)
```
    Sets an attendee's role (for example, "chair" or "attendee").
    
    Parameters:
    role - the role or null to remove
    See Also:
    RFC 5545 p.25-6, vCal 1.0 p.25
  - getParticipationLevel
```
public ParticipationLevel getParticipationLevel()
```
    Gets an attendee's level of participation.
    
    Returns:
    the participation level or null if not set
    See Also:
    RFC 5545 p.25-6, vCal 1.0 p.26-7
  - setParticipationLevel
```
public void setParticipationLevel(ParticipationLevel level)
```
    Sets an attendee's level of participation.
    
    Parameters:
    level - the participation level or null to remove
    See Also:
    RFC 5545 p.25-6, vCal 1.0 p.26-7
  - getParticipationStatus
```
public ParticipationStatus getParticipationStatus()
```
    Gets an attendee's participation status
    
    Returns:
    the participation status or null if not set
    See Also:
    RFC 5545 p.22-3, vCal 1.0 p.25-6
  - setParticipationStatus
```
public void setParticipationStatus(ParticipationStatus status)
```
    Sets an attendee's participation status.
    
    Parameters:
    status - the participation status or null to remove
    See Also:
    RFC 5545 p.22-3, vCal 1.0 p.25-6
  - 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")
    
    Supported versions: 2.0
    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.
    
    Supported versions: 2.0
    
    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.
    
    Supported versions: 2.0
    
    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.
    
    Supported versions: 2.0
    
    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.
    
    Supported versions: 2.0
    
    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.
    
    Supported versions: 2.0
    
    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.
    
    Supported versions: 2.0
    
    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.
    
    Supported versions: 2.0
    
    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.
    
    Supported versions: 2.0
    
    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.
    
    Supported versions: 2.0
    
    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 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 is written in.
    
    Parameters:
    language - the language (e.g. "en" for English) or null to remove
    See Also:
    RFC 5545 p.21
  - validate
```
protected void validate(List<ICalComponent> components,
            ICalVersion version,
            List<Warning> warnings)
```
    Description copied from class: ICalProperty
    
    Checks the property for data consistency problems or deviations from the spec.
    
    This method should be overridden by child classes that wish to provide validation logic. The default implementation of this method does nothing.
    
    Overrides:
    
    validate in class ICalProperty
    
    Parameters:
    components - the hierarchy of components that the property belongs to
    version - the version to validate against
    warnings - the list to add the warnings to

Class Attendee

Field Summary

Fields inherited from class biweekly.property.ICalProperty

Constructor Summary

Method Summary

Methods inherited from class biweekly.property.ICalProperty

Methods inherited from class java.lang.Object

Constructor Detail

Attendee

Attendee

Method Detail

getEmail

setEmail

getUri

setUri

getCalendarUserType

setCalendarUserType

getMembers

addMember

getRole

setRole

getParticipationLevel

setParticipationLevel

getParticipationStatus

setParticipationStatus

getRsvp

setRsvp

getDelegatedFrom

addDelegatedFrom

getDelegatedTo

addDelegatedTo

getSentBy

setSentBy

getCommonName

setCommonName

getDirectoryEntry

setDirectoryEntry

getLanguage

setLanguage

validate