EventEscalation

All Known Implementing Classes:

EventEscalator, EventTracker
```
public interface EventEscalation
```
EventEscalation is an interface for an escalation upon an event.

It is up to the implementation to decide whether to support checkpointing and how to do checkpointing.

Author:

yannanlu@yahoo.com

Field Summary

Fields
Modifier and Type Field and Description

static int ORDER_FIRST

static int ORDER_LAST

static int ORDER_NONE

Fields
Modifier and Type	Field and Description
`static int`	`ORDER_FIRST`
`static int`	`ORDER_LAST`
`static int`	`ORDER_NONE`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.util.Map<java.lang.String,java.lang.Object>`	`checkpoint()` returns the checkpoint Map for the escalation
`void`	`clear()` cleans up all internal caches and releases all resources
`Event`	`escalate(int status, long currentTime, Event event)` It examines the event and returns a new event as the escalation or null if no escalation.
`int`	`getEscalationOrder()` It returns an integer as the escalation order that determines if the escalation event to be processed before the original event or not.
`java.lang.String`	`getName()` returns the name of the escalation
`int`	`getSessionSize()` returns the size of current session
`long`	`getSessionTime()` returns the start time of current session
`int`	`resetSession(long currentTime)` resets the internal session returns number of items being reset
`void`	`restoreFromCheckpoint(java.util.Map<java.lang.String,java.lang.Object> checkpointer)` restores the state of the escalation from the checkpoint Map

- Field Detail
  - ORDER_LAST
```
static final int ORDER_LAST
```
    See Also:
    
    Constant Field Values
  - ORDER_NONE
```
static final int ORDER_NONE
```
    See Also:
    
    Constant Field Values
  - ORDER_FIRST
```
static final int ORDER_FIRST
```
    See Also:
    
    Constant Field Values
- Method Detail
  - escalate
```
Event escalate(int status,
               long currentTime,
               Event event)
```
    It examines the event and returns a new event as the escalation or null if no escalation.
  - getName
```
java.lang.String getName()
```
    returns the name of the escalation
  - getEscalationOrder
```
int getEscalationOrder()
```
    It returns an integer as the escalation order that determines if the escalation event to be processed before the original event or not. If the escalation order is ORDER_FISRT, the escalation event should be processed before the original event. If it is ORDER_LAST, the escalation event should be processed after. If it is ORDER_NONE, which one is the first does not matter.
  - resetSession
```
int resetSession(long currentTime)
```
    resets the internal session returns number of items being reset
  - getSessionTime
```
long getSessionTime()
```
    returns the start time of current session
  - getSessionSize
```
int getSessionSize()
```
    returns the size of current session
  - checkpoint
```
java.util.Map<java.lang.String,java.lang.Object> checkpoint()
```
    returns the checkpoint Map for the escalation
  - restoreFromCheckpoint
```
void restoreFromCheckpoint(java.util.Map<java.lang.String,java.lang.Object> checkpointer)
```
    restores the state of the escalation from the checkpoint Map
  - clear
```
void clear()
```
    cleans up all internal caches and releases all resources

Interface EventEscalation

Field Summary

Method Summary

Field Detail

ORDER_LAST

ORDER_NONE

ORDER_FIRST

Method Detail

escalate

getName

getEscalationOrder

resetSession

getSessionTime

getSessionSize

checkpoint

restoreFromCheckpoint

clear