Package org.apache.hop.workflow.actions.abort

Class ActionAbort

  • All Implemented Interfaces:
    Cloneable, IAttributes, ICheckResultSource, IExtensionData, IHasLogChannel, ILoggingObject, IVariables, org.apache.hop.resource.IResourceHolder, org.apache.hop.workflow.action.IAction
    @Action(id="ABORT",
        name="i18n::ActionAbort.Name",
        description="i18n::ActionAbort.Description",
        image="Abort.svg",
        categoryDescription="i18n:org.apache.hop.workflow:ActionCategory.Category.Utility",
        keywords="i18n::ActionAbort.keyword",
        documentationUrl="/workflow/actions/abort.html")
public class ActionAbort
extends org.apache.hop.workflow.action.ActionBase
implements Cloneable, org.apache.hop.workflow.action.IAction
    Action type to abort a workflow.

    • Field Summary

      • Fields inherited from class org.apache.hop.workflow.action.ActionBase

        attributesMap, containerObjectId, entryTransformSetVariablesMap, extensionDataMap, log, parentWorkflow, parentWorkflowMeta

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void check​(List<ICheckResult> remarks, org.apache.hop.workflow.WorkflowMeta workflowMeta, IVariables variables, IHopMetadataProvider metadataProvider)  
      Object clone()  
      Result execute​(Result result, int nr)
      Execute this action and return the result.
      String getMessageAbort()
      Get the message to display in the log
      boolean isAlwaysLogRows()  
      boolean isEvaluation()  
      boolean isUnconditional()  
      boolean resetErrorsBeforeExecution()  
      void setAlwaysLogRows​(boolean alwaysLogRows)  
      void setMessageAbort​(String message)
      Set the message to display in the log

      • Methods inherited from class org.apache.hop.workflow.action.ActionBase

        clear, copyFrom, equals, exportResources, getAttribute, getAttributes, getAttributesMap, getContainerId, getDescription, getDialogClassName, getEntryTransformSetVariable, getEntryTransformSetVariablesMap, getExtensionDataMap, getFilename, getLogChannel, getLogChannelId, getLogLevel, getMetadataProvider, getName, getObjectCopy, getObjectName, getObjectType, getParent, getParentVariables, getParentWorkflow, getParentWorkflowMeta, getPluginId, getRealFilename, getReferencedObjectDescriptions, getRegistrationDate, getResourceDependencies, getSqlStatements, getTypeDesc, getTypeId, getUsedDatabaseConnections, getVariable, getVariable, getVariableBoolean, getVariableNames, getVariables, getXml, hasChanged, hashCode, initializeFrom, isBasic, isDebug, isDetailed, isForcingSeparateLogging, isGatheringMetrics, isPipeline, isReferencedObjectEnabled, isRowlevel, isStart, isWorkflow, loadReferencedObject, loadXml, loadXml, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, resolve, resolve, resolve, setAttribute, setAttributes, setAttributesMap, setChanged, setChanged, setContainerObjectId, setDescription, setEntryTransformSetVariable, setForcingSeparateLogging, setGatheringMetrics, setLogLevel, setMetadataProvider, setName, setParentVariables, setParentWorkflow, setParentWorkflowMeta, setPluginId, setVariable, setVariables, shareWith, toString

      • Methods inherited from interface org.apache.hop.workflow.action.IAction

        clear, exportResources, getDescription, getDialogClassName, getFilename, getLogChannel, getName, getParentWorkflow, getParentWorkflowMeta, getPluginId, getRealFilename, getReferencedObjectDescriptions, getResourceDependencies, getSqlStatements, getXml, hasChanged, isPipeline, isReferencedObjectEnabled, isStart, isWorkflow, loadReferencedObject, loadXml, setChanged, setChanged, setDescription, setMetadataProvider, setName, setParentWorkflow, setParentWorkflowMeta, setPluginId

    • Constructor Detail

      • ActionAbort

        public ActionAbort​(String name,
                   String description)

      • ActionAbort

        public ActionAbort()

      • ActionAbort

        public ActionAbort​(ActionAbort other)

    • Method Detail

      • clone

        public Object clone()
        Specified by:
        clone in interface org.apache.hop.workflow.action.IAction
        Overrides:
        clone in class org.apache.hop.workflow.action.ActionBase

      • execute

        public Result execute​(Result result,
                      int nr)
        Execute this action and return the result. In this case it means, just set the result boolean in the Result class.
        Specified by:
        execute in interface org.apache.hop.workflow.action.IAction
        Parameters:
        result - The result of the previous execution
        Returns:
        The Result of the execution.

      • resetErrorsBeforeExecution

        public boolean resetErrorsBeforeExecution()
        Specified by:
        resetErrorsBeforeExecution in interface org.apache.hop.workflow.action.IAction
        Overrides:
        resetErrorsBeforeExecution in class org.apache.hop.workflow.action.ActionBase

      • isEvaluation

        public boolean isEvaluation()
        Specified by:
        isEvaluation in interface org.apache.hop.workflow.action.IAction
        Overrides:
        isEvaluation in class org.apache.hop.workflow.action.ActionBase

      • isUnconditional

        public boolean isUnconditional()
        Specified by:
        isUnconditional in interface org.apache.hop.workflow.action.IAction
        Overrides:
        isUnconditional in class org.apache.hop.workflow.action.ActionBase

      • setMessageAbort

        public void setMessageAbort​(String message)
        Set the message to display in the log
        Parameters:
        message -

      • getMessageAbort

        public String getMessageAbort()
        Get the message to display in the log
        Returns:
        the message

      • isAlwaysLogRows

        public boolean isAlwaysLogRows()

      • setAlwaysLogRows

        public void setAlwaysLogRows​(boolean alwaysLogRows)

      • check

        public void check​(List<ICheckResult> remarks,
                  org.apache.hop.workflow.WorkflowMeta workflowMeta,
                  IVariables variables,
                  IHopMetadataProvider metadataProvider)
        Specified by:
        check in interface org.apache.hop.workflow.action.IAction
        Overrides:
        check in class org.apache.hop.workflow.action.ActionBase