Filters Collection

The Filters collection contains all Filter objects in a query.

Discussion

Use this collection to select or remove a Filter object.

This collection is an IBM® Cognos® object. Each Query and Report object in a model may contain a Filters collection. A filter represents a condition that must be met before data can be retrieved from a data source.To return this collection, use the Filters property.

Use the Add method to add a new Filter object to the collection. Use the Remove method to remove a Filter object.

These tables list related methods and properties.

Method

Description

Add Method ()

Adds a Filter object to the collection.

Item Method

Selects a specific Filter object in the collection.

Remove Method

Removes a specific Filter object from the collection.

Property

Description

Application Property

Returns the Transformer Application object.

Count Property

Returns the number of Filter objects in the collection.

Parent Property

Returns the parent object.

Examples

new_package = model.Packages.Add()
new_query = new_package.Queries.Add()
new_filter = new_query.Filters.Add()