Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client

Interface ProgressListener

public interface ProgressListener

Synchronously notified of table loading progress. Implementations should execute quickly, so as to not slow down the table loading process.

Please note that registering a progress listener can increase the server-side overhead, as in some implementations the result sets must be traversed twice: once to count rows then once to return them.

Author:

AO Industries, Inc.

See Also:

AOServTable.addProgressListener(com.aoindustries.aoserv.client.ProgressListener)

Method Summary

Modifier and Type	Method	Description
int	getScale()	Gets the scale of the progress returned.
void	onProgressChanged(AOServTable<?,?> table, int position, int scale)	The progress is rounded off to the scale provided by getScale.

Method Detail

getScale

int getScale()

Gets the scale of the progress returned. The progress values will be from zero to this number, inclusive.

onProgressChanged

void onProgressChanged(AOServTable<?,?> table,
                       int position,
                       int scale)

The progress is rounded off to the scale provided by getScale. Whenever the rounded-off value changes, this method is called.

When a table load fails and auto-retries, this progress may start back at zero again.