Skip navigation links

Oracle® OLAP Java API Reference
11g Release 2 (11.2)

E10794-06


oracle.olapi.syntax
Class FunctionDescriptorTypedExpressionArgument

java.lang.Object
  extended by oracle.olapi.syntax.FunctionDescriptorArgument
      extended by oracle.olapi.syntax.FunctionDescriptorTypedExpressionArgument


public final class FunctionDescriptorTypedExpressionArgument
extends FunctionDescriptorArgument

A FunctionDescriptorArgument for a function that takes a TypedExpression as an argument.


Field Summary
static int CLOB_OR_VARCHAR2
          A constant that indicates that the data type should be a VARCHAR2 or a CLOB.
static int LOSSLESS_TYPE
          A constant that indicates that the return type depends on the return types of the expression or expressions on which the function operates.
static int NO_EFFECT
          A constant that indicates that the argument has no effect on the return type of the function.

 

Method Summary
 java.lang.String getArgumentName()
          Gets a name that describes the argument for the function description.
 int getDataTypeCategory()
          Gets the DataType category of the argument, which is one of the category fields of the DataType class, such as DATE_CATEGORY.
 int getReturnTypeEffect()
          Gets the value of one of the fields of this class, which indicates the effect of the argument on the return type of the function.

 

Methods inherited from class oracle.olapi.syntax.FunctionDescriptorArgument
isOptional, isRepeated

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

NO_EFFECT

public static final int NO_EFFECT
A constant that indicates that the argument has no effect on the return type of the function.
See Also:
Constant Field Values

LOSSLESS_TYPE

public static final int LOSSLESS_TYPE
A constant that indicates that the return type depends on the return types of the expression or expressions on which the function operates.
See Also:
Constant Field Values

CLOB_OR_VARCHAR2

public static final int CLOB_OR_VARCHAR2
A constant that indicates that the data type should be a VARCHAR2 or a CLOB.
See Also:
Constant Field Values

Method Detail

getArgumentName

public java.lang.String getArgumentName()
Gets a name that describes the argument for the function description.
Returns:
A String that contains a name for the argument.

getDataTypeCategory

public int getDataTypeCategory()
Gets the DataType category of the argument, which is one of the category fields of the DataType class, such as DATE_CATEGORY.
Returns:
An integer that represents the category of the data type of the argument.

getReturnTypeEffect

public int getReturnTypeEffect()
Gets the value of one of the fields of this class, which indicates the effect of the argument on the return type of the function.
Returns:
An integer that represents the effect of the argument on the return type.

Skip navigation links

Copyright © 2002, 2010, Oracle. All rights reserved.