com.prosyst.mprm.backend.event.scheduler

Interface EventSchedulerService

public interface EventSchedulerService

Service interface intended for event generator objects. It provides methods for sending scheduled sequence of events to registered event listeners. The events may repeated at regular or inregular time intervals. Event listeners can reside on any mPRM Backend Host or on external applications connected through mPRM Remote Access Client.

Since:

26/11/2002

Version:

1.0

Author:

Alexander Alexandrov

Method Summary

Modifier and Type	Method and Description
EventGenerator	createEventGenerator(java.lang.String id, java.lang.String eventType) Creates an event generator which will be resposnible for generating a single event or a sequence of events of the supplied type on a defined time basis.
void	discardEventGenerator(java.lang.String id) Removes an event generator from the Event Scheduler service.
Enumerator	enumerateEventGenerators() Enumerates all currently active event generators
EventGenerator	getEventGenerator(java.lang.String id) If the id is not null it returns the event generator with the supplied id if such exists in the database.

Method Detail

createEventGenerator

EventGenerator createEventGenerator(java.lang.String id,
                                    java.lang.String eventType)
                             throws ManagementException

Creates an event generator which will be resposnible for generating a single event or a sequence of events of the supplied type on a defined time basis. Additional parameters specifying the behaviour of the time generator must be adjusted using some of the methods of the returned instance. Activation of the generator is done throught its start() method.

Parameters:

id - identifier of this event generator. The identifier must be unique and it is responsibility of the application to ensure its uniqueness. For avoiding id collisions it is recommended to prefix the event identifier with the string following java package naming convention. Build-in mPRM modules use identifiers prefixed with "mprm.".

eventType - type of the generated by this EventGenerator events.

Returns:

an empty instance of the default event generator implementation

Throws:

ManagementException - if an error occurs while creating generator

getEventGenerator

EventGenerator getEventGenerator(java.lang.String id)
                          throws ManagementException

If the id is not null it returns the event generator with the supplied id if such exists in the database. If the id is null the method returns this event generator will produce the next event first.

Parameters:

id - the id of the event generator.

Returns:

an event generator which fullfils the specified requirements.

Throws:

ManagementException - if an error occurs while constructing the result.

enumerateEventGenerators

Enumerator enumerateEventGenerators()
                             throws ManagementException

Enumerates all currently active event generators

Returns:

an Enumerator containing all currently active event generators

Throws:

ManagementException - if an error occurs while constructing the result.

discardEventGenerator

void discardEventGenerator(java.lang.String id)
                    throws ManagementException

Removes an event generator from the Event Scheduler service.

Parameters:

id - the id of the event generator to be discarded

Throws:

ManagementException - if an error occurs while discarding event generator