com.communote.server.web.fe.portal.controller

Class SecurityCodeConfirmationResult

java.lang.Object

com.communote.server.web.fe.portal.controller.SecurityCodeConfirmationResult

public class SecurityCodeConfirmationResult
extends Object

Holds the results of the confirmation of a security code.

Author:

Communote GmbH - http://www.communote.com/

Constructor Summary

Constructors

Constructor and Description
SecurityCodeConfirmationResult(boolean success, LocalizedMessage message) Create a new result

Method Summary

Modifier and Type	Method and Description
LocalizedMessage	getErrorMessage()
LocalizedMessage	getSuccessMessage()
LocalizedMessage	getWarningMessage()
boolean	isSuccess()
void	setErrorMessage(LocalizedMessage errorMessage) Set a message that describes what went wrong during confirmation of the code
void	setSuccessMessage(LocalizedMessage successMessage) Set a message to give some feedback about the successful code confirmation
void	setWarningMessage(LocalizedMessage warningMessage) Set a message with warning.

Methods inherited from class java.lang.Object

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

Constructor Detail

SecurityCodeConfirmationResult

public SecurityCodeConfirmationResult(boolean success,
                                      LocalizedMessage message)

Create a new result

Parameters:

success - whether the confirmation was successful

message - if success is true the success message will be set to this value otherwise it will be stored as the error message

Method Detail

getErrorMessage

public LocalizedMessage getErrorMessage()

Returns:

the error message. Is only relevant if isSuccess() returns false.

getSuccessMessage

public LocalizedMessage getSuccessMessage()

Returns:

the success message. Is only relevant if isSuccess() returns true and no warning message exists.

getWarningMessage

public LocalizedMessage getWarningMessage()

Returns:

the warning message. Is only relevant if isSuccess() returns true.

isSuccess

public boolean isSuccess()

Returns:

whether the code confirmation was successful

setErrorMessage

public void setErrorMessage(LocalizedMessage errorMessage)

Set a message that describes what went wrong during confirmation of the code

Parameters:

errorMessage - the error message

setSuccessMessage

public void setSuccessMessage(LocalizedMessage successMessage)

Set a message to give some feedback about the successful code confirmation

Parameters:

successMessage - the success message

setWarningMessage

public void setWarningMessage(LocalizedMessage warningMessage)

Set a message with warning. This message will be shown instead of the success message if set and the confirmation was successful.

Parameters:

warningMessage - the warning message