com.sencha.gxt.data.shared.loader.LoaderHandler Maven / Gradle / Ivy

Go to download
/**
 * Ext GWT 3.0.0-rc - Ext for GWT
 * Copyright(c) 2007-2011, Sencha, Inc.
 * [email protected]
 *
 * http://sencha.com/license
 */
package com.sencha.gxt.data.shared.loader;

import com.google.gwt.event.shared.HandlerRegistration;
import com.sencha.gxt.data.shared.loader.BeforeLoadEvent.BeforeLoadHandler;
import com.sencha.gxt.data.shared.loader.BeforeLoadEvent.HasBeforeLoadHandlers;
import com.sencha.gxt.data.shared.loader.LoadExceptionEvent.HasLoadExceptionHandlers;
import com.sencha.gxt.data.shared.loader.LoadExceptionEvent.LoadExceptionHandler;

/**
 * Aggregating handler interface for:
 * 
 * 
 * {@link BeforeLoadEvent}
 * {@link LoadExceptionEvent}
 * {@link LoadEvent}
 * 
 * 
 * @param  the type of config to request the data
 * @param  the type of data to be loaded
 */
public interface LoaderHandler extends BeforeLoadHandler, LoadExceptionHandler, LoadHandler {

  /**
   * A loader that implements this interface is a public source of all
   * {@link Loader} events, {@link BeforeLoadEvent}, {@link LoadEvent}, and
   * {@link LoadExceptionEvent}.
   * 
   * @param  the type of config to request the data
   * @param  the type of data to be loaded
   */
  public interface HasLoaderHandlers extends HasLoadHandlers, HasLoadExceptionHandlers,
      HasBeforeLoadHandlers {

    /**
     * Adds a {@link LoadEvent} handler.
     * 
     * @param handler the handler
     * @return the registration for the event
     */
    public HandlerRegistration addLoaderHandler(LoaderHandler handler);
  }
}