IBM DB2 Information Integrator
Java API Reference
for Developing Wrappers

com.ibm.db2.wrapper
Class RemoteFunctionInfo

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

public final class RemoteFunctionInfo
extends CatalogInfo

The RemoteFunctionInfo class represents the catalog information and describes the function mapping with a remote source. The RemoteFunctionInfo class is one of the catalog classes for the Java wrapper SDK.

Usage:
This class is instantiated by the wrapper when information is added during CREATE FUNCTION MAPPING statement operations.

Since:
IBM DB2 Information Integrator Version 8.2

Constructor Summary
RemoteFunctionInfo()
          Class constructor.
RemoteFunctionInfo(int action, java.lang.String mappingName, java.lang.String signature, java.lang.String schema, int funcID, java.lang.String specificName, java.lang.String definer, java.sql.Timestamp timestamp)
          Construct an instance with the specified values.
 
Method Summary
 void addOption(java.lang.String optionName, java.lang.String optionValue, int action)
          Add an option to the options chain.
 int getAction()
          Retrieve the action value.
 java.lang.String getDefiner()
          Retrieve the definer.
 RFuncParmInfo getFirstLocalParm()
          Retrieve the first local parameter.
 RFuncParmInfo getFirstRemoteParm()
          Retrieve the first remote parameter.
 int getFuncID()
          Retrieve the local function ID.
 java.lang.String getLocalSchema()
          Retrieve the local schema name.
 java.lang.String getLocalSignature()
          Retrieve the signature.
 java.lang.String getMappingName()
          Retrieve the mapping name.
 RemoteFunctionInfo getNextFunction()
          Retrieve the next function in the chain.
 RemoteFunctionInfo getPrevFunction()
          Retrieve the previous function in the chain.
 java.lang.String getSpecificName()
          Retrieve the specific name.
 java.sql.Timestamp getTimestamp()
          Retrieve the timestamp value.
 void insertLocalParm(RFuncParmInfo localParm)
          Insert a local parameter in the local parameters list.
 void insertRemoteParm(RFuncParmInfo remoteParm)
          Insert a remote parameter in the remote parameters list.
 boolean isActionValid()
          Check to see if an action was specified.
 boolean isDefinerValid()
          Check to see if a definer was specified.
 boolean isFuncIDValid()
          Check to see if a function ID was specified.
 boolean isMappingNameValid()
          Check to see if a mapping name was specified.
 boolean isSchemaValid()
          Check to see if a schema name was specified.
 boolean isSignatureValid()
          Check to see if a signature was specified.
 boolean isSpecificNameValid()
          Check to see if a specific name was specified.
 boolean isTimestampValid()
          Check to see if a timestamp was specified.
 void setAction(int action)
          Set the action value.
 void setDefiner(java.lang.String definer)
          Set the definer.
 void setFuncID(int funcID)
          Set the local function ID.
 void setLocalSchema(java.lang.String schema)
          Set the local schema name.
 void setLocalSignature(java.lang.String signature)
          Set the signature.
 void setMappingName(java.lang.String mappingName)
          Set the mapping name.
 void setNextFunction(RemoteFunctionInfo next)
          Set the next function in the chain.
 void setPrevFunction(RemoteFunctionInfo prev)
          Set the previous function in the chain.
 void setSpecificName(java.lang.String specificName)
          Set the specific name.
 void setTimestamp(java.sql.Timestamp timestamp)
          Set the timestamp 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

RemoteFunctionInfo

public RemoteFunctionInfo()
Class constructor.

Since:
IBM DB2 Information Integrator Version 8.2

RemoteFunctionInfo

public RemoteFunctionInfo(int action,
                          java.lang.String mappingName,
                          java.lang.String signature,
                          java.lang.String schema,
                          int funcID,
                          java.lang.String specificName,
                          java.lang.String definer,
                          java.sql.Timestamp timestamp)
Construct an instance with the specified values.

Parameters:
action - The action.
mappingName - The name of the mapping.
signature - The signature of the function.
schema - The local schema name.
funcID - The local function ID.
specificName - The specific name.
definer - The definer.
timestamp - The timestamp for the mapping.
Since:
IBM DB2 Information Integrator Version 8.2
Method Detail

addOption

public void addOption(java.lang.String optionName,
                      java.lang.String optionValue,
                      int action)
               throws WrapperException
Add an option to the options chain.

Parameters:
optionName - The name of the option.
optionValue - The value of the option.
action - The action flag for the option. Valid actions for the options are specified in CatalogOption class.
Throws:
WrapperException - if the option already exists in the chain or if the action is invalid.
Since:
IBM DB2 Information Integrator Version 8.2

getAction

public int getAction()
Retrieve the action value.

Returns:
The action.
Since:
IBM DB2 Information Integrator Version 8.2

getDefiner

public java.lang.String getDefiner()
Retrieve the definer.

Returns:
The definer.
Since:
IBM DB2 Information Integrator Version 8.2

getFirstLocalParm

public RFuncParmInfo getFirstLocalParm()
Retrieve the first local parameter.

Returns:
The first local parameter.
Since:
IBM DB2 Information Integrator Version 8.2
See Also:
RFuncParmInfo

getFirstRemoteParm

public RFuncParmInfo getFirstRemoteParm()
Retrieve the first remote parameter.

Returns:
The first remote parameter.
Since:
IBM DB2 Information Integrator Version 8.2
See Also:
RFuncParmInfo

getFuncID

public int getFuncID()
Retrieve the local function ID.

Returns:
The ID.
Since:
IBM DB2 Information Integrator Version 8.2

getLocalSchema

public java.lang.String getLocalSchema()
Retrieve the local schema name.

Returns:
The schema name.
Since:
IBM DB2 Information Integrator Version 8.2

getLocalSignature

public java.lang.String getLocalSignature()
Retrieve the signature.

Returns:
The signature.
Since:
IBM DB2 Information Integrator Version 8.2

getMappingName

public java.lang.String getMappingName()
Retrieve the mapping name.

Returns:
The mapping name.
Since:
IBM DB2 Information Integrator Version 8.2

getNextFunction

public RemoteFunctionInfo getNextFunction()
Retrieve the next function in the chain.

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

getPrevFunction

public RemoteFunctionInfo getPrevFunction()
Retrieve the previous function in the chain.

Returns:
The previous function.
Since:
IBM DB2 Information Integrator Version 8.2

getSpecificName

public java.lang.String getSpecificName()
Retrieve the specific name.

Returns:
The specific name.
Since:
IBM DB2 Information Integrator Version 8.2

getTimestamp

public java.sql.Timestamp getTimestamp()
Retrieve the timestamp value.

Returns:
The timestamp.
Since:
IBM DB2 Information Integrator Version 8.2

insertLocalParm

public void insertLocalParm(RFuncParmInfo localParm)
                     throws WrapperException
Insert a local parameter in the local parameters list.

Parameters:
localParm - The local parameter to be inserted.
Throws:
WrapperException - if the parameter is null.
Since:
IBM DB2 Information Integrator Version 8.2
See Also:
RFuncParmInfo

insertRemoteParm

public void insertRemoteParm(RFuncParmInfo remoteParm)
                      throws WrapperException
Insert a remote parameter in the remote parameters list.

Parameters:
remoteParm - The remote parameter to be inserted.
Throws:
WrapperException - if the parameter is null.
Since:
IBM DB2 Information Integrator Version 8.2
See Also:
RFuncParmInfo

isActionValid

public boolean isActionValid()
Check to see if an action was specified.

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

isDefinerValid

public boolean isDefinerValid()
Check to see if a definer was specified.

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

isFuncIDValid

public boolean isFuncIDValid()
Check to see if a function ID was specified.

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

isMappingNameValid

public boolean isMappingNameValid()
Check to see if a mapping name was specified.

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

isSchemaValid

public boolean isSchemaValid()
Check to see if a schema name was specified.

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

isSignatureValid

public boolean isSignatureValid()
Check to see if a signature was specified.

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

isSpecificNameValid

public boolean isSpecificNameValid()
Check to see if a specific name was specified.

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

isTimestampValid

public boolean isTimestampValid()
Check to see if a timestamp was specified.

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

setAction

public void setAction(int action)
Set the action value.

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

setDefiner

public void setDefiner(java.lang.String definer)
Set the definer.

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

setFuncID

public void setFuncID(int funcID)
Set the local function ID.

Parameters:
funcID - The ID.
Since:
IBM DB2 Information Integrator Version 8.2

setLocalSchema

public void setLocalSchema(java.lang.String schema)
Set the local schema name.

Parameters:
schema - The schema name.
Since:
IBM DB2 Information Integrator Version 8.2

setLocalSignature

public void setLocalSignature(java.lang.String signature)
Set the signature.

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

setMappingName

public void setMappingName(java.lang.String mappingName)
Set the mapping name.

Parameters:
mappingName - The mapping name.
Since:
IBM DB2 Information Integrator Version 8.2

setNextFunction

public void setNextFunction(RemoteFunctionInfo next)
Set the next function in the chain.

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

setPrevFunction

public void setPrevFunction(RemoteFunctionInfo prev)
Set the previous function in the chain.

Parameters:
prev - The previous function.
Since:
IBM DB2 Information Integrator Version 8.2

setSpecificName

public void setSpecificName(java.lang.String specificName)
Set the specific name.

Parameters:
specificName - The specific name.
Since:
IBM DB2 Information Integrator Version 8.2

setTimestamp

public void setTimestamp(java.sql.Timestamp timestamp)
Set the timestamp value.

Parameters:
timestamp - The timestamp.
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.