com.scalagent.scheduler.event.DiaryEvent Interface Reference

Inherited by com.scalagent.scheduler.event.BasedDiaryEvent, and com.scalagent.scheduler.event.PeriodicEvent.

Inheritance diagram for com.scalagent.scheduler.event.DiaryEvent:

[legend]List of all members.

Public Member Functions
long	getNextDate (long now, boolean inclusive)
long	getNextDate (long now)
long	getLastDate (long now, boolean inclusive)
long	getLastDate (long now)

---

Detailed Description

The DiaryEvent interface allows access to the occurrence dates of an event that could be stored in a diary.

Definition at line 28 of file DiaryEvent.java.

---

Member Function Documentation

long com.scalagent.scheduler.event.DiaryEvent.getNextDate	(	long	now,
		boolean	inclusive
	)

Gets the next event date after the parameter date. Returns -1 if there is no such date.

Parameters:

	now	starting date for the lookup
	inclusive	if true checks now as an answer

Returns:

the next event date after now, -1 if there is no such date

Implemented in com.scalagent.scheduler.event.PeriodicEvent.

long com.scalagent.scheduler.event.DiaryEvent.getNextDate

(

long

now

)

Gets the next event date after the parameter date. Returns -1 if there is no such date. Calls getNextDate with the inclusive parameter set to false.

Parameters:

now

starting date for the lookup

Returns:

the next event date after now, -1 if there is no such date

Implemented in com.scalagent.scheduler.event.PeriodicEvent.

long com.scalagent.scheduler.event.DiaryEvent.getLastDate	(	long	now,
		boolean	inclusive
	)

Gets the last event date before the parameter date. Returns -1 if there is no such date.

Parameters:

	now	starting date for the backward lookup
	inclusive	if true checks now as an answer

Returns:

the last event date before now, -1 if there is no such date

Implemented in com.scalagent.scheduler.event.PeriodicEvent.

long com.scalagent.scheduler.event.DiaryEvent.getLastDate

(

long

now

)

Gets the last event date before the parameter date. Returns -1 if there is no such date. Calls getLastDate with the inclusive parameter set to false.

Parameters:

now

starting date for the backward lookup

Returns:

the last event date before now, -1 if there is no such date

Implemented in com.scalagent.scheduler.event.PeriodicEvent.

---

The documentation for this interface was generated from the following file:

• com/scalagent/scheduler/event/DiaryEvent.java

---