Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client

Interface TableLoadListener

public interface TableLoadListener

Synchronously notified with each object as the table is being loaded. Implementations should execute quickly, so as to not slow down the table loading process. This is useful so that tasks may be completed during the transfer, which may yield more efficient and interactive environment.

Author:

AO Industries, Inc.

See Also:

AOServTable.addTableLoadListener(com.aoindustries.aoserv.client.TableLoadListener, java.lang.Object)

Method Summary

Modifier and Type	Method	Description
Object	onTableLoadCompleted(AOServTable<?,?> table, Object param)	Called when the table is completely loaded.
Object	onTableLoadFailed(AOServTable<?,?> table, Object param, Throwable cause)	Called when the table load has failed.
Object	onTableLoadRowCount(AOServTable<?,?> table, Object param, Long rowCount)	Called once the number of rows that will be loaded is known or known to be unknown.
Object	onTableLoadStarted(AOServTable<?,?> table, Object param)	Whenever an AOServTable is starting to be loaded, this is called with the parameter that was provided in the AOServTable.addTableLoadListener(com.aoindustries.aoserv.client.TableLoadListener, java.lang.Object) call.
Object	onTableRowLoaded(AOServTable<?,?> table, Object param, long rowNumber, AOServObject<?,?> object)	Called as each row is loaded.

Method Detail

onTableLoadStarted

Object onTableLoadStarted(AOServTable<?,?> table,
                          Object param)

Whenever an AOServTable is starting to be loaded, this is called with the parameter that was provided in the AOServTable.addTableLoadListener(com.aoindustries.aoserv.client.TableLoadListener, java.lang.Object) call.

The object returned is stored and will be the parameter provided in the next call.

onTableLoadRowCount

Object onTableLoadRowCount(AOServTable<?,?> table,
                           Object param,
                           Long rowCount)

Called once the number of rows that will be loaded is known or known to be unknown.

The number of rows is only known when a ProgressListener has been registered on the table. If the row count is required, also add a ProgressListener.

When a table load auto-retries on failure, this may be called more than once for a given onTableLoadStarted(com.aoindustries.aoserv.client.AOServTable, java.lang.Object). Each time, it indicates that the load is starting over.

The object returned is stored and will be the parameter provided in the next call.

See Also:

ProgressListener

onTableRowLoaded

Object onTableRowLoaded(AOServTable<?,?> table,
                        Object param,
                        long rowNumber,
                        AOServObject<?,?> object)

Called as each row is loaded.

The object returned is stored and will be the parameter provided in the next call.

Parameters:

rowNumber - The row number loaded, started at zero.

onTableLoadFailed

Object onTableLoadFailed(AOServTable<?,?> table,
                         Object param,
                         Throwable cause)

Called when the table load has failed.

The object returned is stored and will be the parameter provided in the next call.

onTableLoadCompleted

Object onTableLoadCompleted(AOServTable<?,?> table,
                            Object param)

Called when the table is completely loaded.

The object returned is stored and will be the parameter provided in the next call.