Package com.inductiveautomation.ignition.gateway.tasks

Class AbstractTaskPage

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

org.apache.wicket.markup.html.panel.Panel

com.inductiveautomation.ignition.gateway.web.components.ConfigPanel

com.inductiveautomation.ignition.gateway.web.components.RecordActionTable<R>

com.inductiveautomation.ignition.gateway.web.components.ExtensionPointPage<GatewayTaskRecord>

com.inductiveautomation.ignition.gateway.tasks.AbstractTaskPage

All Implemented Interfaces:

Serializable, Iterable<org.apache.wicket.Component>, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.IConverterLocator, org.apache.wicket.markup.html.IHeaderContributor, org.apache.wicket.request.component.IRequestableComponent, org.apache.wicket.util.IHierarchical<org.apache.wicket.Component>, org.apache.wicket.util.io.IClusterable

Direct Known Subclasses:

TaskPage

public abstract class AbstractTaskPage
extends ExtensionPointPage<GatewayTaskRecord>

Created by colby.clegg on 6/26/2015.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.inductiveautomation.ignition.gateway.web.components.RecordActionTable

RecordActionTable.ICalculatedField<R extends PersistentRecord>, RecordActionTable.RecordActionTableDelete

Field Summary

Fields inherited from class com.inductiveautomation.ignition.gateway.web.components.RecordActionTable

configPage

Fields inherited from class com.inductiveautomation.ignition.gateway.web.components.ConfigPanel

feedback, returnPanel

Fields inherited from class org.apache.wicket.markup.html.panel.Panel

PANEL

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_INITIALIZED, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER

Constructor Summary

Constructors

Constructor	Description
AbstractTaskPage(IConfigPage configPage, org.apache.commons.lang3.tuple.Pair<String,String> menuLocation)

Method Summary

Modifier and Type	Method	Description
protected void	addRecordInstanceActions(org.apache.wicket.markup.repeater.RepeatingView view, GatewayTaskRecord record)	Provides an opportunity to add any actions that deal with specific record instances.
static GatewayTaskRecord	duplicateTask(PersistenceInterface pi, GatewayTaskRecord original)	Use to duplicate a task that is normally fixed at a certain schedule, or is only run on demand.
protected List<RecordActionTable.ICalculatedField<GatewayTaskRecord>>	getCalculatedFields()	Override this to add calculated fields (columns) to the table.
protected TaskState	getCurrentTaskState(GatewayTaskRecord record)
protected ExtensionPointManager	getExtensionPointManager()
org.apache.commons.lang3.tuple.Pair<String,String>	getMenuLocation()
protected RecordMeta<GatewayTaskRecord>	getRecordMeta()
protected TaskManager	getTaskManager()
protected boolean	isFeedbackEnabled()
protected org.apache.wicket.markup.html.WebMarkupContainer	newDeleteRecordAction(String id, GatewayTaskRecord record)
protected org.apache.wicket.markup.html.WebMarkupContainer	newEditRecordAction(String id, GatewayTaskRecord record)

Methods inherited from class com.inductiveautomation.ignition.gateway.web.components.ExtensionPointPage

addCustomRecordInstanceActions, createRecordModel, doDeleteRelatedRecords, findSubRecord, findSubRecord, getExtensionPointTypeField, getFieldValue, includeTypeInModel, newRecordAction, onExtensionPointChosen

Methods inherited from class com.inductiveautomation.ignition.gateway.web.components.RecordActionTable

addRecordActions, canDelete, createFooter, getActionParentPanel, getCalculatedFieldDisplayValue, getCalculatedFieldModel, getDescriptiveFields, getExemptForeignKeys, getInstanceActionMaxRowCount, getNoDescriptiveFieldsKey, getNoRowsKey, getTitleKey, initComponents, onBeforeRender, onDelete, setupNewRecord

Methods inherited from class com.inductiveautomation.ignition.gateway.web.components.ConfigPanel

getHelpResourceKey, getHelpTopicId, getMenuPath, getTipLabelKey, getTipLabelModel, getTitleModel, initTitleArea, isEscapeHtmlInTipLabel, isTitleVisible, log, renderHead

Methods inherited from class org.apache.wicket.markup.html.panel.Panel

newMarkupSourcingStrategy

Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainer

getWebApplication, getWebPage, getWebRequest, getWebResponse, getWebSession

Methods inherited from class org.apache.wicket.MarkupContainer

add, addOrReplace, autoAdd, contains, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, internalAdd, internalInitialize, iterator, iterator, onAfterRenderChildren, onComponentTagBody, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, swap, toString, toString, visitChildren, visitChildren, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, canCallListenerInterface, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, clearOriginalDestination, configure, continueToOriginalDestination, debug, detach, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findMarkupStream, findPage, findParent, findParentWithAssociatedMarkup, getAjaxRegionMarkupId, getApplication, getBehaviorById, getBehaviorId, getBehaviors, getBehaviors, getClassRelativePath, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessages, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkup, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdFromMarkup, getMarkupIdImpl, getMarkupSourcingStrategy, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getRequestFlag, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalOnModelChanged, internalPrepareForRender, internalRenderComponent, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, onAfterRender, onComponentTag, onConfigure, onDetach, onEvent, onInitialize, onModelChanged, onModelChanging, onReAdd, onRemove, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderHead, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setRequestFlag, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, visitParents, warn, wrap

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

AbstractTaskPage

public AbstractTaskPage(IConfigPage configPage,
 org.apache.commons.lang3.tuple.Pair<String,String> menuLocation)

Method Details

getTaskManager

protected TaskManager getTaskManager()

getExtensionPointManager

protected ExtensionPointManager getExtensionPointManager()

Specified by:

getExtensionPointManager in class ExtensionPointPage<GatewayTaskRecord>

getRecordMeta

protected RecordMeta<GatewayTaskRecord> getRecordMeta()

Specified by:

getRecordMeta in class RecordActionTable<GatewayTaskRecord>

isFeedbackEnabled

protected boolean isFeedbackEnabled()

Overrides:

isFeedbackEnabled in class ConfigPanel

getMenuLocation

public org.apache.commons.lang3.tuple.Pair<String,String> getMenuLocation()

Overrides:

getMenuLocation in class ConfigPanel

Returns:

Pair of strings representing categoryId (matching ConfigCategory.getName()) and item id (matching INamedTab.getTabName()) which lets the menu know where in the config menu should be highlighted when this config page is visible.

newEditRecordAction

protected org.apache.wicket.markup.html.WebMarkupContainer newEditRecordAction(String id,
 GatewayTaskRecord record)

Overrides:

newEditRecordAction in class ExtensionPointPage<GatewayTaskRecord>

addRecordInstanceActions

protected void addRecordInstanceActions(org.apache.wicket.markup.repeater.RepeatingView view,
 GatewayTaskRecord record)

Description copied from class: RecordActionTable

Provides an opportunity to add any actions that deal with specific record instances. Default actions are added for edit and delete.

Overrides:

addRecordInstanceActions in class ExtensionPointPage<GatewayTaskRecord>

newDeleteRecordAction

protected org.apache.wicket.markup.html.WebMarkupContainer newDeleteRecordAction(String id,
 GatewayTaskRecord record)

Overrides:

newDeleteRecordAction in class RecordActionTable<GatewayTaskRecord>

getCalculatedFields

protected List<RecordActionTable.ICalculatedField<GatewayTaskRecord>> getCalculatedFields()

Description copied from class: RecordActionTable

Override this to add calculated fields (columns) to the table. Default implementation returns null.

Overrides:

getCalculatedFields in class RecordActionTable<GatewayTaskRecord>

getCurrentTaskState

protected TaskState getCurrentTaskState(GatewayTaskRecord record)

duplicateTask

public static GatewayTaskRecord duplicateTask(PersistenceInterface pi,
 GatewayTaskRecord original)
                                       throws Exception

Use to duplicate a task that is normally fixed at a certain schedule, or is only run on demand. The use of a duplicate task means that the original can be left undisturbed. The duplicated task is saved in the database and a "record added" GatewayTaskRecord event is fired. The duplicated task is scheduled to run immediately.

Throws:

Exception