org.apache.sling.event
Interface TimedEventStatusProvider

public interface TimedEventStatusProvider

This service provides the current timed events status.

Field Summary

static java.lang.String

PROPERTY_EVENT_ID This is a unique identifer which can be used to cancel the job.

Method Summary

void	cancelTimedEvent(java.lang.String jobId) Cancel this timed event.
org.osgi.service.event.Event	getScheduledEvent(java.lang.String topic, java.lang.String eventId, java.lang.String jobId) Return the scheduled event with the given id.
java.util.Collection<org.osgi.service.event.Event>	getScheduledEvents(java.lang.String topic, java.util.Map<java.lang.String,java.lang.Object>... filterProps) Return a list of currently schedulded events.

Field Detail

PROPERTY_EVENT_ID

static final java.lang.String PROPERTY_EVENT_ID

This is a unique identifer which can be used to cancel the job.

See Also:

Constant Field Values

Method Detail

getScheduledEvents

java.util.Collection<org.osgi.service.event.Event> getScheduledEvents(java.lang.String topic,
                                                                      java.util.Map<java.lang.String,java.lang.Object>... filterProps)

Return a list of currently schedulded events.

Parameters:

topic - Topic can be used as a filter, if it is non-null, only jobs with this topic will be returned.

filterProps - A list of filter property maps. Each map acts like a template. The searched event must match the template (AND query). By providing several maps, different filters are possible (OR query).

Returns:

A non null collection.

getScheduledEvent

org.osgi.service.event.Event getScheduledEvent(java.lang.String topic,
                                               java.lang.String eventId,
                                               java.lang.String jobId)

Return the scheduled event with the given id.

Returns:

The scheduled event or null.

cancelTimedEvent

void cancelTimedEvent(java.lang.String jobId)

Cancel this timed event.

Parameters:

jobId - The unique identifer as found in the property PROPERTY_EVENT_ID.