Package com.inductiveautomation.ignition.gateway.tasks

Class TaskSettings

java.lang.Object

com.inductiveautomation.ignition.gateway.tasks.TaskSettings

public class TaskSettings
extends java.lang.Object

This class wraps ups the settings of a gateway task. It is made as a convenience class for programmatically creating new tasks.

Method Summary

Modifier and Type	Method	Description
static TaskSettings	createNew(GatewayContext context, java.lang.String ownerId, java.lang.String typeId)
GatewayTaskRecord	getTaskRecord()
<T extends PersistentRecord> T	getTaskSettingsRecord()
void	save()
void	setScheduleAtTime(java.util.Date targetDate)
void	setScheduleCron(java.lang.String pattern)
void	setScheduleRunAfterDelay(long delayMS)
void	setScheduleRunImmediately()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createNew

public static TaskSettings createNew(GatewayContext context,
                                     java.lang.String ownerId,
                                     java.lang.String typeId)

getTaskRecord

public GatewayTaskRecord getTaskRecord()

getTaskSettingsRecord

public <T extends PersistentRecord> T getTaskSettingsRecord()

setScheduleRunImmediately

public void setScheduleRunImmediately()

setScheduleRunAfterDelay

public void setScheduleRunAfterDelay(long delayMS)

setScheduleAtTime

public void setScheduleAtTime(java.util.Date targetDate)

setScheduleCron

public void setScheduleCron(java.lang.String pattern)

save

public void save()
          throws java.lang.Exception

Throws:

java.lang.Exception