votorola.a.response

Interface CommandResponder

All Known Implementing Classes:

CommandResponder.Base, CR_Hello, CR_Help, CR_Reconstruct, CR_Unvote, CR_Version, CR_Vote

public interface CommandResponder

A responder to a voter command.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CommandResponder.AnonymousIssueException Thrown when a command cannot be accepted because it was issued anonymously.
static class	CommandResponder.Base Base implementation of a command responder.
static class	CommandResponder.Session A service session with a user.
static class	CommandResponder.U Command responder utilities.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	acceptsAnonymousIssue() Answers whether the command may be issued by unauthenticated users.
String	commandName(CommandResponder.Session session) Returns the localized name of the command.
void	help(CommandResponder.Session session) Replies with instructions on using the command.
Exception	respond(String[] argv, CommandResponder.Session session) Responds to an invocation of the command.

Method Detail

acceptsAnonymousIssue

boolean acceptsAnonymousIssue()

Answers whether the command may be issued by unauthenticated users.

commandName

String commandName(CommandResponder.Session session)

Returns the localized name of the command.

help

void help(CommandResponder.Session session)

Replies with instructions on using the command.

respond

Exception respond(String[] argv,
                CommandResponder.Session session)

Responds to an invocation of the command.

Parameters:

argv - an array comprising the command name (index 0) and any arguments (indeces 1..*).

Returns:

any soft exception of a potentially temporary cause that might clear up on retry, or null if none occured.

Throws:

CommandResponder.AnonymousIssueException - if session is anonymous, but the responder requires a voter email address.