org.gecko.runtime.application

Interface ApplicationScheduler

All Known Implementing Classes:

GeckoApplicationContainer

public interface ApplicationScheduler

Interface to add scheduled applications

Since:

23.03.2018

Method Summary

Modifier and Type	Method and Description
ScheduledApplication	schedule(ApplicationDescriptor descriptor, java.lang.String scheduleId, java.util.Map<java.lang.String,java.lang.Object> arguments, java.lang.String topic, java.lang.String eventFilter, boolean recurring) Schedules an application
void	unschedule(java.lang.String scheduleId) Un-schedules an application for the schedule id

Method Detail

schedule

ScheduledApplication schedule(ApplicationDescriptor descriptor,
                              java.lang.String scheduleId,
                              java.util.Map<java.lang.String,java.lang.Object> arguments,
                              java.lang.String topic,
                              java.lang.String eventFilter,
                              boolean recurring)
                       throws InvalidSyntaxException,
                              ApplicationException

Schedules an application

Parameters:

descriptor - the application descriptor

scheduleId - the schedule id

arguments - the handle arguments

topic - the event trigger topic

eventFilter - the optional event filter

recurring - true, if the event occurs recurring on each event

Returns:

the ScheduledApplication instance

Throws:

InvalidSyntaxException

ApplicationException

unschedule

void unschedule(java.lang.String scheduleId)
         throws InvalidSyntaxException,
                ApplicationException

Un-schedules an application for the schedule id

Parameters:

scheduleId - the id of the application to be removed

Throws:

InvalidSyntaxException

ApplicationException