com.inductiveautomation.ignition.gateway.tasks

Interface TaskType

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

AbstractTaskType

public interface TaskType
extends java.io.Serializable

Defines a type of gateway task that can be defined and executed.

Method Summary

Modifier and Type	Method and Description
void	buildWizardModel(org.apache.wicket.extensions.wizard.WizardModel model, org.apache.wicket.model.IModel<? extends java.util.List<? extends PersistentRecord>> dataModel) Returns a new wizard that can be used to configure the task settings.
boolean	canCancel() Returns whether or not the task can be canceled.
boolean	canSuspend() Returns whether or not the task supports suspending and resuming.
Task	createInstance(GatewayContext context, GatewayTaskRecord gatewayRecord)
default java.lang.String	fullId() Returns a combo of the ownerId and typeId that uniquely identifies this task type.
java.lang.String	getBaseBundleKey() Returns a base Bundle key for this type.
LocalizedString	getOwnerName() Shortcut for baseBundleKey.Owner
ReferenceField<GatewayTaskRecord>	getSettingsRecordForeignKey() If a settings record type is defined, return the foreign key field that references the main record type
RecordMeta<? extends PersistentRecord>	getSettingsRecordType() Returns the record meta of the settings record for this type of task.
LocalizedString	getTypeName() Shortcut for baseBundleKey.typeId.Name
boolean	isPrivate() A private task type is one that cannot be created from the general task management system.
java.lang.String	ownerId() Tasks are organized by owner, and can be displayed for selection based on owner.
java.lang.String	typeId() A name/id for the task type that identifies it relative to the owner.

Method Detail

ownerId

java.lang.String ownerId()

Tasks are organized by owner, and can be displayed for selection based on owner. This string is a constant that is used to group tasks from the same owner.

typeId

java.lang.String typeId()

A name/id for the task type that identifies it relative to the owner. The combination of "ownerid" and "typeid" are used to identify particular tasks.

fullId

default java.lang.String fullId()

Returns a combo of the ownerId and typeId that uniquely identifies this task type.

isPrivate

boolean isPrivate()

A private task type is one that cannot be created from the general task management system. It is either created programmatically, or from a system specific management screen.

getBaseBundleKey

java.lang.String getBaseBundleKey()

Returns a base Bundle key for this type. "Base" means that the task specific keys are under "base.typeid". Overall, the following keys are expected: Owner - Owner description typeid.Name - the name of the task. typeid.Desc - the description of the task typeid.Category - the category for the task

getTypeName

LocalizedString getTypeName()

Shortcut for baseBundleKey.typeId.Name

getOwnerName

LocalizedString getOwnerName()

Shortcut for baseBundleKey.Owner

canCancel

boolean canCancel()

Returns whether or not the task can be canceled.

canSuspend

boolean canSuspend()

Returns whether or not the task supports suspending and resuming.

createInstance

Task createInstance(GatewayContext context,
                    GatewayTaskRecord gatewayRecord)

buildWizardModel

void buildWizardModel(org.apache.wicket.extensions.wizard.WizardModel model,
                      org.apache.wicket.model.IModel<? extends java.util.List<? extends PersistentRecord>> dataModel)

Returns a new wizard that can be used to configure the task settings.

getSettingsRecordType

RecordMeta<? extends PersistentRecord> getSettingsRecordType()

Returns the record meta of the settings record for this type of task.

getSettingsRecordForeignKey

ReferenceField<GatewayTaskRecord> getSettingsRecordForeignKey()

If a settings record type is defined, return the foreign key field that references the main record type