com.flexive.shared.interfaces
Interface FxTimerService

All Known Subinterfaces:
FxTimerServiceLocal

public interface FxTimerService

Timer- and scheduling service based on Quartz

Author:
Markus Plesser (markus.plesser@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at)

Method Summary
 boolean deleteScriptSchedule(FxScriptSchedule scriptSchedule)
          Delete a script schedule
 boolean install(boolean reinstall)
          Installs the timer service
 boolean isInstalled()
          Check if the timer service is installed
 void maintenance()
          perform maintenance
 void parseCronString(java.lang.String cronString)
          Parses a Cron String and throws an exception if it cannot be parsed
 void scheduleScript(FxScriptSchedule scriptSchedule)
          Schedule a script
 void uninstall()
          Uninstalls the timer service
 void updateScriptSchedule(FxScriptSchedule scriptSchedule)
          Update a scheduled script
 

Method Detail

install

boolean install(boolean reinstall)
Installs the timer service

Parameters:
reinstall - reinstall the timer if it is already installed?
Returns:
if successful (should only fail in early versions of embedded containers!)

uninstall

void uninstall()
Uninstalls the timer service


isInstalled

boolean isInstalled()
Check if the timer service is installed

Returns:
true if timer service is installed

maintenance

void maintenance()
perform maintenance


scheduleScript

void scheduleScript(FxScriptSchedule scriptSchedule)
                    throws FxApplicationException
Schedule a script

Parameters:
scriptSchedule - script schedule
Throws:
FxApplicationException - on errors
Since:
3.1.2

updateScriptSchedule

void updateScriptSchedule(FxScriptSchedule scriptSchedule)
                          throws FxApplicationException
Update a scheduled script

Parameters:
scriptSchedule - script schedule
Throws:
FxApplicationException - on errors
Since:
3.1.2

deleteScriptSchedule

boolean deleteScriptSchedule(FxScriptSchedule scriptSchedule)
                             throws FxApplicationException
Delete a script schedule

Parameters:
scriptSchedule - script schedule
Returns:
true if script schedule was found and could be deleted
Throws:
FxApplicationException - on errors
Since:
3.1.2

parseCronString

void parseCronString(java.lang.String cronString)
                     throws FxInvalidParameterException
Parses a Cron String and throws an exception if it cannot be parsed

Parameters:
cronString - Cron String
Throws:
FxInvalidParameterException - on errors
Since:
3.1.2