FileDocCategorySizeDatePackage
TimerLocal.javaAPI DocGlassfish v2 API3965Fri May 04 22:32:58 BST 2007com.sun.ejb.containers

TimerLocal

public interface TimerLocal implements javax.ejb.EJBLocalObject
Local view of the persistent representation of an EJB timer.
author
Kenneth Saks

Fields Summary
Constructors Summary
Methods Summary
public voidcancel()
Cancel timer.

public longgetContainerId()
ejb container corresponding to timed object that created timer.

public java.util.DategetCreationTime()
When timer was created. Informational only.

public java.io.SerializablegetInfo()
Application info associated with timer. Can be null.

public java.util.DategetInitialExpiration()
Time of first timer expiration.

public longgetIntervalDuration()
For periodic timers, number of milli-seconds between timeouts. 0 for single-action timers.

public java.util.DategetLastExpiration()
This is the last time that a timer expiration completed successfully or null if this field has not been set.

public java.lang.StringgetOwnerId()
Id of server instance that owns timer.

public java.lang.ObjectgetTimedObjectPrimaryKey()
Holds primary key for entity timed object. Null otherwise.

public booleanisActive()
Check if timer is in an active state.

public booleanisCancelled()
Check if timer is in a cancelled state.

public booleanrepeats()
True if interval timer. False if single-action timer.

public voidsetLastExpiration(java.util.Date lastExpiration)
This is the last time that a timer expiration completed successfully or null to clear this value.

public voidsetOwnerId(java.lang.String ownerId)
Changes timer owner. Typically done during timer migration.