Skip navigation links

oracle.rules.sdk2.ruleset
Class RuleCommon

java.lang.Object
oracle.rules.sdk2.dictionary.DictionaryObject
oracle.rules.sdk2.dictionary.DictionaryComponent
oracle.rules.sdk2.ruleset.RuleComponent
oracle.rules.sdk2.ruleset.RuleCommon

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Direct Known Subclasses:

Rule, RuleSheet

public abstract class RuleCommon

extends RuleComponent

Common superclass of Rule and RuleSheet

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_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_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

abstract java.util.List<Action>	getActions()
SettableProperty<java.lang.Boolean>	getActiveProperty() Get Active Property.
SettableProperty<java.lang.Boolean>	getAdvancedModeProperty() Get AdvancedMode 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.
SettableProperty<java.lang.Boolean>	getLogicalProperty() Get Logical Property.
Pattern	getPattern(int i) Shorthand for getPatternTable.getPattern(i)
java.util.List<Pattern>	getPatterns()
PatternTable	getPatternTable() table containing the patterns for the rule
TableProperty<Pattern>	getPatternTableProperty() Get PatternTable Property.
java.lang.String	getPriority() Get a String containing a priority level or a negative or positive integer.
java.lang.String[]	getPriorityOptions() get list of predefined priority levels highest = 3000 higher = 2000 high = 1000 medium = 0 low = -1000 lower = -2000 lowest = -3000
TranslatedProperty	getPriorityProperty() Get Priority Property.
int	getReturnExpressionTableSize()
Pattern	getRoot() Return the first pattern, creating if needed
SimpleTestTable	getSimpleTestTable() Get the SimpleTestTable for the non-Advanced Mode rule or DT
SettableProperty<java.lang.Boolean>	getTreeModeProperty() Get TreeMode Property.
boolean	isActive() Returns value of the active property.
boolean	isAdvancedMode() is advanced mode set?
boolean	isCustomizable() are the date effectivity properties customizable?
boolean	isLogical() is the "logical" property set?
boolean	isTreeMode() is tree mode set?
boolean	isValid() is the rule valid?
boolean	isVisible() Is the rule or DT visible according the containing ruleset's visibility filter?
boolean	mustBeAdvancedMode() whether this rule or DT must be shown in advanced mode.
boolean	mustNotBeTreeMode()
void	setActive(boolean active) sets the active property
void	setAdvancedMode(boolean flag) set advanced mode.
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	setLogical(boolean logical) set "logical" property
void	setPriority(java.lang.String priority) Set a String containing a priority a level, e.g.
void	setTreeMode(boolean flag) Set tree mode.

Methods inherited from class oracle.rules.sdk2.ruleset.RuleComponent

get, getParent, getParentTable, parentAction, parentActionContext, 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, put, 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

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Method Detail

getActions

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

getPatterns

public java.util.List<Pattern> getPatterns()

getReturnExpressionTableSize

public int getReturnExpressionTableSize()

getSimpleTestTable

public SimpleTestTable getSimpleTestTable()

Get the SimpleTestTable for the non-Advanced Mode rule or DT

Returns:

SimpleTestTable or null if the rule or DT is in Advanced Mode

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 valid?

Returns:

boolean result

getPatternTableProperty

public TableProperty<Pattern> getPatternTableProperty()

Get PatternTable Property.

Returns:

Pattern TableProperty

getPatternTable

public PatternTable getPatternTable()

table containing the patterns for the rule

getLogicalProperty

public SettableProperty<java.lang.Boolean> getLogicalProperty()

Get Logical Property.

Returns:

boolean SettableProperty

isLogical

public boolean isLogical()

is the "logical" property set?

Returns:

boolean

setLogical

public void setLogical(boolean logical)

set "logical" property

Parameters:

logical - boolean value

getAdvancedModeProperty

public SettableProperty<java.lang.Boolean> getAdvancedModeProperty()

Get AdvancedMode Property.

Returns:

boolean SettableProperty

isAdvancedMode

public boolean isAdvancedMode()

is advanced mode set?

setAdvancedMode

public void setAdvancedMode(boolean flag)

set advanced mode.

Parameters:

flag - boolean flag

getTreeModeProperty

public SettableProperty<java.lang.Boolean> getTreeModeProperty()

Get TreeMode Property.

Returns:

boolean SettableProperty

isTreeMode

public boolean isTreeMode()

is tree mode set?

setTreeMode

public void setTreeMode(boolean flag)

Set tree mode. Must call RuleDictionary.update(java.util.List<oracle.rules.sdk2.exception.SDKWarning>) after changing tree mode.

Parameters:

flag - boolean flag

getPattern

public Pattern getPattern(int i)

Shorthand for getPatternTable.getPattern(i)

Parameters:

i - ordinal of pattern to retrieve from PatternTable

Returns:

the Pattern

Throws:

java.lang.IndexOutOfBoundsException

getRoot

public Pattern getRoot()

Return the first pattern, creating if needed

Returns:

Pattern

getPriorityProperty

public TranslatedProperty getPriorityProperty()

Get Priority Property.

Returns:

String SettableProperty

getPriority

public java.lang.String getPriority()

Get a String containing a priority level or a negative or positive integer. Defaults to "medium".

setPriority

public void setPriority(java.lang.String priority)

Set a String containing a priority a level, e.g. "high", or a negative or positive integer. Defaults to "medium".

getPriorityOptions

public java.lang.String[] getPriorityOptions()

get list of predefined priority levels

 highest = 3000
 higher  = 2000
 high    = 1000
 medium  = 0
 low     = -1000
 lower   = -2000
 lowest  = -3000
 

Returns:

array of priorities

mustBeAdvancedMode

public boolean mustBeAdvancedMode()

whether this rule or DT must be shown in advanced mode. In advanced mode, patterns must be shown and many actions may be nested.

Returns:

whether or not rule or DT must be in advanced mode

mustNotBeTreeMode

public boolean mustNotBeTreeMode()

isVisible

public boolean isVisible()

Is the rule or DT visible according the containing ruleset's visibility filter?

Returns:

boolean

Skip navigation links