it.list.jft.event
Interface SubscriptionStartEvent

All Superinterfaces:
Event, SubscriptionEvent

public interface SubscriptionStartEvent
extends SubscriptionEvent

Server-answer to Subscription.start().

This event must be handled by SubscriptionListener.onSubscriptionStart().


Field Summary
 
Fields inherited from interface Event
RESULT_GENERIC_ERROR, RESULT_OK
 
Method Summary
 int getEntityClassVersionOnServer()
          Returns the version of EntityClass on the server.
 boolean isEntityClassReset()
          Returns a reset-class indication.
 
Methods inherited from interface SubscriptionEvent
getSubscription
 
Methods inherited from interface Event
getResult
 

Method Detail

isEntityClassReset

boolean isEntityClassReset()
Returns a reset-class indication.

A true indicates that the required EntityClass version is different from the server EntityClass version. In this case the historical data that will be available into the next SubscriptionNotifyEvents are complete and not (as usual) restricted to data following a given timestamp.

This method must be called only when the result is Event.RESULT_OK.

Returns:
the indication whether a download is needed on all the entities.
false is returned when the result is not Event.RESULT_OK.

getEntityClassVersionOnServer

int getEntityClassVersionOnServer()
Returns the version of EntityClass on the server.

The returned value may be different from the version requested into the Subscription parameter. In this case isEntityClassReset() returns true.

This method must be called only when the server result is Event.RESULT_OK.

Returns:
the version of EntityClass on the server.
-1 is returned when the result is not Event.RESULT_OK.
See Also:
isEntityClassReset()


Submit a bug or feature to FT\API Programming Support<\font>