Skip navigation links

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

E10663-05


oracle.rules.sdk2.ruleset
Class RuleSet

java.lang.Object
  extended by oracle.rules.sdk2.dictionary.DictionaryObject
      extended by oracle.rules.sdk2.dictionary.DictionaryComponent
          extended by oracle.rules.sdk2.ruleset.RuleComponent
              extended by oracle.rules.sdk2.ruleset.RuleSet

All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public class RuleSet
extends RuleComponent

A RuleSet has a name, a table of Rules, and a table of RuleSheets.

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

 

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_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_ID_COUNTER, 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_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_RETURN_TYPE, PROP_RIGHT, PROP_RIGHT_SEPARATOR, PROP_RULE_FIRING_LIMIT, 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_TREE, PROP_TREE_MODE, PROP_TYPE, PROP_TYPE_ID, PROP_TYPE_IDS, PROP_TYPES, PROP_UPDATE_NUMBER, 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

 

Method Summary
 java.lang.String generateRL()
          Validates then generates RL code for the rule set.
 SettableProperty<java.lang.Boolean> getActiveProperty()
          Get Active Property.
 java.lang.String getCalendarForm()
          Get Calendar Form (Date, Time, or DateTime).
 java.lang.String[] getCalendarFormOptions()
           
 SettableProperty<java.lang.String> getCalendarFormProperty()
          Get CalendarForm Property.
 int getCalendarFormSelected()
           
 java.lang.String getEffectiveEndDate()
          Get Effective End Date.
 SettableProperty<java.lang.String> getEffectiveEndDateProperty()
          Get EffectiveEndDate Property.
 java.lang.String getEffectiveStartDate()
          Get Effective Start Date.
 SettableProperty<java.lang.String> getEffectiveStartDateProperty()
          Get EffectiveStartDate Property.
 Rule getRule(int index)
          Get the Rule at the given index
 Rule getRuleByID(DOID id)
          Get the Rule with the given ID
 Rule getRuleByName(java.lang.String name)
          Get the Rule with the given name
 RuleSheetTable getRuleSheetTable()
          Get the table of rule sheets (decision tables) used to access and rearrange rule sheets in the RuleSet.
 TableProperty<RuleSheet> getRuleSheetTableProperty()
          Get RuleSheetTable Property.
 RuleTable getRuleTable()
          Get the table of rules used to access and rearrange rules in the RuleSet.
 TableProperty<Rule> getRuleTableProperty()
          Get RuleTable Property.
 SimpleTestTable getVisibilityFilter()
           
 boolean isActive()
          Returns value of the active property.
 boolean isCustomizable()
          are the date effectivity properties customizable?
 boolean isValid()
          is the rule set valid?
 boolean isVisibilityFilterEnabled()
           
 java.lang.Object put(java.lang.String key, java.lang.Object value)
          Generic property setter.
 void setActive(boolean active)
          sets the active property
 void setCalendarForm(java.lang.String form)
           
 void setCustomizable(boolean flag)
          set whether this expression is customizable
 void setEffectiveEndDate(java.lang.String date)
           
 void setEffectiveStartDate(java.lang.String date)
           
 void setVisibilityFilterEnabled(boolean flag)
           

 

Methods inherited from class oracle.rules.sdk2.ruleset.RuleComponent
get, getParent, getParentTable, parentAction, parentComponent, parentFunction, parentPattern, parentRule, parentRuleCommon, parentRuleSheet, parentVariable, RHSRuleVariables

 

Methods inherited from class oracle.rules.sdk2.dictionary.DictionaryComponent
clear, containsKey, containsValue, entrySet, get, getAlias, getAlias, getAliasProperty, getAllReferences, getCustom, getDependents, getDescription, getDescriptionProperty, getDiff, getDiffProperties, getDiffs, getFullyQualifiedAlias, getFullyQualifiedName, getIndex, getIndex, getName, getNameProperty, getNext, getObjectPath, getOptions, getPrevious, getProperties, getProperty, getSelected, hasDiff, init, isAliasDistinct, isEmpty, isFullyQualifiedName, isNameDistinct, keySet, putAll, remove, setAlias, setCustom, setDescription, setName, 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, getReferences, 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 java.util.Map
equals, hashCode

 

Method Detail

getRule

public Rule getRule(int index)
Get the Rule at the given index
Returns:
the Rule

getRuleByID

public Rule getRuleByID(DOID id)
Get the Rule with the given ID
Returns:
the Rule

getRuleByName

public Rule getRuleByName(java.lang.String name)
Get the Rule with the given name
Returns:
the Rule

generateRL

public java.lang.String generateRL()
                            throws SDKException
Validates then generates RL code for the rule set. Used in conjunction with the code produced by (@LINK generateModelRL()).
Returns:
A String containing the executable RL rule set
Throws:
SDKException

getRuleTableProperty

public TableProperty<Rule> getRuleTableProperty()
Get RuleTable Property.
Returns:
Rule TableProperty

getRuleTable

public RuleTable getRuleTable()
Get the table of rules used to access and rearrange rules in the RuleSet.

getRuleSheetTableProperty

public TableProperty<RuleSheet> getRuleSheetTableProperty()
Get RuleSheetTable Property.
Returns:
RuleSheet TableProperty

getRuleSheetTable

public RuleSheetTable getRuleSheetTable()
Get the table of rule sheets (decision tables) used to access and rearrange rule sheets in the RuleSet.

isCustomizable

public boolean isCustomizable()
are the date effectivity properties customizable?
Returns:
boolean

setCustomizable

public void setCustomizable(boolean flag)
set whether this expression is customizable
Parameters:
flag - boolean

getActiveProperty

public SettableProperty<java.lang.Boolean> getActiveProperty()
Get Active Property.
Returns:
boolean SettableProperty

isActive

public boolean isActive()
Returns value of the active property.
Returns:
boolean

setActive

public void setActive(boolean active)
sets the active property
Parameters:
active - boolean value

getEffectiveStartDateProperty

public SettableProperty<java.lang.String> getEffectiveStartDateProperty()
Get EffectiveStartDate Property.
Returns:
String SettableProperty

getEffectiveStartDate

public java.lang.String getEffectiveStartDate()
Get Effective Start Date.
Returns:
String

setEffectiveStartDate

public void setEffectiveStartDate(java.lang.String date)

getEffectiveEndDateProperty

public SettableProperty<java.lang.String> getEffectiveEndDateProperty()
Get EffectiveEndDate Property.
Returns:
String SettableProperty

getEffectiveEndDate

public java.lang.String getEffectiveEndDate()
Get Effective End Date.
Returns:
String

setEffectiveEndDate

public void setEffectiveEndDate(java.lang.String date)

getCalendarFormProperty

public SettableProperty<java.lang.String> getCalendarFormProperty()
Get CalendarForm Property.
Returns:
String SettableProperty

getCalendarForm

public java.lang.String getCalendarForm()
Get Calendar Form (Date, Time, or DateTime). Default is DateTime. This applies to both the effective start date property and the the effective end date property.
Returns:
String

setCalendarForm

public void setCalendarForm(java.lang.String form)

getCalendarFormOptions

public java.lang.String[] getCalendarFormOptions()

getCalendarFormSelected

public int getCalendarFormSelected()

isValid

public boolean isValid()
is the rule set valid?
Returns:
boolean result

getVisibilityFilter

public SimpleTestTable getVisibilityFilter()

isVisibilityFilterEnabled

public boolean isVisibilityFilterEnabled()

setVisibilityFilterEnabled

public void setVisibilityFilterEnabled(boolean flag)

put

public java.lang.Object put(java.lang.String key,
                            java.lang.Object value)
Description copied from class: DictionaryComponent
Generic property setter. Throws runtime exceptions for incorrect arguments. Please see the specific bean class for a list of properties, their types, and permissible values.

A put() with either null key or null value throws a NullPointerException.

A put() with a key that is not a String throws a ClassCastException

A put() of a value that is not of the correct type for the key throws a ClassCastException.

Bean properties which have no set() method are read only, and cannot be modified using the put(). Attempting to do so throws a runtime IllegalArgumentException. PROP_ID, and PROP_*_SELECTED are always read only.

Specified by:
put in interface java.util.Map<java.lang.String,java.lang.Object>
Overrides:
put in class DictionaryComponent
Parameters:
key - the key of the property to set
value - the value of the named property to set
Returns:
the previous value of the property

Skip navigation links

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

E10663-05


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