Blue Mind
Release 1.0

net.bluemind.core.api.calendar
Class Attendee

java.lang.Object
  extended by net.bluemind.core.api.calendar.Attendee
All Implemented Interfaces:
java.io.Serializable

public class Attendee
extends java.lang.Object
implements java.io.Serializable

An Attendee object represents the attendance of a Entity to an Event.

It contains information about the Entity attending to the Event, but also contextual about it's participation

An Attendee only have meaning within an Event context.

Example :

Event event = new Event();
[...]
Attendee attendee = new Attendee();
attendee.setDisplayName("Blue Mind");
attendee.setEmail("bluemind@blue-mind.net");
attendee.setState(ParticipationState.NEEDSACTION);
attendee.setRequired(ParticipationRole.CHAIR);
event.addAttendee(att);

See Also:
Serialized Form

Constructor Summary
Attendee()
          Initialize the Attendee with null informations.
 
Method Summary
 boolean equals(java.lang.Object obj)
           
 java.lang.Integer getAlert()
          Get the configured reminder for the linked Event.
 CalendarInfo getCalendarInfo()
          Return the CalendarInfo for this Attendee.
 java.lang.String getDisplayName()
          Get the Attendee label to display.
 java.lang.String getEmail()
          Attendee primary email as defined in RFC 822 and subsequent RFCs.
 int getId()
          This property describe the Blue-Mind Core unique identifier for the Entity linked to this Attendee object.
 int getPercent()
          When the Attendee is linked to a Todo, this show the completion rate of the task.
 ParticipationRole getRequired()
          Get the role of the Attendee in the Event.
 ParticipationState getState()
          Get the state of the Attendee to the Event.
 java.lang.String getType()
          This property describe if the type of the Entity linked to this Attendee object.
 int hashCode()
           
 void setAlert(java.lang.Integer alert)
          Set a reminder for the linked Event.
 void setCalendarInfo(CalendarInfo calendarInfo)
          Allow you to set a CalendarInfo for this Attendee.
 void setDisplayName(java.lang.String displayName)
          Set the Attendee label to display.
 void setEmail(java.lang.String email)
          Set Attendee primary email as defined in RFC 822 and subsequent RFCs.
 void setId(int id)
          This property describe if set the Blue-Mind Core unique identifier for the Entity linked to this Attendee object.
 void setPercent(int percent)
          When the Attendee is linked to a Todo, this let you set the completion rate of the task.
 void setRequired(ParticipationRole role)
          Set the role of the Attendee in the Event.
 void setState(ParticipationState state)
          Set the state of the Attendee to the Event.
 void setType(java.lang.String type)
          This property describe if set the type of the Entity linked to this Attendee object.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Attendee

public Attendee()
Initialize the Attendee with null informations.

An Attendee created this way cannot be used directly. To be added to an event it must at least contains A way to identify the linked Entity :

See Also:
Event.getAttendees()
Method Detail

getState

public ParticipationState getState()
Get the state of the Attendee to the Event. This field is mandatory and will always be field when getting a Attendee from Blue-Mind Core.

There is no default value, but if this field is not set when sent to Blue-Mind Core, the core will assume that the current ParticipationState for this Attendee is ParticipationState.NEEDSACTION.

Returns:
The current state of attendee participation if specifically set.
See Also:
ParticipationState}.

setState

public void setState(ParticipationState state)
Set the state of the Attendee to the Event.

If this field is set to null when sent to Blue-Mind Core, the core will assume that the current ParticipationState for this Attendee is ParticipationState.NEEDSACTION.

See Also:
ParticipationState}.

getEmail

public java.lang.String getEmail()
Attendee primary email as defined in RFC 822 and subsequent RFCs.

If the getCalendarInfo() and getId() are null, this field will be used to identify the Entity linked to this Attendee.

Returns:
The primary email of the linked Entity.

setEmail

public void setEmail(java.lang.String email)
Set Attendee primary email as defined in RFC 822 and subsequent RFCs.

If the getCalendarInfo() and getId() are null, this field will be used to identify the Entity linked to this Attendee.

Parameters:
email - The primary email of the linked Entity.

getRequired

public ParticipationRole getRequired()
Get the role of the Attendee in the Event.

This field describe if the Attendee is the required participant or optional. It also can specify if the Attendee is the chair of the Event.

There is no default value, but if this field is not set when sent to Blue-Mind Core, the core will assume that the current ParticipationRole for this Attendee is ParticipationRole.REQ.

Returns:
The current role of attendee in the event if specifically set.
See Also:
ParticipationRole}.

setRequired

public void setRequired(ParticipationRole role)
Set the role of the Attendee in the Event.

This field describe if the Attendee is the required participant or optional. It also can specify if the Attendee is the chair of the Event.

If this field is set to null Blue-Mind Core, the core will assume that the current ParticipationRole for this Attendee is ParticipationRole.REQ.

Parameters:
role - The current role of attendee in the event
See Also:
ParticipationRole}.

getDisplayName

public java.lang.String getDisplayName()
Get the Attendee label to display.

For a Contact or a User this usually is the combination of the users first name, middle initial, and last name.

For a Resource this usually is the Resource.getName().

This field will not be used to identify the liked Entity, but if Blue-Mind Core failed to identify the Entity linked to this Attendee, it will use this field to fill an new Contact.

Returns:
Attendee name to display on UI.

setDisplayName

public void setDisplayName(java.lang.String displayName)
Set the Attendee label to display.

For a Contact or a User this usually is the combination of the users first name, middle initial, and last name.

For a Resource this usually is the Resource.getName().

This field will not be used to identify the liked Entity, but if Blue-Mind Core failed to identify the Entity linked to this Attendee, it will use this field to fill an new Contact.

Parameters:
displayName - Attendee name to display on UI.

getPercent

public int getPercent()
When the Attendee is linked to a Todo, this show the completion rate of the task.

The value is expressed in percent.

Returns:
The Todo completion rate in percent.

setPercent

public void setPercent(int percent)
When the Attendee is linked to a Todo, this let you set the completion rate of the task.

The value must be expressed in percent.

Parameters:
percent - Completion rate in percent

setType

public void setType(java.lang.String type)
This property describe if set the type of the Entity linked to this Attendee object. Associated with setId(int) this allow Blue-Mind Core to identify the Entity.

The type can be :

Parameters:
type - The string describing the Entity type.

getType

public java.lang.String getType()
This property describe if the type of the Entity linked to this Attendee object.

Associated with getId() this allow Blue-Mind Core to identify the Entity.

The type can be :

Parameters:
type - The string describing the Entity type.

setId

public void setId(int id)
This property describe if set the Blue-Mind Core unique identifier for the Entity linked to this Attendee object.

The identifier is unique for a given Blue-Mind installation and a getType().

Associated with setType(String) this allow Blue-Mind Core to identify the Entity.

Parameters:
id - The Entity identifier.
See Also:
Entity.getId()

getId

public int getId()
This property describe the Blue-Mind Core unique identifier for the Entity linked to this Attendee object.

The identifier is unique for a given Blue-Mind installation and a getType().

Associated with getType() this allow Blue-Mind Core to identify the Entity.

Returns:
The Entity identifier.
See Also:
Entity.getId()

setAlert

public void setAlert(java.lang.Integer alert)
Set a reminder for the linked Event.

The default form of the alert is a mail sent to the Entity default email, alert seconds before the Event.getDate().

Parameters:
alert - How many seconds before Event begin the reminder will be triggered.
See Also:
EventAlert

getAlert

public java.lang.Integer getAlert()
Get the configured reminder for the linked Event.

Returns:
How many seconds before Event begin the reminder will be triggered.
See Also:
EventAlert

getCalendarInfo

public CalendarInfo getCalendarInfo()
Return the CalendarInfo for this Attendee.

This can be used by Blue-Mind Coreto identify the Entity linked to this Attendee

Returns:
The CalendarInfo this Attendee describe the attendance of.
See Also:
ICalendar.getCalendarFromId(net.bluemind.core.api.AccessToken, int)

setCalendarInfo

public void setCalendarInfo(CalendarInfo calendarInfo)
Allow you to set a CalendarInfo for this Attendee.

This can be used by Blue-Mind Coreto identify the Entity linked to this Attendee.

Parameters:
calendarInfo - The CalendarInfo this Attendee describe the attendance of.
See Also:
ICalendar.getCalendarFromId(net.bluemind.core.api.AccessToken, int)

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

Blue Mind
Release 1.0