Class TriggerDefinition

java.lang.Object
com.inet.taskplanner.server.api.common.AbstractDefinition<TriggerDefinition>
com.inet.taskplanner.server.api.trigger.TriggerDefinition

@JsonData public final class TriggerDefinition extends AbstractDefinition<TriggerDefinition>
Defines a configured trigger for a task with its settings. A trigger is responsible to initiate the execution of a task for example at a certain time or when an event occurs.

 TriggerDefinition ——extensionName—⟶ TriggerFactory —— TriggerFactory#createInstanceFrom(DEFINITION, GUID) createFrom()—⟶ Trigger * 

To map from a TriggerDefinition to a TriggerFactory the method AbstractDefinition.getExtensionName() has to return a name for which a TriggerFactory is registered in the ServerPluginManager.
This definition also includes settings for the trigger, i.e. for a time trigger the the start date and cycle. The extension name and the valid properties are usually defined and documented in the corresponding TriggerFactory.

It is recommended to use Builders to create TriggerDefinitions.

Since:
taskplanner 3.0
See Also: