Package com.uc4.api.objects

Class OutputScanFilter

java.lang.Object
com.uc4.api.objects.OutputScanFilter
public class OutputScanFilter extends Object
This class represents a single row Output-Scan tab of an Automation Engine Object.

  • Constructor Details

    • OutputScanFilter

      public OutputScanFilter(UC4ObjectName filterName, boolean condition, int returnCode, UC4ObjectName executeObject, String statusText)
      Creates a new instance of this class.
      Parameters:
      filterName - Name of the filter object in the Automation Engine
      condition - true if the filter should match, false otherwise
      returnCode - Return code if the filter matches
      executeObject - Name of an object which should be executed if the filter matches
      statusText - status text that is used for the task's remote status when the filter definition applies

    • OutputScanFilter

      public OutputScanFilter(UC4ObjectName filterName, boolean condition, int returnCode, UC4ObjectName executeObject)
      Creates a new instance of this class.
      Parameters:
      filterName - Name of the filter object in the Automation Engine
      condition - true if the filter should match, false otherwise
      returnCode - Return code if the filter matches
      executeObject - Name of an object which should be executed if the filter matches

    • OutputScanFilter

      protected OutputScanFilter(Element row)
      Creates a new instance of this class from an XML element
      Parameters:
      row - DOM element

  • Method Details

    • getFilterName

      public UC4ObjectName getFilterName()
      Name of the filter object.
      Returns:
      Filter

    • getCondition

      public boolean getCondition()
      Returns true if the filter should match or not match.
      Returns:
      Match condition

    • getReturnCode

      public int getReturnCode()
      Returns the return code of the Object in case the filter matches.
      Returns:
      Return code

    • getExecuteObject

      public UC4ObjectName getExecuteObject()
      Returns the name of the Automation Engine object which should be executed if the filter matches.
      Returns:
      Name of the object

    • getStatusText

      public String getStatusText()
      Returns the status text that is used for the task's remote status when the filter definition applies.
      Returns:
      Status text that is used for the task's remote status

    • store

      protected void store(com.uc4.util.XMLDocument doc, Element parent, int lnr)
      Saves the content of this instance in an XML DOM Element.
      Parameters:
      doc - Document
      parent - Parent element

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object