com.uc4.api.objects

Class OutputScanFilter

java.lang.Object

com.uc4.api.objects.OutputScanFilter

public class OutputScanFilter
extends java.lang.Object

This class represents a single row Output-Scan tab of an Automation Engine Object.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OutputScanFilter(org.w3c.dom.Element row) Creates a new instance of this class from an XML element
	OutputScanFilter(UC4ObjectName filterName, boolean condition, int returnCode, UC4ObjectName executeObject) Creates a new instance of this class.
	OutputScanFilter(UC4ObjectName filterName, boolean condition, int returnCode, UC4ObjectName executeObject, java.lang.String statusText) Creates a new instance of this class.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
boolean	getCondition() Returns true if the filter should match or not match.
UC4ObjectName	getExecuteObject() Returns the name of the Automation Engine object which should be executed if the filter matches.
UC4ObjectName	getFilterName() Name of the filter object.
int	getReturnCode() Returns the return code of the Object in case the filter matches.
java.lang.String	getStatusText() Returns the status text that is used for the task's remote status when the filter definition applies.
int	hashCode()
protected void	store(com.uc4.util.XMLDocument doc, org.w3c.dom.Element parent, int lnr) Saves the content of this instance in an XML DOM Element.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OutputScanFilter

public OutputScanFilter(UC4ObjectName filterName,
                        boolean condition,
                        int returnCode,
                        UC4ObjectName executeObject,
                        java.lang.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(org.w3c.dom.Element row)

Creates a new instance of this class from an XML element

Parameters:

row - DOM element

Method Detail

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 java.lang.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,
                     org.w3c.dom.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 java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object