Package com.inductiveautomation.ignition.gateway.tasks

Class TaskStatusEvent

java.lang.Object

com.inductiveautomation.ignition.gateway.tasks.TaskStatusEvent

All Implemented Interfaces:

Serializable

public class TaskStatusEvent
extends Object
implements Serializable

A TaskStatusEvent is an event during the task execution that will be displayed for history status.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TaskStatusEvent.Level

Constructor Summary

Constructors

Constructor	Description
TaskStatusEvent()
TaskStatusEvent(String taskName, String target, String message, String details, TaskStatusEvent.Level level)
TaskStatusEvent(String taskName, Date timestamp, String target, TaskStatusEvent.Level level, String message, String detail, String taskType)

Method Summary

Modifier and Type	Method	Description
String	getDetail()
TaskStatusEvent.Level	getLevel()
String	getMessage()
String	getTarget()
String	getTaskName()
Date	getTaskStart()
String	getTaskType()
Date	getTimestamp()
void	setDetail(String detail)
void	setLevel(TaskStatusEvent.Level level)
void	setMessage(String message)
void	setTarget(String target)
void	setTaskName(String taskName)
void	setTaskStart(Date taskStart)
void	setTaskType(String taskType)
void	setTimestamp(Date timestamp)

Methods inherited from class java.lang.Object

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

Constructor Details

TaskStatusEvent

public TaskStatusEvent()

TaskStatusEvent

public TaskStatusEvent(String taskName,
 String target,
 String message,
 String details,
 TaskStatusEvent.Level level)

TaskStatusEvent

public TaskStatusEvent(String taskName,
 Date timestamp,
 String target,
 TaskStatusEvent.Level level,
 String message,
 String detail,
 String taskType)

Method Details

getTaskName

public String getTaskName()

setTaskName

public void setTaskName(String taskName)

getTimestamp

public Date getTimestamp()

Returns:

a timestamp of when the task completed with either success or failure

setTimestamp

public void setTimestamp(Date timestamp)

getTarget

public String getTarget()

setTarget

public void setTarget(String target)

getLevel

public TaskStatusEvent.Level getLevel()

setLevel

public void setLevel(TaskStatusEvent.Level level)

getMessage

public String getMessage()

setMessage

public void setMessage(String message)

getDetail

public String getDetail()

setDetail

public void setDetail(String detail)

getTaskType

public String getTaskType()

setTaskType

public void setTaskType(String taskType)

setTaskStart

public void setTaskStart(Date taskStart)

getTaskStart

@NotNull
public Date getTaskStart()

Returns:

the timestamp at which the overall task started