WebLogic Server 5.1.0 API Reference

weblogic.time.common
Interface ScheduledTriggerDef

public interface ScheduledTriggerDef

ScheduledTriggerDef objects are returned by the factory method TimeServicesDef.getScheduledTrigger(), and represent a scheduler-trigger pair. The ScheduledTrigger does not begin execution until the ScheduledTriggerDef.schedule() method is called. At a later point, the ScheduledTrigger can be deactivated by calling its cancel() method, or by returning zero (0) from its schedule() method. The schedule()method returns a unique number that can be used as a key for the scheduled trigger.

Author:

Copyright (c) 1996-97, WebLogic, Inc. All Rights Reserved., Copyright (c) 1999 by BEA WebXpress. All Rights Reserved.
Copyright © 2000 BEA Systems, Inc. All Rights Reserved.

See Also:

TimeServicesDef

Method Summary

boolean	cancel() Ends (recurring) execution of the schedule()-trigger() cycle.
boolean	isDaemon() Returns true, if the trigger is set to continue executing after the client has disconnected.
int	schedule() Begins (recurring) execution of the schedule()-trigger() cycle.
void	setDaemon(boolean isDaemon) If set to true, the trigger will continue executing after the client has disconnected.

Method Detail

schedule

public int schedule()
             throws TimeTriggerException

Begins (recurring) execution of the schedule()-trigger() cycle.

Returns:

Unique number that can be used as a key

Throws:

TimeTriggerException - if the cycle cannot be started

cancel

public boolean cancel()
               throws TimeTriggerException

Ends (recurring) execution of the schedule()-trigger() cycle.

Returns:

true if the cycle is stopped

Throws:

TimeTriggerException - if the trigger cannot be cancelled

setDaemon

public void setDaemon(boolean isDaemon)
               throws TimeTriggerException

If set to true, the trigger will continue executing after the client has disconnected. This is only valid for server-side triggers.

Throws:

TimeTriggerException - if the trigger has already been cancelled.

isDaemon

public boolean isDaemon()
                 throws TimeTriggerException

Returns true, if the trigger is set to continue executing after the client has disconnected. This is only valid for server-side triggers.

Throws:

TimeTriggerException - if the trigger has already been cancelled.