com.crystaldecisions.sdk.occa.infostore
Interface IEvents

All Superinterfaces:

java.util.Collection, java.lang.Iterable, java.util.List

public interface IEvents
extends java.util.List

Use this collection to schedule a job with events. When you schedule an object with events, the object will either be run when specific events occurs, or running the object may trigger other events upon completion. For example, you can schedule a report that, upon being processed, will result in other reports to be run. These other reports will run only when the event occurs. The events that an object waits for are called dependencies, and the events that an object triggers are called dependents.

Event types

You can tell an object to wait for any of, or all three supported event types:

• File-based - The object waits for a specified file to be detected by the event server before it is processed.
• Custom-based - The object waits for an event to be triggered manually (for example, by the administrator).
• Schedule-based - The object waits for a scheduled report to appear.

Whereas dependencies can be any of the supported event types, dependents can be only schedule-based events.

Scheduling a report with events

To schedule a job with events, you must first create an event with Event Plugin, and the event server must be enabled.

When you schedule a report that waits for a specified event, the report will run only when the event is triggered, and only when the rest of the schedule conditions are met. If the event is triggered before the start date of the report, the report will not run. If you have specified an end date for this report, and if the event is not triggered before the end date occurs, the report will not run, as not all of the conditions will have been met.

Note: An event can be triggered more than once, which means that if it is triggered before a report's start date, and the report does not run, it can be triggered again at a later date.

The get method inherited from ISDKList returns an Object that must be cast as an integer.

Remarks

The following example shows how to cast the returned Objects as an integer.

 for ( int i = 0; i < eventsObj.size(); i++ )
 {
        int eventID =  ((Integer)eventsObj.get( i )).intValue();
 }
 

See Also:

IEvent

Method Summary

void	add(int eventId) Adds an event to the collection.

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, size, subList, toArray, toArray

Method Detail

add

void add(int eventId)

Adds an event to the collection.

Parameters:

eventId - The event's ID.