Platform SDK Java 8.5 API Reference

com.genesyslab.platform.apptemplate.filtering.impl
Class FilterCondition

java.lang.Object
  extended by com.genesyslab.platform.apptemplate.filtering.impl.FilterCondition
All Implemented Interfaces:
java.lang.Cloneable
Direct Known Subclasses:
ContainsAny

public abstract class FilterCondition
extends java.lang.Object
implements java.lang.Cloneable

FilterCondition is a filter predicate. Returned value of the predicate is used to evaluate whether message can be logged or not. FilterCondition has two operands. Fore example, one operand can be a message name or an attribute value, second can be a constant value or a filter variable. See FilterOperand.


Constructor Summary
FilterCondition(java.lang.String key, FilterOperand op1, FilterOperand op2, boolean negative)
          Creates message filter condition.
 
Method Summary
 java.lang.Object clone()
           
abstract  boolean evaluate(Message message, FilterContext context)
          Evaluates condition for specified message and context.
 java.lang.String getKey()
          Gets message filter condition key.
 FilterOperand getOp1()
          First operand (argument) of the logical operator (condition)
 FilterOperand getOp2()
          Second operand (argument) of the logical operator (condition)
 boolean isNegative()
          The result of condition can be inverted.
 void register(FilterContext context)
          Registers filter variables and so on.
 void unregister(FilterContext context)
          Unregisters filter variables and so on.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FilterCondition

public FilterCondition(java.lang.String key,
                       FilterOperand op1,
                       FilterOperand op2,
                       boolean negative)
Creates message filter condition.

Parameters:
key - message filter key.
Method Detail

getKey

public java.lang.String getKey()
Gets message filter condition key.

Returns:
message filter condition key.

isNegative

public boolean isNegative()
The result of condition can be inverted.

Returns:
True if result is inverted.

getOp1

public FilterOperand getOp1()
First operand (argument) of the logical operator (condition)

Returns:
FilterOperand

getOp2

public FilterOperand getOp2()
Second operand (argument) of the logical operator (condition)

Returns:
FilterOperand

evaluate

public abstract boolean evaluate(Message message,
                                 FilterContext context)
Evaluates condition for specified message and context.

Parameters:
message - message for filtering.
context - which contans filter variables.
Returns:
true if condition completed sucessfully.

clone

public java.lang.Object clone()
Overrides:
clone in class java.lang.Object

register

public void register(FilterContext context)
Registers filter variables and so on.

Parameters:
context - filter context.

unregister

public void unregister(FilterContext context)
Unregisters filter variables and so on.

Parameters:
context - filter context.

Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.