java/src/main/com/google/appengine/api/taskqueue/DeferredTask.java

   1 // Copyright 2011 Google Inc. All Rights Reserved.
   2 package com.google.appengine.api.taskqueue;
   3
   4 import java.io.Serializable;
   5
   6 /**
   7  * Interface for deferred tasks. Classes implementing this interface may use
   8  * {@link TaskOptions#payload(DeferredTask)} to serialize the {@link DeferredTask}
   9  * into the payload of the task definition. The {@link DeferredTask#run()}
  10  * method will be called when the task is received by the built in DeferredTask
  11  * servlet.
  12  *
  13  * <p>Normal return from this method is considered success. Exceptions thrown
  14  * from this method will indicate failure and will be processed as
  15  * a retry attempt unless {@link DeferredTaskContext#setDoNotRetry(boolean)}
  16  * is called to avoid the retry processing.
  17  *
  18  */
  19 public interface DeferredTask extends Runnable, Serializable {
  20 }