Package oracle.rules.sdk2.datamodel

Class Method

java.lang.Object
oracle.rules.sdk2.dictionary.DictionaryObject
oracle.rules.sdk2.dictionary.DictionaryComponent<T>
oracle.rules.sdk2.datamodel.ModelComponent<Method>
oracle.rules.sdk2.datamodel.Method
All Implemented Interfaces:
Serializable, Cloneable, Map<String,Object>, Callable
public class Method extends ModelComponent<Method> implements Callable
Represent a public Java method
See Also:

  • Method Details

    • isStatic

      public boolean isStatic()
      Whether the method is static
      Returns:
      true if the method is a static method

    • setStatic

      public void setStatic(boolean isStatic)

    • getType

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

    • _getTypeID

      public DOID _getTypeID()
      Get ID of the return type of the method, without syncing alias and ID.
      Specified by:
      _getTypeID in interface Callable
      Returns:
      ID of the return type of the method.

    • setTypeID

      public void setTypeID(DOID returnType)
      Set the return type ID of the method
      Parameters:
      returnType - return type of the method: name instead of alias

    • getTypeName

      public 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 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 String[] getExceptions()
      Get all the exception types of the constructor bases on the definition order
      Returns:
      The list of exceptions of the funciton.

    • setExceptions

      public void setExceptions(String[] exps)
      Set all the exceptions of the constructor
      Parameters:
      exps - The list of exceptions of the constructor.

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

    • setExceptionIDs

      public void setExceptionIDs(DOID[] exps)
      Set all the exceptions of the constructor
      Parameters:
      exps - The list of exceptions of the constructor.

    • getParameterList

      public 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 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 String getBody()
      Implement the Callable interface
      Returns:
      empty string

    • getModifiers

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

    • setModifiers

      public void setModifiers(Modifiers modifiers)

    • isChainable

      public boolean isChainable()

    • getBucketSet

      public BucketSet getBucketSet()
      Returns:
      BucketSet or null if no BucketSet has been set

    • getBucketSetProperty

      public ChoosableProperty getBucketSetProperty()
      Get BucketSet Property.
      Returns:
      ChoosableProperty

    • getBucketSetAlias

      public 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(String bucketSetAlias)
      Set BucketSet (by alias) associated with Method return values.
      Parameters:
      bucketSetAlias -

    • getBucketSetOptions

      public String[] getBucketSetOptions()
      get list of allowable bucket set aliases
      Returns:
      String[] of bucket set aliases

    • get

      public Object get(Object key)
      Description copied from class: DictionaryComponent
      Generic property getter.

      Please see the specific bean class for a list of properties.

      Specified by:
      get in interface Map<String,Object>
      Overrides:
      get in class DictionaryComponent<Method>
      Parameters:
      key - a String containing the property name to be fetched.
      Returns:
      the value corresponding to the key: a String, String[], DictionaryComponent, DictionaryComponentTable, etc.

    • put

      public Object put(String key, Object value)
      Override hashtable put method. For property "type" we don't put the value (alias) directly. We get id of the type from alias, then put it into the table.
      Specified by:
      put in interface Map<String,Object>
      Overrides:
      put in class DictionaryComponent<Method>
      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

    • toString

      public String toString()
      Get String representation of the Method
      Overrides:
      toString in class Object
      Returns:
      String representation of the Method

    • 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 DictionaryComponent<Method>
      Parameters:
      errors - a List of error exceptions to append to.
      warnings - a List of warning exceptions to append to.
      See Also:

    • getPropertyNames

      public String[] getPropertyNames()
      Overrides:
      getPropertyNames in class ModelComponent<Method>
      Returns:
      Array of property names available.

    • getStoredPropertyNames

      public String[] getStoredPropertyNames()
      Overrides:
      getStoredPropertyNames in class ModelComponent<Method>
      Returns:
      Array of property names which are persisted in the order in which they appear in the schema.

    • 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<Method>
      Returns:
      false