opennms/src/api/IFilterProcessor.ts

Client API for the OpenNMS network monitoring platform

import {Filter} from './Filter';
import {IHash} from '../internal/IHash';

/**
 * Interface that represents a processor to convert a [[Filter]] into a set of HTTP parameters.
 * @module IFilterProcessor
 * @interface
 */
export interface IFilterProcessor {
  /**
   * Given a [[Filter]], return a hash of URL parameters.
   */
  getParameters(filter: Filter): IHash<string>;
}