Package com.opencloud.rhino.resources.sessionownership

Class SessionOwnershipReadResultEvent

java.lang.Object

com.opencloud.rhino.resources.sessionownership.SessionOwnershipReadResultEvent

@SleeEvent(id=@ComponentId(name="com.opencloud.rhino.resources.sessionownership.SessionOwnershipReadResultEvent",vendor="OpenCloud",version="1.0"))
public final class SessionOwnershipReadResultEvent
extends Object

This event is fired on a SessionOwnershipActivity to report the outcome of a retrieve query operation.

Since:

Rhino 2.6.1

Constructor Summary

Constructors

Constructor	Description
SessionOwnershipReadResultEvent(long queryID, boolean successful, Set<SessionOwnershipRecord> records)

Method Summary

Modifier and Type	Method	Description
long	getQueryID()	The query identifier.
Set<SessionOwnershipRecord>	getReadRecords()	Get the records obtained as a result of the retrieve query operation.
boolean	getReadSuccess()	Determine if the read was successful or not.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SessionOwnershipReadResultEvent

public SessionOwnershipReadResultEvent(long queryID,
                                       boolean successful,
                                       Set<SessionOwnershipRecord> records)

Method Detail

getQueryID

public long getQueryID()

The query identifier. This identifier equals that allocated and reported back to the SBB when the query was initiated.

Returns:

the query identifier.

Since:

Rhino 2.6.1

getReadSuccess

public boolean getReadSuccess()

Determine if the read was successful or not.

A read that returns no results is still considered a successful outcome to the query. A read is only unsuccessful if an error occurs trying to obtain a result for the query.

Returns:

true if the read was successful, false otherwise.

Since:

Rhino 2.6.1

getReadRecords

public Set<SessionOwnershipRecord> getReadRecords()

Get the records obtained as a result of the retrieve query operation.

Returns:

the read records. This may be an empty set if no records matching the query were found.

Since:

Rhino 2.6.1

toString

public String toString()

Overrides:

toString in class Object