org.alfresco.bm.common

Class EventResult

java.lang.Object

org.alfresco.bm.common.EventResult

public class EventResult
extends Object

The result of event processing. Instances can contain future events and additional data to for record purposes.

Since:

1.0

Author:

Derek Hulley

Constructor Summary

Constructors

Constructor and Description
EventResult(List<Event> nextEvents) Constructor for successful results containing future events without any additional data to record.
EventResult(Object data, boolean success) Constructor for results containing no future events.
EventResult(Object data, Event nextEvent) Constructor for successful results containing a future event with additional data to record.
EventResult(Object data, List<Event> nextEvents) Constructor for successful results containing future events with additional data to record.
EventResult(Object data, List<Event> nextEvents, boolean success) Constructor for results containing future events with additional data to record.

Method Summary

Modifier and Type	Method and Description
Object	getData()
List<Event>	getNextEvents()
boolean	isSuccess()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

EventResult

public EventResult(List<Event> nextEvents)

Constructor for successful results containing future events without any additional data to record.

Parameters:

nextEvents - any events that now follow on the processed event (may be empty)

EventResult

public EventResult(Object data,
                   List<Event> nextEvents)

Constructor for successful results containing future events with additional data to record.

Parameters:

data - additional data to record (e.g. a Throwable)

nextEvents - any events that now follow on the processed event (may be empty)

EventResult

public EventResult(Object data,
                   Event nextEvent)

Constructor for successful results containing a future event with additional data to record.

Parameters:

data - additional data to record (e.g. a Throwable)

nextEvent - the event that now follow on the processed event (never null)

EventResult

public EventResult(Object data,
                   boolean success)

Constructor for results containing no future events.

Parameters:

data - additional data to record (e.g. a Throwable)

success - true if the result represents a successful operation

EventResult

public EventResult(Object data,
                   List<Event> nextEvents,
                   boolean success)

Constructor for results containing future events with additional data to record.

Parameters:

data - additional data to record (e.g. a Throwable)

nextEvents - any events that now follow on the processed event (may be empty)

success - true if the result represents a successful operation

Method Detail

getData

public Object getData()

Returns:

Returns additional data to record or null

getNextEvents

public List<Event> getNextEvents()

Returns:

any events that now follow on the processed event (may be empty)

isSuccess

public boolean isSuccess()

Returns:

true if the event was successful otherwise false

toString

public String toString()

Overrides:

toString in class Object