Class DynamicEntityChangedInfo
DynamicEntity
sent by DynamicEntity.DynamicEntityChangedEvent
.
An object of this type is sent as an argument to the DynamicEntity.DynamicEntityChangedEvent
. This event is
raised whenever observations associated with an existing dynamic entity are received from the data source or purged
from the local data cache.
If the last observation has been purged from the local data cache, the dynamicEntityPurgedProperty()
property is set to true. This indicates that the dynamic entity has been purged and will receive no more associated
observations from the data source.
- Since:
- 200.1.0
-
Property Summary
TypePropertyDescriptionIndicates whether theDynamicEntity
itself has been purged.The purgedDynamicEntityObservation
.The newly receivedDynamicEntityObservation
. -
Method Summary
Modifier and TypeMethodDescriptionIndicates whether theDynamicEntity
itself has been purged.Gets the value of thepurgedObservation
property.Gets the value of thereceivedObservation
property.boolean
Gets the value of thedynamicEntityPurged
property.The purgedDynamicEntityObservation
.The newly receivedDynamicEntityObservation
.
-
Property Details
-
dynamicEntityPurged
Indicates whether theDynamicEntity
itself has been purged.This flag is set when the last observation associated with this dynamic entity has been purged from the local data cache. In this case, the dynamic entity is also purged and will not be associated with any new observations received from the data source.
Purge of a dynamic entity can be caused by exceeding the limits defined by
DynamicEntityDataSource.purgeOptionsProperty()
or by an explicit call toDynamicEntityDataSource.purgeAllAsync()
.The default is false.
- Since:
- 200.1.0
- See Also:
-
purgedObservation
The purgedDynamicEntityObservation
.If an observation associated with this dynamic entity was purged, this property contains the purged
DynamicEntityObservation
.The default is null, meaning no observation associated with this dynamic entity was purged.
When a call to
DynamicEntityDataSource.purgeAllAsync()
causes multiple observations for a dynamic entity to be purged, this property is set to the last purged observation of this dynamic entity anddynamicEntityPurgedProperty()
is set to true.- Since:
- 200.1.0
- See Also:
-
receivedObservation
The newly receivedDynamicEntityObservation
.When an observation associated with this dynamic entity is received from the data source, this property contains the received observation.
The default is null, meaning no observation associated with this dynamic entity was received.
- Since:
- 200.1.0
- See Also:
-
-
Method Details
-
dynamicEntityPurgedProperty
Indicates whether theDynamicEntity
itself has been purged.This flag is set when the last observation associated with this dynamic entity has been purged from the local data cache. In this case, the dynamic entity is also purged and will not be associated with any new observations received from the data source.
Purge of a dynamic entity can be caused by exceeding the limits defined by
DynamicEntityDataSource.purgeOptionsProperty()
or by an explicit call toDynamicEntityDataSource.purgeAllAsync()
.The default is false.
- Returns:
- the
dynamicEntityPurged
property - Since:
- 200.1.0
- See Also:
-
isDynamicEntityPurged
public boolean isDynamicEntityPurged()Gets the value of thedynamicEntityPurged
property.- Property description:
- Indicates whether the
DynamicEntity
itself has been purged.This flag is set when the last observation associated with this dynamic entity has been purged from the local data cache. In this case, the dynamic entity is also purged and will not be associated with any new observations received from the data source.
Purge of a dynamic entity can be caused by exceeding the limits defined by
DynamicEntityDataSource.purgeOptionsProperty()
or by an explicit call toDynamicEntityDataSource.purgeAllAsync()
.The default is false.
- Returns:
- the value of the
dynamicEntityPurged
property - Since:
- 200.1.0
- See Also:
-
purgedObservationProperty
The purgedDynamicEntityObservation
.If an observation associated with this dynamic entity was purged, this property contains the purged
DynamicEntityObservation
.The default is null, meaning no observation associated with this dynamic entity was purged.
When a call to
DynamicEntityDataSource.purgeAllAsync()
causes multiple observations for a dynamic entity to be purged, this property is set to the last purged observation of this dynamic entity anddynamicEntityPurgedProperty()
is set to true.- Returns:
- the
purgedObservation
property - Since:
- 200.1.0
- See Also:
-
getPurgedObservation
Gets the value of thepurgedObservation
property.- Property description:
- The purged
DynamicEntityObservation
.If an observation associated with this dynamic entity was purged, this property contains the purged
DynamicEntityObservation
.The default is null, meaning no observation associated with this dynamic entity was purged.
When a call to
DynamicEntityDataSource.purgeAllAsync()
causes multiple observations for a dynamic entity to be purged, this property is set to the last purged observation of this dynamic entity anddynamicEntityPurgedProperty()
is set to true. - Returns:
- the value of the
purgedObservation
property - Since:
- 200.1.0
- See Also:
-
receivedObservationProperty
The newly receivedDynamicEntityObservation
.When an observation associated with this dynamic entity is received from the data source, this property contains the received observation.
The default is null, meaning no observation associated with this dynamic entity was received.
- Returns:
- the
receivedObservation
property - Since:
- 200.1.0
- See Also:
-
getReceivedObservation
Gets the value of thereceivedObservation
property.- Property description:
- The newly received
DynamicEntityObservation
.When an observation associated with this dynamic entity is received from the data source, this property contains the received observation.
The default is null, meaning no observation associated with this dynamic entity was received.
- Returns:
- the value of the
receivedObservation
property - Since:
- 200.1.0
- See Also:
-