public class ValidateOccurrenceEvent
extends java.util.EventObject
RecurrenceListener.validateOccurrence(com.mindfusion.scheduling.model.ValidateOccurrenceEvent)
event.Modifier and Type | Method and Description |
---|---|
boolean |
getIgnore()
Gets a value indicating whether this occurrence should be ignored in the pattern.
|
Item |
getItem()
Gets a reference to the occurrence being checked for validity.
|
int |
getRecurrenceIndex()
Gets the zero-based index of the occurrence being validated.
|
void |
setIgnore(boolean value)
Sets a value indicating whether this occurrence should be ignored in the pattern.
|
public Item getItem()
You can set various properties of this instance without fear that it will become recurrence exception. For example, you can modify the start and/or end time of the item in order to ensure that the item will not appear on weekend days.
Item
class specifying the occurrence
for which the event is raised.public int getRecurrenceIndex()
At the time the item is being validated, it is still not marked as occurrence and its
Item.getOccurrenceIndex()
property returns -1. Therefore you need to use this property
to obtain the actual recurrence index of the item. This is done to allow you to change any
of the item's properties without forcing it to become an exception.
public boolean getIgnore()
You can use this property to filter out occurrences of the pattern, which do not meet certain criteria. For example, you can remove all occurrences on weekend days.
public void setIgnore(boolean value)
You can use this property to filter out occurrences of the pattern, which do not meet certain criteria. For example, you can remove all occurrences on weekend days.
value
- true, to prevent this occurrence from appearing in the recurrence pattern;
otherwise, false. The default is false.