com.sap.scheduler.api

Class Scheduler.FireTimeEvent

java.lang.Object
  com.sap.scheduler.api.Scheduler.FireTimeEvent

All Implemented Interfaces:

Serializable

Enclosing interface:

Scheduler

public static class Scheduler.FireTimeEvent
extends Object
implements Serializable

Instances of this class specify a particular expiration of a given scheduler task. An object of the FireTimeEvent class contains the scheduler task id and the time at which the expiration should deliver. For a feature expirations this may not be the exact moment as objects of this class represented a computed time, which may not be exactly the moment of actual expiration.

Note: Filtered events are also returned with the filtered field set to true. Those instances will not be executed.

See Also:

Serialized Form

Field Summary

boolean	filtered Indicates whether the current set of filters has filtered this expiration out.
SchedulerTaskID	taskId The id of the task whose particular expiration is represented by this object.
SchedulerTime	time Time of the particular expiration represented by this object.

Constructor Summary

Scheduler.FireTimeEvent(SchedulerTaskID taskId, SchedulerTime time)
Constructs a new FireTimeEvent instance to represent an expiration of the given scheduler task at the given time.

Scheduler.FireTimeEvent(SchedulerTaskID taskId, SchedulerTime time, boolean filtered)
Constructs a new FireTimeEvent instance to represent an expiration of the given scheduler task at the given time.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

taskId

public final SchedulerTaskID taskId

The id of the task whose particular expiration is represented by this object.

time

public final SchedulerTime time

Time of the particular expiration represented by this object.

filtered

public final boolean filtered

Indicates whether the current set of filters has filtered this expiration out. True if this expiration has been filtered, false otherwise.

Constructor Detail

Scheduler.FireTimeEvent

public Scheduler.FireTimeEvent(SchedulerTaskID taskId,
                               SchedulerTime time,
                               boolean filtered)

Constructs a new FireTimeEvent instance to represent an expiration of the given scheduler task at the given time.

Note: This constructor is only used internally.

Parameters:

taskId - id of the task whose particular expiration is represented by this object

time - time of this expiration

filtered - sets the filtered attribute of this task. If true than a consumer of this task may assume that the current set of filters of this task has filtered this particular expiration out.

Scheduler.FireTimeEvent

public Scheduler.FireTimeEvent(SchedulerTaskID taskId,
                               SchedulerTime time)

Constructs a new FireTimeEvent instance to represent an expiration of the given scheduler task at the given time.

Note: This constructor is only used internally.

Parameters:

taskId - id of the task whose particular expiration is represented by this object

time - time of this expiration

Access Rights

This class can be accessed from:

SC	DC
[sap.com] ENGFACADE	[sap.com] tc/je/scheduler/api