com.sssw.fw.event.api
Class EboStateChangeEvent

java.lang.Object
 |
 +--com.sssw.fw.event.api.EboEvent
       |
       +--com.sssw.fw.event.api.EboStateChangeEvent

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

EboCmEvent, EboTaskEvent, EboWebdavEvent

public abstract class EboStateChangeEvent

extends EboEvent

Represents a state change event.

See Also:

Serialized Form

Field Summary

static int	EVENT_ID_BASE The base event ID.
static int	EVENT_ID_LAST The last event ID.
static int	EVENT_ID_UNKNOWN The "unknown" (default) event ID.
static int	SC_BASE The base state change.
static int	SC_CHECK_ACCESS The "access checked" state change.
static int	SC_CLEAR The "clear" state change.
static int	SC_COPY The "copy" state change.
static int	SC_CREATE The "create" state change.
static int	SC_DEFAULT The default state change.
static int	SC_DELETE The "delete" state change.
static int	SC_EXECUTE The "operation executed" state change.
static int	SC_EXPORT The "export" state change.
static int	SC_FAIL The "operation failed" state change.
static int	SC_GENERATE The "generate" state change
static int	SC_IMPORT The "import" state change.
static int	SC_INVALIDATE The "invalidate" state change.
static int	SC_LAST The "last" state change; represents the highest value of a state change reserved by the Director framework.
static int	SC_LIST The "list" state change.
static int	SC_LOGOFF The "logoff" state change.
static int	SC_LOGON The "logon" state change.
static int	SC_MOVE The "move" state change.
static int	SC_PUT The "put" state change.
static int	SC_QUERY The "query" state change.
static int	SC_REDEPLOY The "redeployed" state change.
static int	SC_REGISTERED The "registered" state change.
static int	SC_RETRIEVE The "retrieve" state change.
static int	SC_SELECT The "select" state change.
static int	SC_SILENCE The "silence" state change.
static int	SC_START The "operation started" state change.
static int	SC_STATUS The "status" state change.
static int	SC_STOP The "operation stopped" state change.
static int	SC_UNREGISTERED The "unregistered" state change.
static int	SC_UPDATE The "update" state change.
static String	STR_SC_CHECK_ACCESS The "access checked" state change identifier.
static String	STR_SC_CLEAR The "clear" state change identifier.
static String	STR_SC_COPY The "copy" state change identifier.
static String	STR_SC_CREATE The "create" state change identifier.
static String	STR_SC_DEFAULT The "default" state change identifier.
static String	STR_SC_DELETE The "delete" state change identifier.
static String	STR_SC_EXECUTE The "operation executed" state change identifier.
static String	STR_SC_EXPORT The "export" state change identifier.
static String	STR_SC_FAIL The "operation failed" state change identifier.
static String	STR_SC_GENERATE The "generate" state change identifier.
static String	STR_SC_IMPORT The "import" state change identifier.
static String	STR_SC_INVALIDATE The "invalidate" state change identifier.
static String	STR_SC_LIST The "list" state change identifier.
static String	STR_SC_LOGOFF The "logoff" state change identifier.
static String	STR_SC_LOGON The "logon" state change identifier.
static String	STR_SC_MOVE The "move" state change identifier.
static String	STR_SC_QUERY The "query" state change identifier.
static String	STR_SC_REGISTERED The "registered" state change identifier.
static String	STR_SC_RETRIEVE The "retrieve" state change identifier.
static String	STR_SC_SELECT The "select" state change identifier.
static String	STR_SC_SILENCE The "silence" state change identifier.
static String	STR_SC_START The "operation started" state change identifier.
static String	STR_SC_STATUS The "status" state change identifier.
static String	STR_SC_STOP The "operation stopped" state change identifier.
static String	STR_SC_UNKNOWN The "unknown" state change identifier.
static String	STR_SC_UNREGISTERED The "unregistered" state change identifier.
static String	STR_SC_UPDATE The "update" state change identifier.

Constructor Summary

EboStateChangeEvent()
Constructor.

EboStateChangeEvent(Object object)
Constructor with a custom object parameter.

EboStateChangeEvent(Object object, int state)
Constructor with a custom object and a state identifier.

Method Summary

abstract int	getEventID() Gets the event ID.
int	getState() Gets the state identifier.
String	getStateDescr() Gets the descriptor of the state.
abstract String	getVerboseDescr() Gets a verbose description of the event.
void	setState(int state) Sets the state identifier.

Methods inherited from class com.sssw.fw.event.api.EboEvent

getObject, setObject

Methods inherited from class java.lang.Object

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

Field Detail

EVENT_ID_UNKNOWN

public static final int EVENT_ID_UNKNOWN

The "unknown" (default) event ID. Subclasses are expected to generate their own event ID and return it in the getEventID method.

EVENT_ID_BASE

public static final int EVENT_ID_BASE

The base event ID. This is the lower end (start) of all the event ID's.

EVENT_ID_LAST

public static final int EVENT_ID_LAST

The last event ID. Note that all the event ID's from EVENT_ID_BASE up to EVENT_ID_LAST are reserved by the Director framework. Application developers are expected to generate their own event ID's, one per each event class, e.g.

     protected static final int MYCO_CUSTOM_EVENT1 = EVENT_ID_LAST + 1;
 

SC_BASE

public static final int SC_BASE

The base state change.

SC_DEFAULT

public static final int SC_DEFAULT

The default state change.

SC_REGISTERED

public static final int SC_REGISTERED

The "registered" state change.

SC_UNREGISTERED

public static final int SC_UNREGISTERED

The "unregistered" state change.

SC_CREATE

public static final int SC_CREATE

The "create" state change.

SC_RETRIEVE

public static final int SC_RETRIEVE

The "retrieve" state change.

SC_DELETE

public static final int SC_DELETE

The "delete" state change.

SC_UPDATE

public static final int SC_UPDATE

The "update" state change.

SC_PUT

public static final int SC_PUT

The "put" state change.

SC_SILENCE

public static final int SC_SILENCE

The "silence" state change.

SC_LOGON

public static final int SC_LOGON

The "logon" state change.

SC_LOGOFF

public static final int SC_LOGOFF

The "logoff" state change.

SC_GENERATE

public static final int SC_GENERATE

The "generate" state change

SC_SELECT

public static final int SC_SELECT

The "select" state change.

SC_STATUS

public static final int SC_STATUS

The "status" state change.

SC_IMPORT

public static final int SC_IMPORT

The "import" state change.

SC_EXPORT

public static final int SC_EXPORT

The "export" state change.

SC_INVALIDATE

public static final int SC_INVALIDATE

The "invalidate" state change.

SC_CLEAR

public static final int SC_CLEAR

The "clear" state change.

SC_LIST

public static final int SC_LIST

The "list" state change.

SC_COPY

public static final int SC_COPY

The "copy" state change.

SC_MOVE

public static final int SC_MOVE

The "move" state change.

SC_QUERY

public static final int SC_QUERY

The "query" state change.

SC_EXECUTE

public static final int SC_EXECUTE

The "operation executed" state change.

SC_FAIL

public static final int SC_FAIL

The "operation failed" state change.

SC_START

public static final int SC_START

The "operation started" state change.

SC_STOP

public static final int SC_STOP

The "operation stopped" state change.

SC_CHECK_ACCESS

public static final int SC_CHECK_ACCESS

The "access checked" state change.

SC_REDEPLOY

public static final int SC_REDEPLOY

The "redeployed" state change.

SC_LAST

public static final int SC_LAST

The "last" state change; represents the highest value of a state change reserved by the Director framework. Any custom state change values must be defined by application programmers as LAST + where N is sequentially incremented by 1: LAST + 1, LAST + 2, LAST + 3, etc.

STR_SC_REGISTERED

public static final String STR_SC_REGISTERED

The "registered" state change identifier.

STR_SC_UNREGISTERED

public static final String STR_SC_UNREGISTERED

The "unregistered" state change identifier.

STR_SC_DEFAULT

public static final String STR_SC_DEFAULT

The "default" state change identifier.

STR_SC_SILENCE

public static final String STR_SC_SILENCE

The "silence" state change identifier.

STR_SC_CREATE

public static final String STR_SC_CREATE

The "create" state change identifier.

STR_SC_RETRIEVE

public static final String STR_SC_RETRIEVE

The "retrieve" state change identifier.

STR_SC_UPDATE

public static final String STR_SC_UPDATE

The "update" state change identifier.

STR_SC_DELETE

public static final String STR_SC_DELETE

The "delete" state change identifier.

STR_SC_LOGON

public static final String STR_SC_LOGON

The "logon" state change identifier.

STR_SC_LOGOFF

public static final String STR_SC_LOGOFF

The "logoff" state change identifier.

STR_SC_GENERATE

public static final String STR_SC_GENERATE

The "generate" state change identifier.

STR_SC_SELECT

public static final String STR_SC_SELECT

The "select" state change identifier.

STR_SC_STATUS

public static final String STR_SC_STATUS

The "status" state change identifier.

STR_SC_EXPORT

public static final String STR_SC_EXPORT

The "export" state change identifier.

STR_SC_IMPORT

public static final String STR_SC_IMPORT

The "import" state change identifier.

STR_SC_INVALIDATE

public static final String STR_SC_INVALIDATE

The "invalidate" state change identifier.

STR_SC_UNKNOWN

public static final String STR_SC_UNKNOWN

The "unknown" state change identifier.

STR_SC_CLEAR

public static final String STR_SC_CLEAR

The "clear" state change identifier.

STR_SC_LIST

public static final String STR_SC_LIST

The "list" state change identifier.

STR_SC_COPY

public static final String STR_SC_COPY

The "copy" state change identifier.

STR_SC_MOVE

public static final String STR_SC_MOVE

The "move" state change identifier.

STR_SC_QUERY

public static final String STR_SC_QUERY

The "query" state change identifier.

STR_SC_EXECUTE

public static final String STR_SC_EXECUTE

The "operation executed" state change identifier.

STR_SC_FAIL

public static final String STR_SC_FAIL

The "operation failed" state change identifier.

STR_SC_START

public static final String STR_SC_START

The "operation started" state change identifier.

STR_SC_STOP

public static final String STR_SC_STOP

The "operation stopped" state change identifier.

STR_SC_CHECK_ACCESS

public static final String STR_SC_CHECK_ACCESS

The "access checked" state change identifier.

Constructor Detail

EboStateChangeEvent

public EboStateChangeEvent()

Constructor.

EboStateChangeEvent

public EboStateChangeEvent(Object object)

Constructor with a custom object parameter.

Parameters:

object - custom object

EboStateChangeEvent

public EboStateChangeEvent(Object object,
                           int state)

Constructor with a custom object and a state identifier.

Parameters:

object - custom object

state - the state identifier

Method Detail

getState

public int getState()

Gets the state identifier.

Returns:

the state identifier

setState

public void setState(int state)

Sets the state identifier.

Parameters:

state - the state identifier

getStateDescr

public String getStateDescr()

Gets the descriptor of the state.

Returns:

state descriptor

getEventID

public abstract int getEventID()

Gets the event ID.

Returns:

the event ID

getVerboseDescr

public abstract String getVerboseDescr()

Gets a verbose description of the event.

Returns:

a verbose description of the event