com.sun.sgs.app
Interface PeriodicTaskHandle


public interface PeriodicTaskHandle

Provides facilities for managing a Task scheduled with the TaskManager to run periodically. Classes that implement PeriodicTaskHandle must also implement Serializable.

See Also:
TaskManager.schedulePeriodicTask

Method Summary
 void cancel()
          Cancels attempts to run the associated task in future periods.
 

Method Detail

cancel

void cancel()
Cancels attempts to run the associated task in future periods. Calling this method has no effect on runs of the task for the current period if an attempt to run the task for that period has already begun. Cancelling a periodic task may involve removing an associated managed object maintained internally by the TaskManager. The system will make an effort to flag subsequent references to the removed object by throwing ObjectNotFoundException when this method is called, although that behavior is not guaranteed.

Throws:
ObjectNotFoundException - if the task has already been cancelled and removed
TransactionException - if the operation failed because of a problem with the current transaction

Project Darkstar, Version 0.9.9.6
2009-05-08 15:39:40

Copyright © 2007-2009 Sun Microsystems, Inc. All rights reserved