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

E10663-11

oracle.rules.sdk2.datamodel
Class Method

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.Method
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>, Callable

public class Method
extends ModelComponent
implements Callable

Represent a public Java method

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, 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
 
Method Summary
 java.lang.String getBody()
          Implement the Callable interface
 java.lang.String getBucketSetAlias()
          Get BucketSet alias associated with Property values.
 java.lang.String[] getBucketSetOptions()
          get list of allowable bucket set aliases
 ChoosableProperty getBucketSetProperty()
          Get BucketSet Property.
 DOID[] getExceptionIDs()
          Get all the exception types of the constructor bases on the definition order
 java.lang.String[] getExceptions()
          Get all the exception types of the constructor bases on the definition order
 OverloadedParameterTable getOverloadedParameterTable()
          Get all the parameter types of the constructor based on the definition order.
 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
 java.lang.String getType()
          Get alias of the return type of the method.
 DOID getTypeID()
          Get ID of the return type of the method.
 java.lang.String getTypeName()
          Get Name of the type of the definition.
 boolean isFullyQualifiedName()
          Can a qualifed name be used to name this component?
 boolean isReturnTypePrimitive()
          Whether the return type of the method is primitive (i.e. int, char, double etc.)?
 boolean isStatic()
          Whether the method is static
 void setBucketSet(BucketSet bucketSet)
          Set BucketSet associated with Method return value.
 void setBucketSetByAlias(java.lang.String bucketSetAlias)
          Set BucketSet (by alias) associated with Method return values.
 
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, 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, getModifiers, isVisible, setDescription, setVisible
 
Methods inherited from interface java.util.Map
equals, hashCode
 

Method Detail

isStatic

public boolean isStatic()
Whether the method is static

Returns:
true if the method is a static method

getType

public java.lang.String getType()
Get alias of the return type of the method. Note void is a special FactType.

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

getTypeID

public DOID getTypeID()
Get ID of the return type of the method. Note void is a special FactType.

Specified by:
getTypeID in interface Callable
Returns:
ID of the return type of the method.

getTypeName

public java.lang.String getTypeName()
Get Name of the type of the definition.

Returns:
name of the type

isReturnTypePrimitive

public boolean isReturnTypePrimitive()
Whether the return type of the method is primitive (i.e. int, char, double etc.)?

Returns:
true if return type is primitive; false if return type is java or RL class

getOverloadedParameterTable

public OverloadedParameterTable getOverloadedParameterTable()
Get all the parameter types of the constructor based on the definition order.

Returns:
The list of parameter types of the constructor.

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

getExceptions

public java.lang.String[] getExceptions()
Get all the exception types of the constructor bases on the definition order

Returns:
The list of exceptions of the funciton.

getExceptionIDs

public DOID[] getExceptionIDs()
Get all the exception types of the constructor bases on the definition order

Specified by:
getExceptionIDs in interface Callable
Returns:
The list of exceptions of the funciton.

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

getBody

public java.lang.String getBody()
Implement the Callable interface

Returns:
empty string

getBucketSetProperty

public ChoosableProperty getBucketSetProperty()
Get BucketSet Property.

Returns:
ChoosableProperty

getBucketSetAlias

public java.lang.String getBucketSetAlias()
Get BucketSet alias associated with Property values.

Returns:
BucketSet or null if no BucketSet has been set

setBucketSet

public void setBucketSet(BucketSet bucketSet)
Set BucketSet associated with Method return value. Null bucketSet clears any association.

Parameters:
bucketSet -

setBucketSetByAlias

public void setBucketSetByAlias(java.lang.String bucketSetAlias)
Set BucketSet (by alias) associated with Method return values.

Parameters:
bucketSetAlias -

getBucketSetOptions

public java.lang.String[] getBucketSetOptions()
get list of allowable bucket set aliases

Returns:
String[] of bucket set aliases

isFullyQualifiedName

public boolean isFullyQualifiedName()
Can a qualifed name be used to name this component? Many components, e.g. rules, must have single component names and a qualifed name is constructed using the name of its parent (e.g. rulesetName.ruleName)

Overrides:
isFullyQualifiedName in class DictionaryComponent
Returns:
false

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.