org.alfresco.bm.common

Class EventDetails

java.lang.Object

org.alfresco.bm.common.EventDetails

All Implemented Interfaces:

Serializable

public class EventDetails
extends Object
implements Serializable

Event details to show in the BM UI

Since:

2.0.10

Author:

Frank Becker

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_EVENT_DETAILS_NAME_STRING Stores the default name of event details

Constructor Summary

Constructors

Constructor and Description
EventDetails() Default constructor
EventDetails(Date time, String name, boolean success, Object inputData, Object resultData) STD constructor

Method Summary

Modifier and Type	Method and Description
String	getEventInputData()
String	getEventName()
String	getEventResultData()
Date	getEventTime()
boolean	isEventSuccess()
EventDetails	setEventInputData(Object eventInputData)
EventDetails	setEventName(String eventName)
EventDetails	setEventResultData(Object eventResultData)
EventDetails	setEventSuccess(boolean eventSuccess)
EventDetails	setEventTime(Date eventTime)
com.mongodb.DBObject	toDBObject() Conversion to DBObject
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_EVENT_DETAILS_NAME_STRING

public static final String DEFAULT_EVENT_DETAILS_NAME_STRING

Stores the default name of event details

See Also:

Constant Field Values

Constructor Detail

EventDetails

public EventDetails()

Default constructor

EventDetails

public EventDetails(Date time,
                    String name,
                    boolean success,
                    Object inputData,
                    Object resultData)

STD constructor

Parameters:

time - (Date) event time

name - (String) event name

success - (boolean) event succeeded?

inputData - (Object, optional) event.data object that created the event result

resultData - (Object, optional) eventResult.data object

Method Detail

getEventTime

public Date getEventTime()

Returns:

the eventTime

setEventTime

public EventDetails setEventTime(Date eventTime)

Parameters:

eventTime - (Date, required) the eventTime to set

getEventName

public String getEventName()

Returns:

(String) the eventName

setEventName

public EventDetails setEventName(String eventName)

Parameters:

eventName - (String, required) the eventName to set

isEventSuccess

public boolean isEventSuccess()

Returns:

(boolean) the eventSuccess

setEventSuccess

public EventDetails setEventSuccess(boolean eventSuccess)

Parameters:

eventSuccess - (boolean) the eventSuccess to set

getEventInputData

public String getEventInputData()

Returns:

(String, may be null or empty) input data of the event (event.data field as string representation)

setEventInputData

public EventDetails setEventInputData(Object eventInputData)

Parameters:

eventInputData - (Object, optional) input data of the event (event.data field as string representation) to set

getEventResultData

public String getEventResultData()

Returns:

(String, may be null or empty) the string representation (or null / empty String) of the EventResult.data field

setEventResultData

public EventDetails setEventResultData(Object eventResultData)

Parameters:

eventResultData - (Object, optional) the string representation (or null / empty String) of the EventResult.data field to set

toString

public String toString()

Overrides:

toString in class Object

Returns:

(String) JSON serialization of this class

toDBObject

public com.mongodb.DBObject toDBObject()

Conversion to DBObject

Returns:

DBObject