com.silverpeas.calendar
Class CalendarEventAttendees

java.lang.Object
  extended by com.silverpeas.calendar.CalendarEventAttendees

public class CalendarEventAttendees
extends Object

The attendees to an event scheduled in a calendar. The attendees are expected to be managed by the event itself.


Constructor Summary
protected CalendarEventAttendees()
           
 
Method Summary
 void add(String attendeeURI)
          Adds an attendee to an event scheduled in a calendar.
 void addAll(List<String> attendeeURIs)
          Adds several attendees to an event scheduled in a calendar.
 void addAll(String... attendeeURIs)
          Adds one or several attendees to an event scheduled in a calendar.
 List<String> asList()
          Converts this attendees container to a list of attendee URIs.
 boolean contains(String attendee)
          Is the specified attended is in the attendees of an event scheduled in a calendar.
 boolean isEmpty()
          Is there is no any attendees to an event?
 void remove(String... attendeeURIs)
          Removes one or several attendees from the attendees to an event scheduled in a calendar.
 void remove(String attendeeURI)
          Removes an attendee from the attendees to an event scheduled in a calendar.
 void removeAll(List<String> attendeeURIs)
          Removes several attendees from the attendees to an event scheduled in a calendar.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CalendarEventAttendees

protected CalendarEventAttendees()
Method Detail

add

public void add(String attendeeURI)
Adds an attendee to an event scheduled in a calendar. The attendee is specified by one of its URI that can be an email address. If the attendee is already added, then nothing is done.

Parameters:
attendeeURI - the URI of the attendee to add.

addAll

public void addAll(List<String> attendeeURIs)
Adds several attendees to an event scheduled in a calendar. The attendees are specified by one of their URI that can be an email address. If some of the attendees to add are already present, then they are not added.

Parameters:
attendeeURIs - the URI of the attendees to add.

addAll

public void addAll(String... attendeeURIs)
Adds one or several attendees to an event scheduled in a calendar. The attendees are specified by one of their URI that can be an email address. If some of the attendees to add are already present, then they are not added.

Parameters:
attendeeURIs - the URI of the attendees to add.

remove

public void remove(String attendeeURI)
Removes an attendee from the attendees to an event scheduled in a calendar. The attendee is specified by one of its URI that can be an email address. If the attendee isn't present, then nothing is done.

Parameters:
attendeeURI - the URI of the attendee to remove.

removeAll

public void removeAll(List<String> attendeeURIs)
Removes several attendees from the attendees to an event scheduled in a calendar. The attendees are specified by one of their URI that can be an email address. If some of the attendees to remove aren't present, then nothing is done with them.

Parameters:
attendeeURIs - the URI of the attendees to remove.

remove

public void remove(String... attendeeURIs)
Removes one or several attendees from the attendees to an event scheduled in a calendar. The attendees are specified by one of their URI that can be an email address. If some of the attendees to remove aren't present, then nothing is done with them.

Parameters:
attendeeURIs - the URI of the attendees to remove.

asList

public List<String> asList()
Converts this attendees container to a list of attendee URIs.

Returns:
a list of attendee URIs.

contains

public boolean contains(String attendee)
Is the specified attended is in the attendees of an event scheduled in a calendar.

Parameters:
attendee - an attendee URI.
Returns:
true if the specified attendee is among the attendees of an event, false otherwise.

isEmpty

public boolean isEmpty()
Is there is no any attendees to an event?

Returns:
true if no attendees are set, false otherwise.


Copyright © 2016 Silverpeas. All Rights Reserved.