Development Actions

Actions are called by the JobRunner and implemented as Strategy in Strategy Pattern. Each Action must inherit and implement the abstract class Action. There are three main methods:

getParamsDescription()

Must return an JsonArray with information objects for each possible parameter that can be stored in the datajobs_params table.

setParams(JsonObject params)

Gets the parameters read from the database and is called when the job is initialised. Initialisation is done when the user starts the job. Once running (even when paused and repeated) configuration can't be changed. To activate a new configuration, stop the job and restart it.

JsonObject call()

This is the jobs main method. Implement here all the actions that should be performed and repeated. Each execution must return one result dataset in form of an JsonObject. You can use as many attributes in result as you wish. Most common used are the "state" and "statemsg" attributes. "state" for a one word state description (e.g. finished, stopped, error, ...) and "statemsg" for a message. Each result will be stored in the datajobs_log table.