Package com.microstrategy.web.objects.admin.monitors

Interface MonitorFilter

All Known Implementing Classes:

MonitorFilterImpl

public interface MonitorFilter

The interface MonitorFilter contains a collection of filter expressions that will be used to filter the results of any monitor information retrieval calls. Each expression consists of a field, operator, and one or more values. Each expression in the filter collection is represented in the collection by a MonitorFilterCondition object.

Since:

MicroStrategy Web 9.0.0

Method Summary

Modifier and Type	Method	Description
MonitorFilterCondition	add(int field, int operator, java.lang.String value)	Adds a condition to the collection
MonitorFilterCondition	add(int field, int operator, java.lang.String[] value)	Adds a condition to the collection
java.lang.String	buildInboxFilterXML()
void	clear()	Clears the collection.
MonitorFilterCondition	get(int i)	Returns the MonitorFilterCondition object at the specified position.
void	remove(int index)	Removes the MonitorFilterCondition object at the specified position.
void	remove(MonitorFilterCondition condition)	Removes the specified MonitorFilterCondition object from the collection.
int	size()	Returns the total number of MonitorFilterCondition objects in the collection.

Method Detail

add

MonitorFilterCondition add(int field,
                           int operator,
                           java.lang.String value)

Adds a condition to the collection

Parameters:

field - the field being qualified upon. The field comes from EnumDSSXMLJobInfo, EnumDSSXMLUserConnectionInfo or EnumDSSXMLDBConnectionInfo.

operator - the operator of the condition, a value from EnumDSSXMLMonitorFilterOperator

value - a single value of the condition.

Returns:

a MonitorFilterCondition object.

add

MonitorFilterCondition add(int field,
                           int operator,
                           java.lang.String[] value)

Adds a condition to the collection

Parameters:

field - the field being qualified upon. The field comes from EnumDSSXMLJobInfo, EnumDSSXMLUserConnectionInfo or EnumDSSXMLDBConnectionInfo.

operator - the operator of the condition, a value from EnumDSSXMLMonitorFilterOperator

value - a String array of values

Returns:

a MonitorFilterCondition object.

get

MonitorFilterCondition get(int i)

Returns the MonitorFilterCondition object at the specified position.

Parameters:

i - the position of the MonitorFilterCondition object

Returns:

a MonitorFilterCondition object

size

int size()

Returns the total number of MonitorFilterCondition objects in the collection.

Returns:

the current size of the collection.

clear

void clear()

Clears the collection.

remove

void remove(int index)

Removes the MonitorFilterCondition object at the specified position.

Parameters:

index - the position of the MonitorFilterCondition object to be removed.

remove

void remove(MonitorFilterCondition condition)

Removes the specified MonitorFilterCondition object from the collection.

Parameters:

condition - the MonitorFilterCondition object to be removed.

buildInboxFilterXML

java.lang.String buildInboxFilterXML()

Returns: