org.apache.sling.event
Interface TimedEventStatusProvider


public interface TimedEventStatusProvider

This service provides the current timed events status.


Field Summary
static String PROPERTY_EVENT_ID
          This is a unique identifer which can be used to cancel the job.
 
Method Summary
 void cancelTimedEvent(String jobId)
          Cancel this timed event.
 org.osgi.service.event.Event getScheduledEvent(String topic, String eventId, String jobId)
          Return the scheduled event with the given id.
 Collection<org.osgi.service.event.Event> getScheduledEvents(String topic, Map<String,Object>... filterProps)
          Return a list of currently schedulded events.
 

Field Detail

PROPERTY_EVENT_ID

static final 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

Collection<org.osgi.service.event.Event> getScheduledEvents(String topic,
                                                            Map<String,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(String topic,
                                               String eventId,
                                               String jobId)
Return the scheduled event with the given id.

Returns:
The scheduled event or null.

cancelTimedEvent

void cancelTimedEvent(String jobId)
Cancel this timed event.

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


Copyright © 2007-2011 The Apache Software Foundation. All Rights Reserved.