OpenNMS API 1.2.3

org.opennms.web.event.filter
Interface Filter

All Known Implementing Classes:
AcknowledgedByFilter, AfterDateFilter, BeforeDateFilter, DescriptionSubstringFilter, ExactUEIFilter, InterfaceFilter, IPLikeFilter, LogMessageMatchesAnyFilter, LogMessageSubstringFilter, NegativeAcknowledgedByFilter, NegativeExactUEIFilter, NegativeInterfaceFilter, NegativeNodeFilter, NegativePartialUEIFilter, NegativeServiceFilter, NegativeSeverityFilter, NodeFilter, NodeNameLikeFilter, PartialUEIFilter, ServiceFilter, SeverityFilter

public interface Filter

Convenience class to determine what sort of events to include in a query.


Method Summary
 java.lang.String getDescription()
          Returns a terse string (including a "=") that describes this filter in such a way to easily be included in an HTTP GET parameter.
 java.lang.String getSql()
          Returns an expresions for a SQL where clause.
 java.lang.String getTextDescription()
          Returns a terse but human-readable string describing this filter in such a way to easily be included in a search results list.
 

Method Detail

getSql

public java.lang.String getSql()
Returns an expresions for a SQL where clause. Remember to include a trailing space, but no leading AND or OR.


getDescription

public java.lang.String getDescription()
Returns a terse string (including a "=") that describes this filter in such a way to easily be included in an HTTP GET parameter.

Some examples:


getTextDescription

public java.lang.String getTextDescription()
Returns a terse but human-readable string describing this filter in such a way to easily be included in a search results list.

Some examples (corresponding to the examples in getDescription):


OpenNMS API 1.2.3

Generated by eevans on May 29 2005 2015.