com.inductiveautomation.sfc.api

Interface StepDelegate

All Known Subinterfaces:

ClientStepFactory, StepFactory

All Known Implementing Classes:

AbstractActionStepDelegate, AbstractAssertionStepDelegate, AbstractBeginStepDelegate, AbstractEnclosingStepDelegate, AbstractEndStepDelegate, ActionStepUI.ActionStepFactory, AssertionStepUI.AssertionStepFactory, BeginStepUI.BeginStepFactory, EnclosingStepUI.EnclosingStepFactory, EndStepUI.EndStepFactory

public interface StepDelegate

Base interface for factory that creates objects to represent steps. Also handles XML serialization for the step.

Method Summary

Modifier and Type	Method and Description
void	fromXml(org.w3c.dom.Element domElement, ChartUIElement uiElement) Given an XML DOM element, fill in the properties of the ChartUIElement.
java.util.List<Property<?>>	getCompilationAlteringProperties()
java.lang.String	getId()
void	toXml(javax.xml.stream.XMLStreamWriter writer, ChartUIElement element, java.lang.String tab) Serialize the given element (which is guaranteed to be a step element of this factory's type) to the stream writer.
void	validate(ChartUIElement element, ChartCompilationResults compilationResults) Provides step implementations a chance to validate their settings.

Method Detail

getId

java.lang.String getId()

Returns:

A unique string that identifies this kind of step, for example: "com.company.foostep".

toXml

void toXml(javax.xml.stream.XMLStreamWriter writer,
           ChartUIElement element,
           java.lang.String tab)
    throws javax.xml.stream.XMLStreamException

Serialize the given element (which is guaranteed to be a step element of this factory's type) to the stream writer. Common step attributes (type, id, name, size, location) will have already been serialized, meaning, the xml stream will have just written the open <step> element. Close any elements you open.

Parameters:

writer - the XMLStreamWriter to write to.

element - the ChartUIElement to serialize.

Throws:

javax.xml.stream.XMLStreamException

fromXml

void fromXml(org.w3c.dom.Element domElement,
             ChartUIElement uiElement)
      throws XmlParseException

Given an XML DOM element, fill in the properties of the ChartUIElement. Just like for serializing, the id, location, and name will have already been handled.

Parameters:

domElement - the XML DOM element.

uiElement - the ChartUIElement to deserialize.

Throws:

XmlParseException

validate

void validate(ChartUIElement element,
              ChartCompilationResults compilationResults)

Provides step implementations a chance to validate their settings. If the settings are invalid, they should add an error to the compilation results.

Parameters:

element - the ChartUIElementto validate.

compilationResults - the ChartCompilationResults.

getCompilationAlteringProperties

java.util.List<Property<?>> getCompilationAlteringProperties()

Returns:

a list of properties that may alter this step's compilation validation.