rsvp.controller
Interface ResponseControllerInterface

All Known Implementing Classes:

ResponseController

public interface ResponseControllerInterface

Method Summary

java.lang.String	getComment() Returns this respondent's comment.
java.lang.String	getDisplayEmail() Returns a displayable (i.e.
java.lang.String	getStatus() Returns "yes", "no", or "maybe", depending on the status of the controlled response.
void	updateComment(java.lang.String comment, java.lang.String email) Updates the comment of the controlled Response.
void	updateStatus(int status, java.lang.String email) Updates the status of the controlled Response.

Method Detail

getStatus

java.lang.String getStatus()

Returns "yes", "no", or "maybe", depending on the status of the controlled response. (That is, Response.YES, Response.NO, or Response.MAYBE, respectively.)

Returns:

a string representation of the status of the response

getComment

java.lang.String getComment()

Returns this respondent's comment.

Returns:

this respondent's comment.

getDisplayEmail

java.lang.String getDisplayEmail()

Returns a displayable (i.e. spam-sanitized) version of the email address for this respondent, as generated by the getDisplayEmail() method of class EmailAddress.

Returns:

a displayable version of the email address for this respondent

updateStatus

void updateStatus(int status,
                  java.lang.String email)

Updates the status of the controlled Response. Note that this method will only update the status if the view has "authenticated" the respondent by providing their proper email address. Otherwise, it will throw a PermissionException. If the provided status is not valid, this method will throw a BogusParameterException.

Parameters:

status - the new status. Must be either Response.YES, Response.NO, or Response.MAYBE.

email - an email address, which must match the email address of this respondent

updateComment

void updateComment(java.lang.String comment,
                   java.lang.String email)

Updates the comment of the controlled Response. Note that this method will only update the comment if the view has "authenticated" the respondent by providing their proper email address. Otherwise, it will throw a PermissionException.

Parameters:

comment - the new comment

email - an email address, which must match the email address of this respondent