org.opengts.db
Class RuleFactoryAdapter

java.lang.Object
  extended by org.opengts.db.RuleFactoryAdapter
All Implemented Interfaces:
RuleFactory
Direct Known Subclasses:
RuleFactoryExample, RuleFactoryLite

public abstract class RuleFactoryAdapter
extends java.lang.Object
implements RuleFactory


Nested Class Summary
 
Nested classes/interfaces inherited from interface org.opengts.db.RuleFactory
RuleFactory.NotifyAction
 
Field Summary
 
Fields inherited from interface org.opengts.db.RuleFactory
ACTION_DEFAULT, ACTION_EMAIL_ACCOUNT, ACTION_EMAIL_ALL, ACTION_EMAIL_DEVICE, ACTION_EMAIL_RULE, ACTION_NONE, ACTION_NOTIFY_ACCOUNT, ACTION_NOTIFY_ALL, ACTION_NOTIFY_DEVICE, ACTION_NOTIFY_MASK, ACTION_NOTIFY_RULE, ACTION_SAVE_LAST, ACTION_VIA_EMAIL, ACTION_VIA_LISTENER, ACTION_VIA_MASK, ACTION_VIA_QUEUE, PRIORITY_HIGH, PRIORITY_LOW, PRIORITY_MEDIUM, PRIORITY_UNDEFINED, PROP_rule_workHours_
 
Constructor Summary
RuleFactoryAdapter()
           
 
Method Summary
 java.lang.String getGeoCorridorDescription(Account account, java.lang.String corrID)
          Gets the description for the specified GeoCorridor ID.
abstract  java.lang.String getName()
          Returns this RuleFactory name
 PredefinedRuleAction[] getPredefinedRuleActions(BasicPrivateLabel bpl)
          Returns a list of predefined rule actions
 java.lang.String getVersion()
          Return this RuleFactory version String
static int ValidateActionMask(int actionMask)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.opengts.db.RuleFactory
checkRuntime, checkSelectorSyntax, evaluateSelector, evaluateSelector, executeRule, executeRules, executeSelector, getFunctionDescription, getFunctionNames, getFunctionUsage, getIdentifierDescription, getIdentifierNames, getRuleIDs, getRuleNotifyEmail, getRuleSelector, isSelectorMatch
 

Constructor Detail

RuleFactoryAdapter

public RuleFactoryAdapter()
Method Detail

ValidateActionMask

public static int ValidateActionMask(int actionMask)

getName

public abstract java.lang.String getName()
Returns this RuleFactory name

Specified by:
getName in interface RuleFactory
Returns:
This RuleFactory name

getVersion

public java.lang.String getVersion()
Return this RuleFactory version String

Specified by:
getVersion in interface RuleFactory
Returns:
This RuleFactory version String

getPredefinedRuleActions

public PredefinedRuleAction[] getPredefinedRuleActions(BasicPrivateLabel bpl)
Returns a list of predefined rule actions

Specified by:
getPredefinedRuleActions in interface RuleFactory
Parameters:
bpl - The context BasicPrivateLabel instance
Returns:
The list of predefined rule actions (or null, if no predefined rule actions have been defined

getGeoCorridorDescription

public java.lang.String getGeoCorridorDescription(Account account,
                                                  java.lang.String corrID)
Gets the description for the specified GeoCorridor ID. Will return null if GeoCorridor is not supported. Will return blank if the specified GeoCorridor ID was not found.

Specified by:
getGeoCorridorDescription in interface RuleFactory
Parameters:
account - The Account that owns the specified GeoCorridor ID
corrID - The GeoCorridor ID