|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@PublicApi public interface WebErrorMessage
Interface to be used with user management plugin points to encapsulate error messages
and a useful information for displaying those error messages to a user. An error
message should contain a full sentence returned by getDescription()
, a
short snippet
of a message to serve as a summary of the error
message, and optionally a URI to link to further information when only the snippet
is presented to the user.
Method Summary | |
---|---|
String |
getDescription()
Returns a message containing the reason an error message has been generated. |
String |
getSnippet()
Returns a short form of the error message that getDescription would provide. |
URI |
getURI()
Returns a URI that can be used to direct users
to pages with more information that can be tied to the snippet |
Method Detail |
---|
String getDescription()
null
String getSnippet()
null
URI getURI()
URI
that can be used to direct users
to pages with more information that can be tied to the snippet
null
if none is available
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |