Event (Alfresco Benchmark Manager 3.0.2 API)

java.lang.Object
- org.alfresco.bm.driver.event.Event

```
public class Event
extends Object
```
An event that is persisted and retrieved for processing.

Since:

1.0

Author:

Derek Hulley

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`EVENT_BEAN_PREFIX`
`static String`	`EVENT_ID_START`
`static String`	`EVENT_NAME_START`
`static String`	`FIELD_DATA`
`static String`	`FIELD_DATA_OWNER`
`static String`	`FIELD_DRIVER`
`static String`	`FIELD_ID`
`static String`	`FIELD_LOCK_OWNER`
`static String`	`FIELD_LOCK_TIME`
`static String`	`FIELD_NAME`
`static String`	`FIELD_SCHEDULED_TIME`
`static String`	`FIELD_SESSION_ID`
`static String`	`FIELD_VALUE` The 'value' that is associated with the data

Constructor Summary

Constructors
Constructor and Description
`Event(String name, long scheduledTime, Object data)` Construct a scheduled event with some data.
`Event(String name, long scheduledTime, Object data, boolean dataInMemory)` Construct a scheduled event with some data, optionally forcing the data to be stored in memory.
`Event(String name, Object data)` Construct an event with some data, scheduling it for the current time.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static boolean`	`canPersistDataObject(Object data)` Determine if the data can be written out to MongoDB
`boolean`	`equals(Object obj)`
`Object`	`getData()`
`boolean`	`getDataInMemory()`
`Object`	`getDataObject()` Deprecated. in V2.0.2
`String`	`getDriver()`
`String`	`getId()`
`String`	`getLockOwner()`
`long`	`getLockTime()`
`String`	`getName()`
`long`	`getScheduledTime()`
`String`	`getSessionId()`
`int`	`hashCode()`
`void`	`setDriver(String driver)`
`void`	`setId(String id)`
`void`	`setLockOwner(String lockOwner)`
`void`	`setLockTime(long lockTime)`
`void`	`setSessionId(String sessionId)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - FIELD_ID
```
public static final String FIELD_ID
```
    See Also:
    
    Constant Field Values
  - FIELD_NAME
```
public static final String FIELD_NAME
```
    See Also:
    
    Constant Field Values
  - FIELD_SESSION_ID
```
public static final String FIELD_SESSION_ID
```
    See Also:
    
    Constant Field Values
  - FIELD_SCHEDULED_TIME
```
public static final String FIELD_SCHEDULED_TIME
```
    See Also:
    
    Constant Field Values
  - FIELD_LOCK_OWNER
```
public static final String FIELD_LOCK_OWNER
```
    See Also:
    
    Constant Field Values
  - FIELD_LOCK_TIME
```
public static final String FIELD_LOCK_TIME
```
    See Also:
    
    Constant Field Values
  - FIELD_DATA
```
public static final String FIELD_DATA
```
    See Also:
    
    Constant Field Values
  - FIELD_DATA_OWNER
```
public static final String FIELD_DATA_OWNER
```
    See Also:
    
    Constant Field Values
  - FIELD_DRIVER
```
public static final String FIELD_DRIVER
```
    See Also:
    
    Constant Field Values
  - FIELD_VALUE
```
public static final String FIELD_VALUE
```
    The 'value' that is associated with the data
    
    See Also:
    
    Constant Field Values
  - EVENT_NAME_START
```
public static final String EVENT_NAME_START
```
    See Also:
    
    Constant Field Values
  - EVENT_ID_START
```
public static final String EVENT_ID_START
```
    See Also:
    
    Constant Field Values
  - EVENT_BEAN_PREFIX
```
public static final String EVENT_BEAN_PREFIX
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Event
```
public Event(String name,
             Object data)
```
    Construct an event with some data, scheduling it for the current time.
    NB: BEWARE OF JAVA AUTOBOXING OF NUMERIC DATA. This constructor assumes the event trigger time is now.
    Use a DBObject to allow full MongoDB-friendly persistence, allowing searching for data.X-style searches where the object has key *X*, say. The data, if a String, will be persisted directly with this event.
    
    Parameters:
    
    name - the event name
    
    data - the event data
  - Event
```
public Event(String name,
             long scheduledTime,
             Object data)
```
    Construct a scheduled event with some data.
    Use a DBObject to allow full MongoDB-friendly persistence, allowing searching for data.X-style searches where the object has key *X*, say. The data, if a String, will be persisted directly with this event.
    Events that keep their data in memory cannot be executed by any other running service and will therefore be lost if the server goes down.
    
    Parameters:
    
    name - the event name
    
    scheduledTime - when the event should be processed
    
    data - the event data
  - Event
```
public Event(String name,
             long scheduledTime,
             Object data,
             boolean dataInMemory)
```
    Construct a scheduled event with some data, optionally forcing the data to be stored in memory. If the option is selected to force in-memory storage or if the data is not String, then the data will be stored in local memory and a unique look-up key will be persisted.
    Use a DBObject to allow full MongoDB-friendly persistence, allowing searching for data.X-style searches where the object has key *X*, say. The data, if a String, will be persisted directly with this event.
    Events that keep their data in memory cannot be executed by any other running service and will therefore be lost if the server goes down.
    
    Parameters:
    
    name - the event name
    
    scheduledTime - when the event should be processed
    
    data - the event data
    
    dataInMemory - prevent the data from being persisted to the event storage. Incompatible data types will be handled automatically, but there may be cases where sensitive data may need to be kept in memory for some reason.
- Method Detail
  - canPersistDataObject
```
public static boolean canPersistDataObject(Object data)
```
    Determine if the data can be written out to MongoDB
    
    Parameters:
    
    data - the data to store (in memory or persisted)
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - getId
```
public String getId()
```
  - setId
```
public void setId(String id)
```
  - getName
```
public String getName()
```
  - getSessionId
```
public String getSessionId()
```
  - setSessionId
```
public void setSessionId(String sessionId)
```
  - getScheduledTime
```
public long getScheduledTime()
```
  - getLockOwner
```
public String getLockOwner()
```
  - setLockOwner
```
public void setLockOwner(String lockOwner)
```
  - getLockTime
```
public long getLockTime()
```
  - setLockTime
```
public void setLockTime(long lockTime)
```
  - getData
```
public Object getData()
```
  - getDataInMemory
```
public boolean getDataInMemory()
```
  - getDataObject
```
@Deprecated
public Object getDataObject()
```
    Deprecated. in V2.0.2
  - getDriver
```
public String getDriver()
```
    Returns:
    
    the ID of the driver that should execute the event
  - setDriver
```
public void setDriver(String driver)
```

Class Event

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FIELD_ID

FIELD_NAME

FIELD_SESSION_ID

FIELD_SCHEDULED_TIME

FIELD_LOCK_OWNER

FIELD_LOCK_TIME

FIELD_DATA

FIELD_DATA_OWNER

FIELD_DRIVER

FIELD_VALUE

EVENT_NAME_START

EVENT_ID_START

EVENT_BEAN_PREFIX

Constructor Detail

Event

Event

Event

Method Detail

canPersistDataObject

toString

hashCode

equals

getId

setId

getName

getSessionId

setSessionId

getScheduledTime

getLockOwner

setLockOwner

getLockTime

setLockTime

getData

getDataInMemory

getDataObject

getDriver

setDriver