org.glassfish.cafe.api.presence
Interface PresenceWatcherFilterSet

public interface PresenceWatcherFilterSet

The Filter Set encapsulates a set of filters which can be used for the ImsPresenceWatcher in order to subscribe to the presence server.

This entity models on high level the element as defined by [RFC4661].

Method Summary

void	addElement(Element element) Adds Element to your filter
PresenceWatcherFilter	createDomainFilter(String domain) Creates an instance of an PresenceWatcherFilter and associate it immediately to this current set.
PresenceWatcherFilter	createFilter() Creates an instance of an PresenceWatcherFilter and associate it immediately to this current set.
PresenceWatcherFilter	createFilter(String uri) Creates an instance of an PresenceWatcherFilter and associate it immediately to this current set.
Element	getElementNS(String uri, String name) Returns an Element object belonging to this filter Document
NodeList	getElementsNS(String uri, String name) Returns an Element object belonging to this filter Document
String	getXML() Returns the raw XML content of this filter

Method Detail

createFilter

PresenceWatcherFilter createFilter()

Creates an instance of an PresenceWatcherFilter and associate it immediately to this current set. Filters that do not have a uri or a domain are mentioned in OMA.

Returns:

the Watcher Filter instance.

createFilter

PresenceWatcherFilter createFilter(String uri)

Creates an instance of an PresenceWatcherFilter and associate it immediately to this current set.

Parameters:

uri - Filter URI.

Returns:

the Watcher Filter instance.

createDomainFilter

PresenceWatcherFilter createDomainFilter(String domain)

Creates an instance of an PresenceWatcherFilter and associate it immediately to this current set.

Parameters:

uri - Filter Domain.

Returns:

the Watcher Filter instance.

addElement

void addElement(Element element)

Adds Element to your filter

getElementNS

Element getElementNS(String uri,
                     String name)

Returns an Element object belonging to this filter Document

getElementsNS

NodeList getElementsNS(String uri,
                       String name)

Returns an Element object belonging to this filter Document

Parameters:

uri - Filter Domain.

name - The node name.

Returns:

getXML

String getXML()

Returns the raw XML content of this filter

Returns:

the XML String representing the filter document.