Platform SDK Java 8.5 API Reference

com.genesyslab.platform.apptemplate.filtering.impl.filters
Class DefaultFilter

java.lang.Object
  extended by com.genesyslab.platform.apptemplate.filtering.impl.BaseFilter
      extended by com.genesyslab.platform.apptemplate.filtering.impl.filters.DefaultFilter
All Implemented Interfaces:
java.lang.Cloneable

public final class DefaultFilter
extends BaseFilter

Default message filter implementation (used in FilterChain).


Constructor Summary
DefaultFilter(java.lang.String key)
           
 
Method Summary
 void applyActions(java.util.ArrayList<FilterAction> newActions)
          Applies new actions.
 void applyConditions(java.util.ArrayList<FilterCondition> newConditions)
          Applies new conditions.
 java.lang.Object clone()
          Clones this message filter.
protected  void doRegister(FilterContext context)
          Registers filter variables and so on.
protected  void doUnregister(FilterContext context)
          Unregisters filter variables and so on.
 void execActions(Message message, FilterContext context)
          Executes filter actions.
 java.util.ArrayList<FilterAction> getActions()
          Gets actions list.
 java.util.ArrayList<FilterCondition> getConditions()
          Gets conditions.
 boolean getExecuteActionsOnMatch()
          Gets current filter actions executions behaviour (executes on match/mismatch).
 boolean isMessageAccepted(Message message, FilterContext context)
          Evaluates whether message is accepted by filter.
 
Methods inherited from class com.genesyslab.platform.apptemplate.filtering.impl.BaseFilter
getKey, isRegistered
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DefaultFilter

public DefaultFilter(java.lang.String key)
Method Detail

isMessageAccepted

public boolean isMessageAccepted(Message message,
                                 FilterContext context)
Description copied from class: BaseFilter
Evaluates whether message is accepted by filter.

Specified by:
isMessageAccepted in class BaseFilter
Parameters:
message - The message to evaluate
context - Filter context, where data for message evaluation, like filter variables, can be stored.
Returns:
true if message should be accepted else - false.

getConditions

public java.util.ArrayList<FilterCondition> getConditions()
Gets conditions.

Returns:
conditions.

applyConditions

public void applyConditions(java.util.ArrayList<FilterCondition> newConditions)
                     throws java.lang.NullPointerException
Applies new conditions.

Parameters:
newCondition - new conditions.
Throws:
java.lang.NullPointerException - if any argument is null.
java.lang.IllegalStateException - when filter already registered (used).

getExecuteActionsOnMatch

public boolean getExecuteActionsOnMatch()
Gets current filter actions executions behaviour (executes on match/mismatch).

Returns:
current filter actions executions behaviour.

execActions

public void execActions(Message message,
                        FilterContext context)
Executes filter actions.

Parameters:
context -

getActions

public java.util.ArrayList<FilterAction> getActions()
Gets actions list.

Returns:
actions.

applyActions

public void applyActions(java.util.ArrayList<FilterAction> newActions)
                  throws java.lang.NullPointerException
Applies new actions.

Parameters:
newActions - new actions.
Throws:
java.lang.NullPointerException - if any argument is null.
java.lang.IllegalStateException - when filter already registered (used).

clone

public java.lang.Object clone()
Description copied from class: BaseFilter
Clones this message filter.

Overrides:
clone in class BaseFilter
Returns:
clone of this message filter.

doRegister

protected void doRegister(FilterContext context)
Registers filter variables and so on.

Overrides:
doRegister in class BaseFilter
Parameters:
context - filter context.

doUnregister

protected void doUnregister(FilterContext context)
Unregisters filter variables and so on.

Overrides:
doUnregister in class BaseFilter
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.