getEffectiveDate()

Retrieves the effective date from the event object.

Syntax

public Date getEffectiveDate();
 

Return values

A Date object containing the event's effective date, which is the date on which the event becomes active and should be processed.

Exceptions

AttributeNullValueException
Thrown if the event's effective date is null.

Notes

An effective date is useful when your event detection mechanism handles future-event processing; that is, it stores events that must be processed at some particular point in the future. The effective date indicates when the event should be processed.

Copyright IBM Corp. 1997, 2004