com.nitido.nimx.nuggets.wcap
Class Attendee

java.lang.Object
  com.nitido.nimx.nuggets.wcap.Attendee

public class Attendee
extends java.lang.Object

The data object for storing information of an Attendee.

The iPlanet Calendar Server implementation of Attendee follows closely the RFC 2445 section 4.8.4.1.

Field Summary

protected static java.lang.String	MAILTO
protected static int	MAILTO_LEN

Constructor Summary

Attendee(ParticipateStatus parStat, boolean rsvp, java.lang.String calId, java.lang.String email)
Default constructor.

Attendee(java.lang.String parStatStr, java.lang.String rsvpStr, java.lang.String target)
Constructor used by the WcapNugget to create an instance of Attendee based on the XML results from the Calendar server.

Method Summary

boolean	equals(java.lang.Object inObj) Override the default java.lang.Object's equal command.
java.lang.String	getCalId() Get calId field.
java.lang.String	getEmail() Get email field.
ParticipateStatus	getParticipateStatus() Get PariticpateStatus field.
boolean	getRSVP() Get rsvp field.
void	setParticipateStatus(ParticipateStatus parStat) Set PariticpateStatus field.
void	setRSVP(boolean newRSVP) Set rsvp field.
void	setTarget(java.lang.String calId, java.lang.String email) Set the target of the attendee.
java.lang.String	toWcapQuery(WcapNugget nugget) Convert the component into a string that is used for constructing a WCAP query.

Methods inherited from class java.lang.Object

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

Field Detail

MAILTO

protected static final java.lang.String MAILTO

See Also:

Constant Field Values

MAILTO_LEN

protected static final int MAILTO_LEN

Constructor Detail

Attendee

public Attendee(ParticipateStatus parStat,
                boolean rsvp,
                java.lang.String calId,
                java.lang.String email)
         throws InvalidParameterException

Default constructor.

One way to notify an attendee is through his/her calendar on the same server. If the attendees have set up the preference correctly for their own calendar, the iPlanet Calender server will notify them through email. Another way to notify an attendee is to directly specify the email address.

However, you may be able to specify only one of the calendar Id and the email address for each attendee entry. If you want to specify both calendar Id and email address, they should be put into two separate Attendee objects.

Parameters:

parStat - the ParticipateStatus object that indicates whether the attendee has accepted, declined or no-action-required.

rsvp - a boolean value that indicates whether the attendee need to reply/confirm the invitation.

calId - a String that indicates the attendee's calendar Id. If this value is non-null, the parameter "email" will be ignored.

email - a String that indicates the email address of the attendee. It will be ignored if the parameter "calId" is not null.

Throws:

InvalidParameterException

Attendee

public Attendee(java.lang.String parStatStr,
                java.lang.String rsvpStr,
                java.lang.String target)
         throws InvalidParameterException

Constructor used by the WcapNugget to create an instance of Attendee based on the XML results from the Calendar server. This is not for external use.

Throws:

InvalidParameterException

Method Detail

getParticipateStatus

public ParticipateStatus getParticipateStatus()

Get PariticpateStatus field.

setParticipateStatus

public void setParticipateStatus(ParticipateStatus parStat)
                          throws InvalidParameterException

Set PariticpateStatus field. This value must be valid.

Throws:

InvalidParameterException

getRSVP

public boolean getRSVP()

Get rsvp field.

setRSVP

public void setRSVP(boolean newRSVP)

Set rsvp field.

getCalId

public java.lang.String getCalId()

Get calId field.

getEmail

public java.lang.String getEmail()

Get email field.

setTarget

public void setTarget(java.lang.String calId,
                      java.lang.String email)
               throws InvalidParameterException

Set the target of the attendee. A target can be the attendee's calendar Id or his/her email address.

Throws:

InvalidParameterException

toWcapQuery

public java.lang.String toWcapQuery(WcapNugget nugget)
                             throws WcapException

Convert the component into a string that is used for constructing a WCAP query. This method is designed for internal use by the WcapNugget only.

Throws:

WcapException

equals

public boolean equals(java.lang.Object inObj)

Override the default java.lang.Object's equal command. This will compares the content of the fields. In case of a vector or array field, it will compare the content of the field.

Overrides:

equals in class java.lang.Object