com.lightstreamer.javameclient.midp

Interface SimpleItemUpdate

All Known Subinterfaces:

ExtendedItemUpdate

public interface SimpleItemUpdate

Carries any update pertaining to an item. Changed and unchanged values are distinguished.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFieldNewValue(int numField) Inquiry method that gets the new value for a specified field, as received from the Server with the current update or SimpleTableListener.UNCHANGED if the field is not changed.
int	getNumFields() Inquiry method that gets the number of fields received from the Server with the current update.
boolean	isFieldChanged(int numField) Inquiry method that asks whether the value for a field is changed after the reception of an update from the Server for an item.
boolean	isReusable() Asks whether or not the object may be reused by LSClient.

Method Detail

isReusable

boolean isReusable()

Asks whether or not the object may be reused by LSClient. If the object may be reused, it should not be stored by the application; otherwise, it can be freely stored by the application.
The LSClient instance may reuse the object only if allowed through LSClient.useReusableItemUpdates(boolean)

Returns:

true if the object may be reused by LSClient; false otherwise.

getNumFields

int getNumFields()

Inquiry method that gets the number of fields received from the Server with the current update. The value, however, is the same across all updates pertaining to the same item, because it is determined by the schema associated to the item at subscription time. The fields received from the Server are always associated to consecutive field numbers starting from 1.

Returns:

The number of fields received from the Server.

getFieldNewValue

java.lang.String getFieldNewValue(int numField)

Inquiry method that gets the new value for a specified field, as received from the Server with the current update or SimpleTableListener.UNCHANGED if the field is not changed.

Parameters:

numField - 1-based index of the field.

Returns:

SimpleTableListener.UNCHANGED if the value is unchanged, the received value otherwise.

isFieldChanged

boolean isFieldChanged(int numField)

Inquiry method that asks whether the value for a field is changed after the reception of an update from the Server for an item.

Parameters:

numField - 1-based index of the field.

Returns:

true if the value is changed; false otherwise.