IBM DB2 Information Integrator
Java API Reference
for Developing Wrappers

com.ibm.db2.wrapper
Class RFuncParmInfo

java.lang.Object
  extended bycom.ibm.db2.wrapper.CatalogInfo
      extended bycom.ibm.db2.wrapper.RFuncParmInfo

public final class RFuncParmInfo
extends CatalogInfo

The RFuncParmInfo class represents the information that describes a function parameter in a function mapping.

Since:
IBM DB2 Information Integrator Version 8.2

Constructor Summary
RFuncParmInfo()
          Default constructor.
RFuncParmInfo(short ordinal)
          Construct a function parameter with the specified ordinal.
 
Method Summary
 RFuncParmInfo getNextRFuncParm()
          Retrieve the next function parameter in the chain.
 short getOrdinal()
          Retrieve the ordinal value.
 boolean isOrdinalValid()
          check if an ordinal value was specified.
 void setNextRFuncParm(RFuncParmInfo next)
          Set the next function parameter in the chain.
 void setOrdinal(short ordinal)
          Set the ordinal value.
 
Methods inherited from class com.ibm.db2.wrapper.CatalogInfo
addOption, dropOption, getFirstOption, getNextOption, getOption
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RFuncParmInfo

public RFuncParmInfo()
Default constructor.

Since:
IBM DB2 Information Integrator Version 8.2

RFuncParmInfo

public RFuncParmInfo(short ordinal)
Construct a function parameter with the specified ordinal.

Parameters:
ordinal - The ordinal value.
Since:
IBM DB2 Information Integrator Version 8.2
Method Detail

getNextRFuncParm

public RFuncParmInfo getNextRFuncParm()
Retrieve the next function parameter in the chain.

Returns:
The next parameter.
Since:
IBM DB2 Information Integrator Version 8.2

getOrdinal

public short getOrdinal()
Retrieve the ordinal value.

Returns:
The ordinal value.
Since:
IBM DB2 Information Integrator Version 8.2

isOrdinalValid

public boolean isOrdinalValid()
check if an ordinal value was specified.

Returns:
true if a value is specified, false otherwise.
Since:
IBM DB2 Information Integrator Version 8.2

setNextRFuncParm

public void setNextRFuncParm(RFuncParmInfo next)
Set the next function parameter in the chain.

Parameters:
next - The next parameter.
Since:
IBM DB2 Information Integrator Version 8.2

setOrdinal

public void setOrdinal(short ordinal)
Set the ordinal value.

Parameters:
ordinal - The ordinal value.
Since:
IBM DB2 Information Integrator Version 8.2

IBM DB2 Information Integrator
Java API Reference
for Developing Wrappers

(C)Copyright IBM Corp. 2002. All rights reserved.

Links on this page are made available for your convenience and may take you to non-IBM sites. IBM does not warrant any sample code provided on these sites.