Package com.uc4.api.objects

Class OutputFilter.Entry

java.lang.Object

com.uc4.api.objects.OutputFilter.Entry

Enclosing class:

OutputFilter

public static class OutputFilter.Entry
extends Object

This class represents a single filter definition in an OutputFilter object.

Field Summary

Fields

Modifier and Type	Field	Description
static final char	TYPE_FILE	File.
static final char	TYPE_REGISTERED	Registered.
static final char	TYPE_REPORT	Report.

Constructor Summary

Constructors

Modifier	Constructor	Description
	Entry(boolean report, boolean contains, String source, String filterText)	Deprecated. Use the other constructor in order to create a filter for registered job output.
	Entry(char type, boolean contains, String source, String filterText)	Creates a new filter condition.
protected	Entry(Element row)	Internal use only.

Method Summary

Modifier and Type	Method	Description
String	getFilterText()	Returns the filter text.
String	getSource()	Returns the source of this filter.
boolean	isContains()	Returns true if this filter matches when the filter text is found in the source, false if this filter should match when the filter text is not found.
boolean	isFile()	Returns true if the source is a file.
boolean	isRegisteredJobOutput()	Returns true if the source is a registered job output.
boolean	isReport()	Returns true if the source is a report.

Methods inherited from class java.lang.Object

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

Field Details

TYPE_REPORT

public static final char TYPE_REPORT

Report.

See Also:

• Constant Field Values

TYPE_FILE

public static final char TYPE_FILE

File.

See Also:

• Constant Field Values

TYPE_REGISTERED

public static final char TYPE_REGISTERED

Registered.

See Also:

• Constant Field Values

Constructor Details

Entry

@Deprecated
public Entry(boolean report,
 boolean contains,
 String source,
 String filterText)

Deprecated.

Use the other constructor in order to create a filter for registered job output.

Creates a new filter condition for report or file.

Parameters:

report - true if the source of this filter is a report, false if it is an external file.

contains - true if the filter matches when the filterText is found, false if the filter should match if the filtertext was not found

source - Name of the report or a file name, depending on the value of the parameter report. For reports the 4 letter abbreviation has to be used (SLOG, SAPL, ...)

filterText - Search text

Entry

public Entry(char type,
 boolean contains,
 String source,
 String filterText)

Creates a new filter condition.

Parameters:

type - Use one of the static constants (TYPE_REPORT, TYPE_FILE, TYPE_REGISTERED) of this class or pass the following value:

• R ... Report
• O ... Output
• F ... File

contains - true if the filter matches when the filterText is found, false if the filter should match if the filtertext was not found

source - Name of the report or a file name, depending on the value of the parameter report. For reports the 4 letter abbreviation has to be used (SLOG, SAPL, ...)

filterText - Search text

Entry

protected Entry(Element row)

Internal use only. Creates a filter entry from the specified DOM element.

Parameters:

row - Element

Method Details

isReport

public boolean isReport()

Returns true if the source is a report.

Returns:

true if the source of this filter is a report; false if not

isFile

public boolean isFile()

Returns true if the source is a file.

Returns:

true if the source of this filter is a file; false if not

isRegisteredJobOutput

public boolean isRegisteredJobOutput()

Returns true if the source is a registered job output.

Returns:

true if the source of this filter is a registered job output; false if not

isContains

public boolean isContains()

Returns true if this filter matches when the filter text is found in the source, false if this filter should match when the filter text is not found.

Returns:

Contains filter text (true/false)

getSource

public String getSource()

Returns the source of this filter.

Returns:

report name or a filter for a file name

getFilterText

public String getFilterText()

Returns the filter text.

Returns:

filter text