org.bridje.web.view

Class EventResult

java.lang.Object

org.bridje.web.view.EventResult

public class EventResult
extends Object

The result of the invocation of a web event.

Method Summary

Modifier and Type	Method and Description
static EventResult	error(String message) Creates a new error event result object, that will show an error type message to the end user.
static EventResult	error(String message, Exception exception) Creates a new error event result object, that will show an error type message to the end user.
static EventResult	error(String message, Exception exception, FieldStatusInf... fields) Creates a new error event result object, that will show an error type message to the end user.
static EventResult	error(String message, FieldStatusInf... fields) Creates a new error event result object, that will show an error type message to the end user.
FieldStatusInf	findFieldStatus(String name) Gets the status information object set in this result for the given field.
Object	getData() The result object returned by the event method.
UIEvent	getEvent() The invoked event.
Exception	getException() The exception (if any) that was throw by the event method.
List<FieldStatusInf>	getFields() Gets all the fields status information objects for this result.
String	getMessage() The message to be show as the result of the event invocation.
EventResultType	getType() The type of the message that must be show to the user as the result of the invocation.
boolean	hasFieldStatus(String name) Determines if the given field has an explicit status information object set in this result.
static EventResult	info(String message) Creates a new info event result object, that will show an information type message to the end user.
static EventResult	info(String message, FieldStatusInf... fields) Creates a new info event result object, that will show an information type message to the end user.
static EventResult	info(String message, Object data) Creates a new info event result object, that will show an information type message to the end user.
static EventResult	info(String message, Object data, FieldStatusInf... fields) Creates a new info event result object, that will show an information type message to the end user.
static EventResult	none() Creates a new event result for the EventResultType.NONE type, and sets all data to null.
static EventResult	of(EventResultType type, String message, Object data, Exception exception) Creates a new event result, for the given type, that will show a message to the end user.
static EventResult	of(EventResultType type, String message, Object data, Exception exception, FieldStatusInf... fields) Creates a new event result, for the given type, that will show a message to the end user.
static EventResult	success(String message) Creates a new success event result object, that will show an success type message to the end user.
static EventResult	success(String message, FieldStatusInf... fields) Creates a new success event result object, that will show an success type message to the end user.
static EventResult	success(String message, Object data) Creates a new success event result object, that will show an success type message to the end user.
static EventResult	success(String message, Object data, FieldStatusInf... fields) Creates a new success event result object, that will show an success type message to the end user.
static EventResult	warn(String message) Creates a new warning event result object, that will show an warning type message to the end user.
static EventResult	warn(String message, FieldStatusInf... fields) Creates a new warning event result object, that will show an warning type message to the end user.
static EventResult	warn(String message, Object data) Creates a new warning event result object, that will show an warning type message to the end user.
static EventResult	warn(String message, Object data, Exception exception) Creates a new warning event result object, that will show an warning type message to the end user.
static EventResult	warn(String message, Object data, Exception exception, FieldStatusInf... fields) Creates a new warning event result object, that will show an warning type message to the end user.
static EventResult	warn(String message, Object data, FieldStatusInf... fields) Creates a new warning event result object, that will show an warning type message to the end user.

Methods inherited from class java.lang.Object

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

Method Detail

info

public static EventResult info(String message,
                               Object data)

Creates a new info event result object, that will show an information type message to the end user.

Parameters:

message - The message to show to the user.

data - The data to pass to the web view as the result of the event.

Returns:

An EventResult object of type info.

info

public static EventResult info(String message,
                               Object data,
                               FieldStatusInf... fields)

Creates a new info event result object, that will show an information type message to the end user.

Parameters:

message - The message to show to the user.

data - The data to pass to the web view as the result of the event.

fields - The information of the fields status after this event execution.

Returns:

An EventResult object of type info.

info

public static EventResult info(String message)

Creates a new info event result object, that will show an information type message to the end user.

Parameters:

message - The message to show to the user.

Returns:

An EventResult object of type info.

info

public static EventResult info(String message,
                               FieldStatusInf... fields)

Creates a new info event result object, that will show an information type message to the end user.

Parameters:

message - The message to show to the user.

fields - The information of the fields status after this event execution.

Returns:

An EventResult object of type info.

success

public static EventResult success(String message,
                                  Object data)

Creates a new success event result object, that will show an success type message to the end user.

Parameters:

message - The message to show to the user.

data - The data to pass to the web view as the result of the event.

Returns:

An EventResult object of type success.

success

public static EventResult success(String message,
                                  Object data,
                                  FieldStatusInf... fields)

Creates a new success event result object, that will show an success type message to the end user.

Parameters:

message - The message to show to the user.

data - The data to pass to the web view as the result of the event.

fields - The information of the fields status after this event execution.

Returns:

An EventResult object of type success.

success

public static EventResult success(String message)

Creates a new success event result object, that will show an success type message to the end user.

Parameters:

message - The message to show to the user.

Returns:

An EventResult object of type success.

success

public static EventResult success(String message,
                                  FieldStatusInf... fields)

Creates a new success event result object, that will show an success type message to the end user.

Parameters:

message - The message to show to the user.

fields - The information of the fields status after this event execution.

Returns:

An EventResult object of type success.

warn

public static EventResult warn(String message,
                               Object data)

Creates a new warning event result object, that will show an warning type message to the end user.

Parameters:

message - The message to show to the user.

data - The data to pass to the web view as the result of the event.

Returns:

An EventResult object of type warning.

warn

public static EventResult warn(String message,
                               Object data,
                               FieldStatusInf... fields)

Creates a new warning event result object, that will show an warning type message to the end user.

Parameters:

message - The message to show to the user.

data - The data to pass to the web view as the result of the event.

fields - The information of the fields status after this event execution.

Returns:

An EventResult object of type warning.

warn

public static EventResult warn(String message)

Creates a new warning event result object, that will show an warning type message to the end user.

Parameters:

message - The message to show to the user.

Returns:

An EventResult object of type warning.

warn

public static EventResult warn(String message,
                               FieldStatusInf... fields)

Creates a new warning event result object, that will show an warning type message to the end user.

Parameters:

message - The message to show to the user.

fields - The information of the fields status after this event execution.

Returns:

An EventResult object of type warning.

warn

public static EventResult warn(String message,
                               Object data,
                               Exception exception)

Creates a new warning event result object, that will show an warning type message to the end user.

Parameters:

message - The message to show to the user.

data - The data to pass to the web view as the result of the event.

exception - The exception responsable for this warning.

Returns:

An EventResult object of type warning.

warn

public static EventResult warn(String message,
                               Object data,
                               Exception exception,
                               FieldStatusInf... fields)

Creates a new warning event result object, that will show an warning type message to the end user.

Parameters:

message - The message to show to the user.

data - The data to pass to the web view as the result of the event.

exception - The exception responsable for this warning.

fields - The information of the fields status after this event execution.

Returns:

An EventResult object of type warning.

error

public static EventResult error(String message,
                                Exception exception)

Creates a new error event result object, that will show an error type message to the end user.

Parameters:

message - The message to show to the user.

exception - The exception responsable for this error.

Returns:

An EventResult object of type error.

error

public static EventResult error(String message)

Creates a new error event result object, that will show an error type message to the end user.

Parameters:

message - The message to show to the user.

Returns:

An EventResult object of type error.

error

public static EventResult error(String message,
                                Exception exception,
                                FieldStatusInf... fields)

Creates a new error event result object, that will show an error type message to the end user.

Parameters:

message - The message to show to the user.

exception - The exception responsable for this error.

fields - The information of the fields status after this event execution.

Returns:

An EventResult object of type error.

error

public static EventResult error(String message,
                                FieldStatusInf... fields)

Creates a new error event result object, that will show an error type message to the end user.

Parameters:

message - The message to show to the user.

fields - The information of the fields status after this event execution.

Returns:

An EventResult object of type error.

of

public static EventResult of(EventResultType type,
                             String message,
                             Object data,
                             Exception exception)

Creates a new event result, for the given type, that will show a message to the end user.

Parameters:

type - The type of message to show to the end user.

message - The message to show to the user.

data - The data to pass to the web view as the result of the event.

exception - The exception responsable for this error.

Returns:

An EventResult object of type error.

of

public static EventResult of(EventResultType type,
                             String message,
                             Object data,
                             Exception exception,
                             FieldStatusInf... fields)

Creates a new event result, for the given type, that will show a message to the end user.

Parameters:

type - The type of message to show to the end user.

message - The message to show to the user.

data - The data to pass to the web view as the result of the event.

exception - The exception responsable for this error.

fields - The information of the fields status after this event execution.

Returns:

An EventResult object of type error.

none

public static EventResult none()

Creates a new event result for the EventResultType.NONE type, and sets all data to null.

Returns:

An EventResult object of type none.

getEvent

public UIEvent getEvent()

The invoked event.

Returns:

The UIEvent object for the event.

getType

public EventResultType getType()

The type of the message that must be show to the user as the result of the invocation. SUCCESS, INFO, WARNING, ERROR.

Returns:

An EventResultType object.

getMessage

public String getMessage()

The message to be show as the result of the event invocation.

Returns:

An string with the message.

getException

public Exception getException()

The exception (if any) that was throw by the event method.

Returns:

An Exception or null if not Exception where throw by the event method.

getData

public Object getData()

The result object returned by the event method.

Returns:

An Object representing the result of the event method invocation.

getFields

public List<FieldStatusInf> getFields()

Gets all the fields status information objects for this result.

Returns:

All the fields status information objects for this result.

hasFieldStatus

public boolean hasFieldStatus(String name)

Determines if the given field has an explicit status information object set in this result.

Parameters:

name - The name of the field.

Returns:

true the field has an field status information object in this result, false othewise.

findFieldStatus

public FieldStatusInf findFieldStatus(String name)

Gets the status information object set in this result for the given field.

Parameters:

name - The full expresion for the field.

Returns:

The field status information object.