org.iscreen
Interface FailureMessage

All Known Implementing Classes:
OgnlMessage, OgnlResourceMessage

public interface FailureMessage

A failure message is a holding interface for objects that represent failure messages. These are passed to Validators to use to report particular failures. For example, a Validator may report two different types of failures, so it'll be configured with two different instances of this interface, which it will use to report failures, depending upon the type.

Author:
Shellman, Dan

Method Summary
 java.lang.String getMessage(java.lang.Object obj, java.util.Locale locale)
          Get the actual failure message.
 

Method Detail

getMessage

java.lang.String getMessage(java.lang.Object obj,
                            java.util.Locale locale)
Get the actual failure message. Validators shouldn't call this method, as it's used by the context to construct the actual failure object that is eventually returned. This method takes an additional locale for internationalization support.

Parameters:
obj - An object used in generating the message
locale - The locale use for localizing the message.