rsvp.model
Interface ResponseInterface

All Known Implementing Classes:
Response

public interface ResponseInterface


Field Summary
static int MAYBE
          Response status indicating "might attend." This should have the value 0.
static int NO
          Response status indicating "will not attend." This should have the value -1.
static long serialVersionUID
           
static int YES
          Response status indicating "will attend." This should have the value 1.
 
Method Summary
 java.lang.String getComment()
          Gets this Response's comment.
 EmailAddressInterface getEmail()
          Gets the email address of the respondent.
 int getStatus()
          Returns the status of this response: one of Response.YES, Response.NO, or Response.MAYBE.
 void setComment(java.lang.String comment)
          Sets the comment for this Response.
 void setEmail(EmailAddressInterface email)
          Sets the email address of the respondent.
 void setStatus(int status)
          Sets the status of this response; throws a BogusParameterException if the status supplied is invalid.
 

Field Detail

serialVersionUID

static final long serialVersionUID
See Also:
Constant Field Values

YES

static final int YES
Response status indicating "will attend." This should have the value 1.

See Also:
Constant Field Values

NO

static final int NO
Response status indicating "will not attend." This should have the value -1.

See Also:
Constant Field Values

MAYBE

static final int MAYBE
Response status indicating "might attend." This should have the value 0.

See Also:
Constant Field Values
Method Detail

getEmail

EmailAddressInterface getEmail()
Gets the email address of the respondent.

Returns:
the email address of the respondent.

setEmail

void setEmail(EmailAddressInterface email)
Sets the email address of the respondent.

Parameters:
email - a valid EmailAddress

getComment

java.lang.String getComment()
Gets this Response's comment.

Returns:
this Response's comment, as a String.

setComment

void setComment(java.lang.String comment)
Sets the comment for this Response.

Parameters:
comment - a String representing a comment.

getStatus

int getStatus()
Returns the status of this response: one of Response.YES, Response.NO, or Response.MAYBE.

Returns:
an int, one of Response.YES, Response.NO, or Response.MAYBE.

setStatus

void setStatus(int status)
Sets the status of this response; throws a BogusParameterException if the status supplied is invalid.

Precondition: The supplied status must be Response.YES, Response.NO, or Response.MAYBE. If a different status is supplied, this method must throw a BogusParameterException.

Parameters:
status - one of Response.YES, Response.NO, or Response.MAYBE.