com.scaleoutsoftware.soss.client.da

Class StateServerEventArgs

java.lang.Object

com.scaleoutsoftware.soss.client.da.StateServerEventArgs

Direct Known Subclasses:

ObjectExpiredEventArgs

public class StateServerEventArgs
extends java.lang.Object

Identifies and provides the means for accessing a StateServer object reported in a callback event.

See Also:

ObjectExpiredEventArgs

Method Summary

Modifier and Type	Method and Description
int	getAppId() Returns the application namespace-derived application ID of the object which is the subject of the callback.
DataAccessor	getDataAccessor() Returns a DataAccessor initialized to access the object which is the subject of the callback.
StateServerEventCode	getEventCode() Returns the StateServerEventCode which indicates the reason for the callback.
java.util.Map<java.lang.Object,java.lang.Object>	getExtendedProperties() Returns a Map which can be used by the application to communicate state between multiple event handlers when more than one event handler is registered for an event.
StateServerKey	getKey() Returns the StateServerKey identifying the object which is the subject of the callback.

Methods inherited from class java.lang.Object

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

Method Detail

getAppId

public int getAppId()

Returns the application namespace-derived application ID of the object which is the subject of the callback.

Returns:

the application ID of the object described by this StateServerEventArgs instance.

getDataAccessor

public DataAccessor getDataAccessor()

Returns a DataAccessor initialized to access the object which is the subject of the callback.

Returns:

a DataAccessor which may be used to access the object

getEventCode

public StateServerEventCode getEventCode()

Returns the StateServerEventCode which indicates the reason for the callback.

Returns:

the StateServerEventCode which indicating the reason for the callback.

getExtendedProperties

public java.util.Map<java.lang.Object,java.lang.Object> getExtendedProperties()

Returns a Map which can be used by the application to communicate state between multiple event handlers when more than one event handler is registered for an event.

Returns:

a container for name/value pairs available for use to communicate state between multiple event handlers when more than one event handler is registered for an event.

getKey

public StateServerKey getKey()

Returns the StateServerKey identifying the object which is the subject of the callback.

Returns:

the StateServerKey identifying the object which is the subject of the callback.