Oracle Fusion Middleware Java API Reference for Oracle Business Rules
11g Release 1 (11.1.1.7)

E10663-11

oracle.rules.sdk2.datamodel
Class DecisionFunction

java.lang.Object
  extended by oracle.rules.sdk2.dictionary.DictionaryObject
      extended by oracle.rules.sdk2.dictionary.DictionaryComponent
          extended by oracle.rules.sdk2.datamodel.ModelComponent
              extended by oracle.rules.sdk2.datamodel.DecisionFunction
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>, Callable

public class DecisionFunction
extends ModelComponent
implements Callable

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class oracle.rules.sdk2.dictionary.DictionaryComponent
DictionaryComponent.Diff, DictionaryComponent.DiffType
 
Nested classes/interfaces inherited from interface java.util.Map
java.util.Map.Entry<K,V>
 
Field Summary
static java.lang.String UNLIMITED_FIRING
           
 
Fields inherited from class oracle.rules.sdk2.dictionary.DictionaryComponent
PROP_ACCESS, PROP_ACTION_SELECTED, PROP_ACTION_TABLE, PROP_ACTIVE, PROP_ADVANCED_MODE, PROP_AGGREGATE, PROP_AGGREGATE_TABLE, PROP_ALIAS, PROP_ALLOW_GAPS, PROP_ALWAYS_SELECTED, PROP_ARRAY, PROP_ARRAY_COMPONENT_TYPE, PROP_ARRAY_COMPONENT_TYPE_ID, PROP_ARRAY_FACT_TYPE_TABLE, PROP_AUTO_CONFLICT_RESOLUTION, PROP_AUTO_PATTERN_PROPERTY, PROP_BODY, PROP_BUCKET_ID_TABLE, PROP_BUCKET_SET, PROP_BUCKET_SET_ID, PROP_BUCKET_SET_TABLE, PROP_BUCKET_TABLE, PROP_CALENDAR_FORM, PROP_CHECK_RULE_FLOW, PROP_CHILD_DIMENSION_NODES, PROP_CONFLICT, PROP_CONFLICT_POLICY, PROP_CONNECTIVE, PROP_CONSTANT, PROP_CONSTRUCTOR, PROP_CONSTRUCTOR_TABLE, PROP_CREATION_UPDATE_NUMBER, PROP_CURSOR_POSITION, PROP_CUSTOM_BINDING, PROP_CUSTOMIZABLE, PROP_CUSTOMIZABLE_TEMPLATE, PROP_DATA_MODEL, PROP_DATA_SOURCE, PROP_DECISION_FUNCTION, PROP_DECISION_FUNCTION_INPUT_TABLE, PROP_DECISION_FUNCTION_OUTPUT_TABLE, PROP_DECISION_FUNCTION_RULESET_TABLE, PROP_DECISION_FUNCTION_TABLE, PROP_DESCRIPTION, PROP_DICTIONARY_LINK_TABLE, PROP_DIMENSION_NODE_TABLE, PROP_DIMENSION_TABLE, PROP_DT_ACTION_NODE_TABLE, PROP_DT_ACTION_PARAMETER_NAME, PROP_DTACTION_TABLE, PROP_DTRULE_TABLE, PROP_EFFECTIVE_END_DATE, PROP_EFFECTIVE_START_DATE, PROP_ENUM, PROP_ENUM_BUCKET_SET, PROP_ENUM_BUCKET_SET_ID, PROP_ENUM_TYPE, PROP_EXCEPTION_IDS, PROP_EXCEPTIONS, PROP_EXCLUDED, PROP_EXPRESSION, PROP_EXPRESSION_TABLE, PROP_FACT_PATH, PROP_FACT_PATH_IDS, PROP_FACT_TYPE, PROP_FACT_TYPE_ID, PROP_FACT_TYPE_TABLE, PROP_FIELD_TABLE, PROP_FINAL, PROP_FORM, PROP_FORMAL_PARAMETER_TABLE, PROP_FUNCTION, PROP_FUNCTION_ID, PROP_FUNCTION_SIGNATURE, PROP_FUNCTION_TABLE, PROP_GENERATED_FROM, PROP_ID, PROP_INCLUDED, PROP_INTERFACE, PROP_INTERFACE_IDS, PROP_INTERFACES, PROP_IS_ABSTRACT, PROP_IS_CONSTANT, PROP_IS_ENUM, PROP_IS_FINAL, PROP_IS_JAXB2, PROP_IS_PRIMARY_KEY, PROP_IS_STATIC, PROP_IS_TOPLEVEL_VIEW_OBJECT, PROP_LEFT, PROP_LIFECYCLE, PROP_LIFECYCLE_DESCRIPTION, PROP_LIST, PROP_LIST_CONTENT_TYPE, PROP_LIST_CONTENT_TYPE_ID, PROP_LOCAL, PROP_LOGICAL, PROP_METHOD_TABLE, PROP_MODIFIERS, PROP_NAME, PROP_NAMESPACE, PROP_NESTED_TABLE, PROP_NO_CONFLICT, PROP_NODE_NAME, PROP_OPERATOR, PROP_OPERATOR_ID, PROP_ORDER_RULES_BY_BUCKET, PROP_OTHERWISE, PROP_OUTPUT_TYPES, PROP_OVERLOADED_PARAMETER_TABLE, PROP_OVERRIDDEN_BY, PROP_OVERRIDE, PROP_PACKAGE, PROP_PARAMETER_ALIAS, PROP_PARAMETER_ID, PROP_PARAMETER_LIST, PROP_PARAMETER_NAME, PROP_PARAMETER_REQUIRED, PROP_PARAMETER_TYPE_IDS, PROP_PARAMETER_TYPES, PROP_PARENT_DIMENSION_NODE, PROP_PATTERN_TABLE, PROP_PREFIX_LINKED_NAMES, PROP_PRIORITY, PROP_PRIVATE_BUCKET_SET, PROP_PROPERTIES, PROP_PROPERTY_TABLE, PROP_READABLE, PROP_REF_ID, PROP_REPORT_BYUSE_NAMES, PROP_REPORT_PATTERNS, PROP_RESOLVED_TARGET, PROP_RESOLVED_VALUE, PROP_RESOURCE_BUNDLE, PROP_RETURN_TYPE, PROP_RIGHT, PROP_RIGHT_SEPARATOR, PROP_RULE_FIRING_LIMIT, PROP_RULE_FIRING_LIMIT_ERROR, PROP_RULE_REPORT_TABLE, PROP_RULE_SET_TABLE, PROP_RULE_SHEET_TABLE, PROP_RULE_TABLE, PROP_RULESET, PROP_RUN_AFTER, PROP_RUN_BEFORE, PROP_SERVICE_CONFIGURATION, PROP_SERVICE_NAME, PROP_SERVICE_NAMESPACE, PROP_SHARED_BUCKET_SET, PROP_SHARED_BUCKET_SET_ID, PROP_SHOW_CONSTANTS, PROP_SHOW_FUNCTIONS, PROP_SHOW_VARIABLES, PROP_SIMPLE_TEST_TABLE, PROP_SOURCE, PROP_STATELESS, PROP_STATIC, PROP_SUPER_CLASS, PROP_SUPER_CLASS_ID, PROP_SUPPORT_XPATH, PROP_SUPPORTS_XPATH_ENABLED, PROP_SYSTEM, PROP_TARGET, PROP_TARGET_PACKAGE, PROP_TEST_FORM, PROP_TIMESTAMP, PROP_TOKEN_UNDER_CURSOR, PROP_TRANSLATED_ALIAS, PROP_TRANSLATED_DESCRIPTION, PROP_TRANSLATED_PARAMETER_LIST, PROP_TRANSLATED_VARIABLE, PROP_TREE, PROP_TREE_MODE, PROP_TYPE, PROP_TYPE_ID, PROP_TYPE_IDS, PROP_TYPES, PROP_UNSAVED_TRANSLATED_ALIAS, PROP_UNSAVED_TRANSLATED_DESCRIPTION, PROP_UPDATE_NUMBER, PROP_UPDATE_TIME, PROP_VALIDATION_UPDATE_NUMBER, PROP_VALUE, PROP_VALUES, PROP_VARIABLE, PROP_VARIABLE_TABLE, PROP_VERSION, PROP_VISIBILITY_FILTER, PROP_VISIBILITY_FILTER_ENABLED, PROP_VISIBLE, PROP_WEB_SERVICE, PROP_WRITABLE, PROP_XML_NAME
 
Constructor Summary
DecisionFunction(DictionaryObject parent)
           
 
Method Summary
 java.util.List<Action> getActions()
           
 ActionTable getActionTable()
          get ActionTable.
 TableProperty<Action> getActionTableProperty()
          Get ActionTable Property.
 SettableProperty<java.lang.Boolean> getCheckRuleFlowProperty()
          Get CheckRuleFlow Property.
 DecisionFunctionFactTable getDecisionFunctionInputTable()
          Get Decision Function Input Table
 TableProperty<DecisionFunctionFact> getDecisionFunctionInputTableProperty()
          Get DecisionFunctionInputTable Property.
 java.lang.String[] getDecisionFunctionOptions()
          Deprecated. use #getDecisionFunctionRuleSetTable().getPrototype().getDecisionFunctionProperty().getOptions()
 DecisionFunctionFactTable getDecisionFunctionOutputTable()
          Get Decision Function Output Table
 TableProperty<DecisionFunctionFact> getDecisionFunctionOutputTableProperty()
          Get DecisionFunctionOutputTable Property.
 DecisionFunctionRuleSetTable getDecisionFunctionRuleSetTable()
          get DecisionFunctionRuleSetTable
 TableProperty<DecisionFunctionRuleSet> getDecisionFunctionRuleSetTableProperty()
          Get DecisionFunctionRuleSetTable Property.
 DOID[] getExceptionIDs()
           
 java.lang.String getFunctionSignature()
          Get the decision function signature -- an alias-substituted RL function signature
 Modifiers getModifiers()
           
 java.lang.String getParameterList()
          Get parameter list as a String
 java.lang.String getParameterList(boolean translate)
          Get optionally translated parameter list as a String
 java.util.List<? extends Parameter> getParameters()
          Get all the parameters of the callable interface (Function/Method/Constructor) Function returns FormalParameterTable and Method/Constructor return OverloadedParameterTable
 int getReturnExpressionTableSize()
           
 java.lang.String getRuleFiringLimit()
          Get limit on how many rules can fire.
 SettableProperty<java.lang.Boolean> getRuleFiringLimitErrorProperty()
          get RuleFiringLimitError Property.
 java.lang.String[] getRuleFiringLimitOptions()
          get Rule firing limit options ("unlimited") User can also enter a positive integer.
 TranslatedProperty getRuleFiringLimitProperty()
          get RuleFiringLimit Property.
 java.lang.String[] getRuleSetOptions()
          Deprecated. use #getDecisionFunctionRuleSetTable().getPrototype().getRuleSetOptions()
 java.util.Collection<java.lang.String> getRuleSets()
          get all the rulesets referenced directly or indirectly by this decision function (including referenced decision functions) Duplicates are eliminated.
 SettableProperty<java.lang.Boolean> getStatelessProperty()
          Get Stateless Property.
 java.lang.String getType()
          Get alias of the return type
 DOID getTypeID()
          Get alias of the return type
 SettableProperty<java.lang.Boolean> getWebServiceProperty()
          Get WebService Property.
 java.lang.String getWrapperSignature()
          Deprecated. No replacement.
 boolean isCheckRuleFlow()
          is this decision function type-checked for rule flow?
 boolean isRuleFiringLimitError()
          true if reaching the rule firing limit is an error, false otherwise.
 boolean isStateless()
          is this decision function stateless (RuleSession can be returned to pool)?
 boolean isWebService()
          is this decision function to be exposed as a web service?
 void setCheckRuleFlow(boolean flag)
          Set whether this decision function should be checked for rule flow
 void setRuleFiringLimit(java.lang.String limit)
          set limit on how many rules to fire.
 void setRuleFiringLimitError(boolean isLimitError)
          true if reaching the rule firing limit is an error, false otherwise.
 void setStateless(boolean flag)
          Set whether this decision function is stateless (RuleSession can be returned to pool)
 void setWebService(boolean flag)
          Set whether this decision function to be exposed as a web service
 
Methods inherited from class oracle.rules.sdk2.datamodel.ModelComponent
getParent, getParentTable, getVisibleProperty, isVisible, setVisible
 
Methods inherited from class oracle.rules.sdk2.dictionary.DictionaryComponent
clear, containsKey, containsValue, entrySet, get, getAlias, getAlias, getAlias, getAlias, getAliasProperty, getAllReferences, getCustom, getDependents, getDescription, getDescription, getDescriptionProperty, getDiff, getDiffProperties, getDiffs, getFullyQualifiedAlias, getFullyQualifiedName, getIndex, getIndex, getName, getNameProperty, getNext, getObjectPath, getOptions, getPrevious, getProperties, getProperty, getReferences, getSelected, getTranslatedAlias, getTranslatedAlias, getTranslatedDescription, hasDiff, init, init, isAliasDistinct, isEmpty, isFullyQualifiedName, isNameDistinct, isSystemProperty, isUnsavedTranslatedAlias, isUnsavedTranslatedDescription, keySet, put, putAll, remove, setAlias, setAlias, setCustom, setDescription, setDescription, setName, setTranslatedAlias, setTranslatedDescription, size, validate, validate, values
 
Methods inherited from class oracle.rules.sdk2.dictionary.DictionaryObject
equals, exists, getAEReferences, getCombinedDataModel, getContainedIDs, getContainedIDs, getDataModel, getDictionary, getID, getIndent, getLevel, getObjectType, getParentByClass, getParentComponent, getParentComponentTable, getParentObject, getRuleSet, getState, getWarnings, hashCode, isModified, validate
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface oracle.rules.sdk2.datamodel.Callable
getDescription, getFullyQualifiedName, getID, isVisible, setDescription, setVisible
 
Methods inherited from interface java.util.Map
equals, hashCode
 

Field Detail

UNLIMITED_FIRING

public static final java.lang.String UNLIMITED_FIRING
See Also:
Constant Field Values
Constructor Detail

DecisionFunction

public DecisionFunction(DictionaryObject parent)
Method Detail

getRuleFiringLimitErrorProperty

public SettableProperty<java.lang.Boolean> getRuleFiringLimitErrorProperty()
get RuleFiringLimitError Property.

Returns:
SettableProperty

isRuleFiringLimitError

public boolean isRuleFiringLimitError()
true if reaching the rule firing limit is an error, false otherwise.

Returns:
boolean

setRuleFiringLimitError

public void setRuleFiringLimitError(boolean isLimitError)
true if reaching the rule firing limit is an error, false otherwise.

Parameters:
boolean -

getRuleFiringLimitProperty

public TranslatedProperty getRuleFiringLimitProperty()
get RuleFiringLimit Property.

Returns:
TranslatedProperty

getRuleFiringLimit

public java.lang.String getRuleFiringLimit()
Get limit on how many rules can fire. A positive integer or "unlimited".

Returns:
string representing the limit

getRuleFiringLimitOptions

public java.lang.String[] getRuleFiringLimitOptions()
get Rule firing limit options ("unlimited") User can also enter a positive integer.

Returns:
a string list of firing limit options

setRuleFiringLimit

public void setRuleFiringLimit(java.lang.String limit)
set limit on how many rules to fire.

Parameters:
limit - a positive integer or "unlimited".

getWebServiceProperty

public SettableProperty<java.lang.Boolean> getWebServiceProperty()
Get WebService Property.

Returns:
Boolean SettableProperty

isWebService

public boolean isWebService()
is this decision function to be exposed as a web service?

Returns:
boolean

setWebService

public void setWebService(boolean flag)
Set whether this decision function to be exposed as a web service

Parameters:
flag -

getCheckRuleFlowProperty

public SettableProperty<java.lang.Boolean> getCheckRuleFlowProperty()
Get CheckRuleFlow Property.

Returns:
Boolean SettableProperty

isCheckRuleFlow

public boolean isCheckRuleFlow()
is this decision function type-checked for rule flow?

Returns:
boolean

setCheckRuleFlow

public void setCheckRuleFlow(boolean flag)
Set whether this decision function should be checked for rule flow

Parameters:
flag -

getStatelessProperty

public SettableProperty<java.lang.Boolean> getStatelessProperty()
Get Stateless Property.

Returns:
Boolean SettableProperty

isStateless

public boolean isStateless()
is this decision function stateless (RuleSession can be returned to pool)?

Returns:
boolean

setStateless

public void setStateless(boolean flag)
Set whether this decision function is stateless (RuleSession can be returned to pool)

Parameters:
flag -

getDecisionFunctionInputTableProperty

public TableProperty<DecisionFunctionFact> getDecisionFunctionInputTableProperty()
Get DecisionFunctionInputTable Property.

Returns:
DecisionFunctionFact TableProperty

getDecisionFunctionInputTable

public DecisionFunctionFactTable getDecisionFunctionInputTable()
Get Decision Function Input Table

Returns:
DecisionFunctionInputTable

getDecisionFunctionRuleSetTableProperty

public TableProperty<DecisionFunctionRuleSet> getDecisionFunctionRuleSetTableProperty()
Get DecisionFunctionRuleSetTable Property.

Returns:
DecisionFunctionRuleSet TableProperty

getDecisionFunctionRuleSetTable

public DecisionFunctionRuleSetTable getDecisionFunctionRuleSetTable()
get DecisionFunctionRuleSetTable

Returns:
DecisionFunctionRuleSetTable

getActionTableProperty

public TableProperty<Action> getActionTableProperty()
Get ActionTable Property.

Returns:
Action TableProperty

getActionTable

public ActionTable getActionTable()
get ActionTable. Actions are executed after rulesets are pushed on the stack but before asserting input facts. Actions may reference decision function inputs but not outputs. Actions may assert new outputs, however.

Returns:
ActionTable

getRuleSetOptions

@Deprecated
public java.lang.String[] getRuleSetOptions()
Deprecated. use #getDecisionFunctionRuleSetTable().getPrototype().getRuleSetOptions()

get options for RuleSet aliases, used in ading a new DecisionFunctionRuleSet The options do not include already selected rulesets. Nor do the options include "". This method is intended for use in a shuttle UI.

Returns:
array of ruleset aliases

getDecisionFunctionOptions

@Deprecated
public java.lang.String[] getDecisionFunctionOptions()
Deprecated. use #getDecisionFunctionRuleSetTable().getPrototype().getDecisionFunctionProperty().getOptions()

get options for decision function aliases, used in ading a new DecisionFunctionRuleSet The options do not include already selected decision functions. Nor do the options include "". This method is intended for use in a shuttle UI.

Returns:
array of decision function aliases

getDecisionFunctionOutputTableProperty

public TableProperty<DecisionFunctionFact> getDecisionFunctionOutputTableProperty()
Get DecisionFunctionOutputTable Property.

Returns:
DecisionFunctionFact TableProperty

getDecisionFunctionOutputTable

public DecisionFunctionFactTable getDecisionFunctionOutputTable()
Get Decision Function Output Table

Returns:
DecisionFunctionOutputTable

getRuleSets

public java.util.Collection<java.lang.String> getRuleSets()
get all the rulesets referenced directly or indirectly by this decision function (including referenced decision functions) Duplicates are eliminated.

Returns:
Collection of ruleset names

getFunctionSignature

public java.lang.String getFunctionSignature()
Get the decision function signature -- an alias-substituted RL function signature

Returns:
String

getWrapperSignature

@Deprecated
public java.lang.String getWrapperSignature()
Deprecated. No replacement.

Get the decision function wrapper signature -- an RL function that accepts and returns DOM Nodes

Returns:
String

getParameters

public java.util.List<? extends Parameter> getParameters()
Description copied from interface: Callable
Get all the parameters of the callable interface (Function/Method/Constructor) Function returns FormalParameterTable and Method/Constructor return OverloadedParameterTable

Specified by:
getParameters in interface Callable
Returns:
all the formal parameters of the callable interface

getTypeID

public DOID getTypeID()
Description copied from interface: Callable
Get alias of the return type

Specified by:
getTypeID in interface Callable
Returns:
alias of the return type

getType

public java.lang.String getType()
Description copied from interface: Callable
Get alias of the return type

Specified by:
getType in interface Callable
Returns:
alias of the return type

getParameterList

public java.lang.String getParameterList()
Get parameter list as a String

Specified by:
getParameterList in interface Callable
Returns:
return the method's parameter list in the format paramType, paramType ...

getParameterList

public java.lang.String getParameterList(boolean translate)
Get optionally translated parameter list as a String

Specified by:
getParameterList in interface Callable
Returns:
return the method's parameter list in the format paramType, paramType ...

getReturnExpressionTableSize

public int getReturnExpressionTableSize()

getActions

public java.util.List<Action> getActions()

getModifiers

public Modifiers getModifiers()
Specified by:
getModifiers in interface Callable

getExceptionIDs

public DOID[] getExceptionIDs()
Specified by:
getExceptionIDs in interface Callable

Oracle Fusion Middleware Java API Reference for Oracle Business Rules
11g Release 1 (11.1.1.7)

E10663-11

Copyright © 2013, Oracle and/or its affiliates. All rights reserved.