---
name: "CosNotifyFilter_FilterAdmin"
section: "3erl"
platform: "linux"
package: "erlang-manpages"
version: "1:19.2.1+dfsg-2+deb9u3"
release: "Debian 9 (Stretch)"
platforms: ["linux"]
url: "https://new.carta.tech/CosNotifyFilter_FilterAdmin"
---

# CosNotifyFilter\_FilterAdmin(3erl)

This module implements the OMG CosNotifyFilter::FilterAdmin interface.

## NAME

CosNotifyFilter\_FilterAdmin - This module implements the OMG CosNotifyFilter::FilterAdmin interface.

## DESCRIPTION

To get access to the record definitions for the structures use: \
 *-include\_lib("cosNotification/include/\*.hrl").*

All objects, which inherit this interface, export functions described in this module.

## EXPORTS

**add\_filter(Object, Filter) -\> FilterID**\

Types:

Object = #objref\
 Filter = #objref\
 FilterID = long()\

This operation connects a new *Filter* to the target object. This *Filter* will, together with other associated *Filters*, be used to select events to forward. A unique Id is returned and should be used if we no longer want to consult the given *Filter*.

**remove\_filter(Object, FilterID) -\> ok**\

Types:

Object = #objref\
 FilterID = long()\

If a certain *Filter* no longer should be associated with the target object this operation must be used. Events will no longer be tested against the *Filter* associated with the given Id.

**get\_filter(Object, FilterID) -\> Reply**\

Types:

Object = #objref\
 FilterID = long()\
 Reply = Filter \| {'EXCEPTION', #'CosNotifyFilter\_FilterNotFound'{}}\
 Filter = #objref\

If the target object is associated with a *Filter* matching the given Id the reference will be returned. If no such *Filter* is known by the target object an exception is raised.

**get\_all\_filters(Object) -\> FilterIDSeq**\

Types:

Object = #objref\
 FilterIDSeq = \[FilterID\]\
 FilterID = long()\

Id's for all *Filter* objects associated with the target object is returned by this operation.

**remove\_all\_filters(Object) -\> ok**\

Types:

Object = #objref\

If we want to remove all *Filters* associated with the target object we can use this function.
