Package oracle.rules.sdk2.datamodel

Class DSLParameter

java.lang.Object

oracle.rules.sdk2.dictionary.DictionaryObject

oracle.rules.sdk2.dictionary.DictionaryComponent<T>

oracle.rules.sdk2.datamodel.ModelComponent<T>

oracle.rules.sdk2.datamodel.TypedComponent<T>

oracle.rules.sdk2.datamodel.ConstrainableComponent<FormalParameter>

oracle.rules.sdk2.datamodel.FormalParameter

oracle.rules.sdk2.datamodel.DSLParameter

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Object>, Parameter, ScopedVariable

public class DSLParameter
extends FormalParameter

Since:

12.1.2

Author:

Ganesh RK

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	DSLParameter.RelatedTypeValuesProperty

Nested classes/interfaces inherited from class oracle.rules.sdk2.dictionary.DictionaryComponent

DictionaryComponent.Diff<T extends DictionaryComponent>, DictionaryComponent.DiffSummary, DictionaryComponent.DiffType

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FORM_EXPRESSION
static final String	FORM_VALUE
static final String	FORM_VARIABLE

Fields inherited from class oracle.rules.sdk2.dictionary.DictionaryComponent

PROP_ACCESS, PROP_ACTION_SELECTED, PROP_ACTION_TABLE, PROP_ACTIVE, PROP_ACTUAL_TEST_OUTPUT_TABLE, PROP_ADHOC_TEST_VALIDATION, 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_AUTO_SYNC, 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_DATA_MODEL, PROP_DATA_SOURCE, PROP_DECISION_FUNCTION, PROP_DECISION_FUNCTION_ID, PROP_DECISION_FUNCTION_INPUT_TABLE, PROP_DECISION_FUNCTION_OUTPUT_TABLE, PROP_DECISION_FUNCTION_RULESET_TABLE, PROP_DECISION_FUNCTION_TABLE, PROP_DECISION_MODEL, PROP_DESCRIPTION, PROP_DF_FACT, PROP_DF_FACT_ID, PROP_DICT_LOADING_EXTENSION, PROP_DICTIONARY_LINK_TABLE, PROP_DIMENSION_NODE_TABLE, PROP_DIMENSION_TABLE, PROP_DISALLOW_ERROR_SUPPRESSION, PROP_DRAFT, PROP_DSL_ID, PROP_DSL_PARAMETER_TABLE, PROP_DSL_TABLE, PROP_DSL_VALUE, 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_EXPECTED_TEST_OUTPUT_TABLE, PROP_EXPRESSION, PROP_EXPRESSION_TABLE, PROP_FACT_PATH, PROP_FACT_PATH_IDS, PROP_FACT_TABLE, PROP_FACT_TYPE, PROP_FACT_TYPE_ID, PROP_FACT_TYPE_IDS, PROP_FACT_TYPE_TABLE, PROP_FACT_TYPES, 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_GLOBAL_ALIAS, PROP_ID, PROP_INCLUDE_CHAINED_EXPR, 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_LINK_PATH, 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_NO_RULE_FIRED_IS_ERROR, 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_PARAM, PROP_PARAM_EXPRESSION, 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_PHRASE_SUGGESTION_FORM, PROP_PREFERENCES, PROP_PREFIX_LINKED_NAMES, PROP_PRIORITY, PROP_PRIVATE_BUCKET_SET, PROP_PROPERTIES, PROP_PROPERTY, PROP_PROPERTY_ID, PROP_PROPERTY_TABLE, PROP_PROPERTY_VALUE_TABLE, PROP_QUALIFIER_PATTERN, PROP_READABLE, PROP_REF_ID, PROP_REPORT_BYUSE_NAMES, PROP_REPORT_PATTERNS, PROP_RESOLVED_TARGET, PROP_RESOLVED_VALUE, PROP_RESOURCE_BUNDLE, PROP_RESTRICT_AUTO_SUGGESTIONS, PROP_RETURN_TYPE, PROP_RIGHT, PROP_RIGHT_SEPARATOR, PROP_RULE_EXEC_ALGORITHM, 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_SYNC_MARK, PROP_SYSTEM, PROP_TARGET, PROP_TARGET_PACKAGE, PROP_TEST_CASE_TABLE, PROP_TEST_FORM, PROP_TEST_INPUT_TABLE, PROP_TEST_MODEL, PROP_TEST_RESULT_TABLE, PROP_TEST_SUITE_TABLE, PROP_TEST_TEMPLATE_TABLE, PROP_TIMESTAMP, PROP_TOKEN_UNDER_CURSOR, PROP_TRANSLATED_ALIAS, PROP_TRANSLATED_DESCRIPTION, PROP_TRANSLATED_GLOBAL_ALIAS, PROP_TRANSLATED_PARAMETER_LIST, PROP_TRANSLATED_QUALIFIER_PATTERN, PROP_TRANSLATED_VALUE, PROP_TRANSLATED_VARIABLE, PROP_TREE, PROP_TREE_MODE, PROP_TYPE, PROP_TYPE_ID, PROP_TYPE_IDS, PROP_TYPES, PROP_UNIQUE_RULESETS, PROP_UNSAVED_TRANSLATED_ALIAS, PROP_UNSAVED_TRANSLATED_DESCRIPTION, PROP_UNSAVED_TRANSLATED_GLOBAL_ALIAS, PROP_UNSAVED_TRANSLATED_QUALIFIER_PATTERN, PROP_UNSAVED_TRANSLATED_VALUE, PROP_UPDATE_NUMBER, PROP_UPDATE_TIME, PROP_VALIDATION, PROP_VALIDATION_UPDATE_NUMBER, PROP_VALUE, PROP_VALUES, PROP_VARIABLE, PROP_VARIABLE_TABLE, PROP_VERBAL_RULE_TABLE, PROP_VERSION, PROP_VERTICAL_ORIENTATION, PROP_VISIBILITY_FILTER, PROP_VISIBILITY_FILTER_ENABLED, PROP_VISIBLE, PROP_WEB_SERVICE, PROP_WRITABLE, PROP_XML_NAME

Method Summary

Modifier and Type	Method	Description
Object	get(Object key)	Override hashtable get method.
String	getForm()	Get Form of DSL Parameter
String[]	getFormOptions()	Gets the untranslated Form Options for this DSL Parameter For Translated Options use {@link oracle.rules.sdk2.datamodel.DSLParameter# getFormProperty().getTranslatedOptions()}
TranslatedProperty	getFormProperty()
Choice.Kind	getKind()
String	getParametrizedAlias(boolean translate)	Get the Parametrized value of this parameter's alias which includes '{}'
String[]	getPropertyNames()
IDTable<FactType>	getRelatedTypes()	Get the FactTypes related to this DSL Parameter.
IDTableProperty<FactType>	getRelatedTypesProperty()
String[]	getRelatedTypeValues()	Get Aliases of FactTypes related to this DSL Parameter.
DSLParameter.RelatedTypeValuesProperty	getRelatedTypeValuesProperty()
String[]	getStoredPropertyNames()
Object	getVariableRL()
DSLParameter	init()	initialize the dictionary component to default values for name/alias.
DSLParameter	init(boolean translate)	initialize the dictionary component to default values for name/alias.
boolean	isAssignable()
Object	put(String key, Object value)	Override hashtable put method.
void	setForm(String form)	Set Form of DSL Parameter
void	setRelatedTypeValues(String... typeValues)	Set Aliases of FactTypes related to this DSL Parameter.
void	validate(List<SDKException> errors, List<SDKWarning> warnings)	Validate and append errors and warnings.

Methods inherited from class oracle.rules.sdk2.datamodel.FormalParameter

getCreationUpdateNumber, getFactTypeID, getTypeIDs, setTypeIDs, setVariableRL, setVariableRL

Methods inherited from class oracle.rules.sdk2.datamodel.ConstrainableComponent

getBucketSet, getBucketSetAlias, getBucketSetOptions, getBucketSetProperty, setBucketSet, setBucketSetByAlias

Methods inherited from class oracle.rules.sdk2.datamodel.TypedComponent

_getTypeID, getFullyQualifiedTypeName, getListContentType, getListContentTypeFullName, getListContentTypeID, getListContentTypeName, getListContentTypeOptions, getListContentTypeProperty, getType, getTypeID, getTypeName, getTypeOptions, getTypeProperty, getTypeSelected, isChainable, isCollection, isPrimitiveType, setListContentType, setListContentTypeID, setListContentTypeName, setType, setTypeID, setTypeName

Methods inherited from class oracle.rules.sdk2.datamodel.ModelComponent

getParent, getParentTable, getVisibleProperty, isVisible, setVisible

Methods inherited from class oracle.rules.sdk2.dictionary.DictionaryComponent

_get, _put, clear, containsKey, containsValue, entrySet, forceSync, getAEReferences, getAlias, getAlias, getAlias, getAlias, getAliasProperty, getAllReferences, getContainedDiffs, getCustom, getDependents, getDescription, getDescription, getDescriptionProperty, getDiff, getDiffMatchValue, getDiffProperties, getDiffs, getExprParserReferences, getFullyQualifiedAlias, getFullyQualifiedName, getIndex, getIndex, getName, getNameProperty, getNext, getNext, getObjectPath, getOptions, getPrevious, getPrevious, getProperties, getProperty, getReferences, getSelected, getTranslatedAlias, getTranslatedAlias, getTranslatedDescription, hasConflict, hasDiff, isAliasDistinct, isEmpty, isFullyQualifiedName, isModifiable, isNameDistinct, isSystemProperty, isUnsavedTranslatedAlias, isUnsavedTranslatedDescription, keySet, putAll, remove, removeDiff, setAlias, setAlias, setCustom, setDescription, setDescription, setName, setTranslatedAlias, setTranslatedDescription, size, validate, values

Methods inherited from class oracle.rules.sdk2.dictionary.DictionaryObject

_clearID, equals, exists, getAEReferenceCount, getCombinedDataModel, getContainedIDs, getContainedIDs, getDataModel, getDictionary, getID, getIndent, getObjectType, getParentByClass, getParentComponent, getParentComponentTable, getParentObject, getRuleSet, getState, getWarnings, hashCode, isModified, setID, validate, validate

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Methods inherited from interface oracle.rules.sdk2.datamodel.Parameter

getAlias, getAlias, getID

Methods inherited from interface oracle.rules.sdk2.ruleset.ScopedVariable

getAlias, getID

Field Details

FORM_VALUE

public static final String FORM_VALUE

See Also:

• Constant Field Values

FORM_VARIABLE

public static final String FORM_VARIABLE

See Also:

• Constant Field Values

FORM_EXPRESSION

public static final String FORM_EXPRESSION

See Also:

• Constant Field Values

Method Details

getStoredPropertyNames

public String[] getStoredPropertyNames()

Overrides:

getStoredPropertyNames in class ConstrainableComponent<FormalParameter>

Returns:

Array of property names which are persisted in the order in which they appear in the schema.

getPropertyNames

public String[] getPropertyNames()

Overrides:

getPropertyNames in class ConstrainableComponent<FormalParameter>

Returns:

Array of property names available.

init

public DSLParameter init()

Description copied from class: DictionaryComponent

initialize the dictionary component to default values for name/alias. The defaults are locale sensitive, although the translated alias is NOT set in order to avoid RUL-05928 (translated value not the same as resource bundle value) E.g. Rule newRule = ruleTable.add().init().

Overrides:

init in class DictionaryComponent<FormalParameter>

Returns:

this

init

public DSLParameter init(boolean translate)

Description copied from class: DictionaryComponent

initialize the dictionary component to default values for name/alias. The defaults are locale sensitive, and the translated alias is also set according to the argument flag E.g. Rule newRule = ruleTable.add().init(true).

Overrides:

init in class DictionaryComponent<FormalParameter>

Returns:

this

getForm

public String getForm()

Get Form of DSL Parameter

Returns:

DSL Parameter form

setForm

public void setForm(String form)

Set Form of DSL Parameter

Parameters:

form - DSL Parameter form

getRelatedTypeValues

public String[] getRelatedTypeValues()

Get Aliases of FactTypes related to this DSL Parameter. Relevant only if this parameter is of FORM_EXPRESSION.

Returns:

Aliases of related FactTypes

setRelatedTypeValues

public void setRelatedTypeValues(String... typeValues)

Set Aliases of FactTypes related to this DSL Parameter. Relevant only if this parameter is of FORM_EXPRESSION.

Parameters:

typeValues - Aliases of related FactTypes

getRelatedTypes

public IDTable<FactType> getRelatedTypes()

Get the FactTypes related to this DSL Parameter. Relevant only if this parameter is of FORM_EXPRESSION.

Returns:

Related FactTypes

getFormProperty

public TranslatedProperty getFormProperty()

getRelatedTypeValuesProperty

public DSLParameter.RelatedTypeValuesProperty getRelatedTypeValuesProperty()

getRelatedTypesProperty

public IDTableProperty<FactType> getRelatedTypesProperty()

getFormOptions

public String[] getFormOptions()

Gets the untranslated Form Options for this DSL Parameter For Translated Options use {@link oracle.rules.sdk2.datamodel.DSLParameter# getFormProperty().getTranslatedOptions()}

Returns:

String[] Array of Strings representing the untranslated options

get

public Object get(Object key)

Description copied from class: ConstrainableComponent

Override hashtable get method. For property "Type" we get the alias using the stored ID.

Specified by:

get in interface Map<String,Object>

Overrides:

get in class ConstrainableComponent<FormalParameter>

Parameters:

key - a String containing the property name to be fetched.

Returns:

the value corresponding to the key

put

public Object put(String key,
 Object value)

Description copied from class: ConstrainableComponent

Override hashtable put method. For property "bucketset" we store both alias and ID and sync them

Specified by:

put in interface Map<String,Object>

Overrides:

put in class ConstrainableComponent<FormalParameter>

Parameters:

key - a String containing the property name to be saved.

value - a String corresponding to the key to be saved

Returns:

the previous value of the property

getKind

public Choice.Kind getKind()

Specified by:

getKind in interface ScopedVariable

Overrides:

getKind in class FormalParameter

isAssignable

public boolean isAssignable()

Specified by:

isAssignable in interface ScopedVariable

Overrides:

isAssignable in class FormalParameter

validate

public void validate(List<SDKException> errors,
 List<SDKWarning> warnings)

Description copied from class: DictionaryComponent

Validate and append errors and warnings.

Overrides:

validate in class ConstrainableComponent<FormalParameter>

Parameters:

errors - a List of error exceptions to append to.

warnings - a List of warning exceptions to append to.

See Also:

• DictionaryObject.validate(List,List,int,int)

getParametrizedAlias

public String getParametrizedAlias(boolean translate)

Get the Parametrized value of this parameter's alias which includes '{}'

Parameters:

translate - flag to optionally get the translated value

Returns:

parametrized value of the Alias. Suitable for use in DSL Value

getVariableRL

public Object getVariableRL()

Specified by:

getVariableRL in interface ScopedVariable

Overrides:

getVariableRL in class FormalParameter