co.easimart.GetCallback Maven / Gradle / Ivy

Go to download
package co.easimart;

/**
 * A {@code GetCallback} is used to run code after a {@link EasimartQuery} is used to fetch a
 * {@link EasimartObject} in a background thread.
 * 
 * The easiest way to use a {@code GetCallback} is through an anonymous inner class. Override the
 * {@code done} function to specify what the callback should do after the fetch is complete.
 * The {@code done} function will be run in the UI thread, while the fetch happens in a
 * background thread. This ensures that the UI does not freeze while the fetch happens.
 * 

 * For example, this sample code fetches an object of class {@code "MyClass"} and id
 * {@code myId}. It calls a different function depending on whether the fetch succeeded or not.
 * 

 * 
 * EasimartQuery<EasimartObject> query = EasimartQuery.getQuery("MyClass");
 * query.getInBackground(myId, new GetCallback<EasimartObject>() {
 *   public void done(EasimartObject object, EasimartException e) {
 *     if (e == null) {
 *       objectWasRetrievedSuccessfully(object);
 *     } else {
 *       objectRetrievalFailed();
 *     }
 *   }
 * });
 * 
 */
public interface GetCallback extends EasimartCallback2 {
  /**
   * Override this function with the code you want to run after the fetch is complete.
   * 
   * @param object
   *          The object that was retrieved, or {@code null} if it did not succeed.
   * @param e
   *          The exception raised by the fetch, or {@code null} if it succeeded.
   */
  @Override
  public void done(T object, EasimartException e);
}