Package com.uc4.api.objects

Class OutputFilter

java.lang.Object

com.uc4.api.objects.UC4Object

com.uc4.api.objects.OutputFilter

All Implemented Interfaces:

java.lang.Iterable<OutputFilter.Entry>

public class OutputFilter
extends UC4Object
implements java.lang.Iterable<OutputFilter.Entry>

Output Filter.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OutputFilter.Entry	This class represents a single filter definition in an OutputFilter object.
static class	OutputFilter.Operator	Operator.

Constructor Summary

Constructors

Constructor	Description
OutputFilter()

Method Summary

Modifier and Type	Method	Description
void	add(OutputFilter.Entry filterEntry)	Adds a new filter definition.
OutputFilter.Operator	getOperator()	Returns the operator which is used to combine the filter in this object.
Header	header()	Returns the header data of this object.
boolean	isExecutable()	Returns true if this Object can be executed.
java.util.Iterator<OutputFilter.Entry>	iterator()	Iterator which can be used to read the filter or remove them using Iterator.remove().
protected void	loadContent(com.uc4.util.XMLDocument doc, ConnectionAttributes session)
void	removeAllFilters()	Removes all existing filters.
void	setOperator(OutputFilter.Operator operator)	Sets the operator which is used to combine the filter in this object.
int	size()
protected void	storeContent(com.uc4.util.XMLDocument doc, org.w3c.dom.Element objectElement, ConnectionAttributes sessionInfo)

Methods inherited from class com.uc4.api.objects.UC4Object

docu, getAccess, getIdnr, getModCount, getName, getObjectClient, getType, isOldVersion, load, store, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

OutputFilter

public OutputFilter()

Method Detail

loadContent

protected void loadContent(com.uc4.util.XMLDocument doc,
                           ConnectionAttributes session)

storeContent

protected void storeContent(com.uc4.util.XMLDocument doc,
                            org.w3c.dom.Element objectElement,
                            ConnectionAttributes sessionInfo)

header

public Header header()

Returns the header data of this object. This is the information of the header tab in the dialog client.

Returns:

header

getOperator

public OutputFilter.Operator getOperator()

Returns the operator which is used to combine the filter in this object. Possible values are: AND, OR.

Returns:

Enum "AND" or "OR"

size

public int size()

Returns:

Number of filter entries

iterator

public java.util.Iterator<OutputFilter.Entry> iterator()

Iterator which can be used to read the filter or remove them using Iterator.remove().

Specified by:

iterator in interface java.lang.Iterable<OutputFilter.Entry>

Returns:

Iteraotr over OutputFilter.Entry.

add

public void add(OutputFilter.Entry filterEntry)

Adds a new filter definition.

Parameters:

filterEntry - Filter

removeAllFilters

public void removeAllFilters()

Removes all existing filters.

setOperator

public void setOperator(OutputFilter.Operator operator)

Sets the operator which is used to combine the filter in this object. Possible values are: AND, OR.

Parameters:

operator - Enum "AND" or "OR"

isExecutable

public boolean isExecutable()

Description copied from class: UC4Object

Returns true if this Object can be executed.

Specified by:

isExecutable in class UC4Object

Returns:

true if the Object can be executed, false if not.