willRebuildTable() method

This method is called by the Agentry server to determine whether the server should rebuild the client's complex table from scratch.

Syntax

public boolean willRebuildTable () throws AgentryException

Returns

true if the client's table should be rebuilt from scratch, or false if the client's existing table should be updated.

Exceptions

Usage

If you return true from this method, then a subsequent call to dataIterator() should return the full set of complex table records and deleteIterator() should return nothing; if you return false from this method then dataIterator() and deleteIterator() should return incremental changes.

Note that if the client's last data update date was invalid, then the Agentry Server will assume that the table needs to be reloaded and will not call this method at all.

When the Agentry server calls this method, it will store the result of the call into the _rebuilding field. That field will also be initialized by the constructor to true if _clientLastDataUpdateTime is invalid or false if it is not, so that the field will contain the correct value even if the Agentry server does not call this method.

The default implementation of this method returns the value of _rebuilding as set by the constructor.