com.objectplanet.survey.plugin.api
Class Invitee

java.lang.Object
  com.objectplanet.survey.plugin.api.Invitee

public class Invitee
extends java.lang.Object

Class represents an invitee (person who receives an invitation to a survey).

Author:

Irina Brun

Created:

28. march 2003

Field Summary

static int	INVALID_EMAIL_ADDRESS Invitee status: email address is invalid
static int	INVITATION_PENDING Invitee status: invitation is pending
static int	INVITATION_SEND_ERROR Invitee status: error occurred while sending invitation
static int	INVITATION_SENT Invitee status: the invitation has been sent
static int	REMINDER_ERROR Invitee status: error occurred while sending reminder
static int	REMINDER_SENT Invitee status: reminder has been sent

Method Summary

java.lang.String	getAttribute(java.lang.String attributeName) Gets the value for a invitee attribute.
java.util.HashMap	getAttributes() Gets all the invitee attributes.
java.lang.String	getIdKey() Returns the value of invitee idKey
long	getInvitationId() Gets the invitation id
java.lang.String	getInviteeEmail() Gets the invitee email
long	getInviteeId() Gets the invitee id
java.lang.String	getInviteeName() Gets the invitee name
int	getReminderCount() Gets the reminder count (the number of times reminder is sent requesting participation).
long	getRespondentId() Gets the respondent id.
long	getSentDate() Gets the sent date (when the invitation was sent)
int	getStatus() Gets the status of the invitee.
long	getSurveyId() Gets the survey id

Methods inherited from class java.lang.Object

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

Field Detail

INVITATION_PENDING

public static final int INVITATION_PENDING

Invitee status: invitation is pending

See Also:

Constant Field Values

INVITATION_SENT

public static final int INVITATION_SENT

Invitee status: the invitation has been sent

See Also:

Constant Field Values

REMINDER_SENT

public static final int REMINDER_SENT

Invitee status: reminder has been sent

See Also:

Constant Field Values

INVITATION_SEND_ERROR

public static final int INVITATION_SEND_ERROR

Invitee status: error occurred while sending invitation

See Also:

Constant Field Values

REMINDER_ERROR

public static final int REMINDER_ERROR

Invitee status: error occurred while sending reminder

See Also:

Constant Field Values

INVALID_EMAIL_ADDRESS

public static final int INVALID_EMAIL_ADDRESS

Invitee status: email address is invalid

See Also:

Constant Field Values

Method Detail

getIdKey

public java.lang.String getIdKey()

Returns the value of invitee idKey

getInvitationId

public long getInvitationId()

Gets the invitation id

Returns:

The invitation id

getSurveyId

public long getSurveyId()

Gets the survey id

Returns:

The survey id

getInviteeId

public long getInviteeId()

Gets the invitee id

Returns:

The invitee id

getInviteeName

public java.lang.String getInviteeName()

Gets the invitee name

Returns:

The invitee name

getInviteeEmail

public java.lang.String getInviteeEmail()

Gets the invitee email

Returns:

The invitee email

getSentDate

public long getSentDate()

Gets the sent date (when the invitation was sent)

Returns:

The sent date value

getReminderCount

public int getReminderCount()

Gets the reminder count (the number of times reminder is sent requesting participation).

Returns:

The reminder count

getStatus

public int getStatus()

Gets the status of the invitee. The status tells something about the invitee, if the invitation is sent, or if there was an error sending it, or if the survey is responded to. One of the constants above.

Returns:

The status

getRespondentId

public long getRespondentId()

Gets the respondent id. Will be set after the invitee has responded to the survey.

Returns:

The respondent id

getAttribute

public java.lang.String getAttribute(java.lang.String attributeName)

Gets the value for a invitee attribute.

Parameters:

String - attributeName The attribute name

Returns:

String attributeValue The attribute value

getAttributes

public java.util.HashMap getAttributes()

Gets all the invitee attributes.

Returns:

attributes The invitee attributes hashmap