|
IBM DB2 Information Integrator Java API Reference for Developing Wrappers |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.db2.wrapper.CatalogInfo
com.ibm.db2.wrapper.RemoteFunctionInfo
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.
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 |
public 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)
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.Method Detail |
public void addOption(java.lang.String optionName, java.lang.String optionValue, int action) throws WrapperException
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.
WrapperException
- if the option already exists in the chain or if the action is invalid.public int getAction()
public java.lang.String getDefiner()
public RFuncParmInfo getFirstLocalParm()
RFuncParmInfo
public RFuncParmInfo getFirstRemoteParm()
RFuncParmInfo
public int getFuncID()
public java.lang.String getLocalSchema()
public java.lang.String getLocalSignature()
public java.lang.String getMappingName()
public RemoteFunctionInfo getNextFunction()
public RemoteFunctionInfo getPrevFunction()
public java.lang.String getSpecificName()
public java.sql.Timestamp getTimestamp()
public void insertLocalParm(RFuncParmInfo localParm) throws WrapperException
localParm
- The local parameter to be inserted.
WrapperException
- if the parameter is null.RFuncParmInfo
public void insertRemoteParm(RFuncParmInfo remoteParm) throws WrapperException
remoteParm
- The remote parameter to be inserted.
WrapperException
- if the parameter is null.RFuncParmInfo
public boolean isActionValid()
public boolean isDefinerValid()
public boolean isFuncIDValid()
public boolean isMappingNameValid()
public boolean isSchemaValid()
public boolean isSignatureValid()
public boolean isSpecificNameValid()
public boolean isTimestampValid()
public void setAction(int action)
action
- The action.public void setDefiner(java.lang.String definer)
definer
- The definer.public void setFuncID(int funcID)
funcID
- The ID.public void setLocalSchema(java.lang.String schema)
schema
- The schema name.public void setLocalSignature(java.lang.String signature)
signature
- The signature.public void setMappingName(java.lang.String mappingName)
mappingName
- The mapping name.public void setNextFunction(RemoteFunctionInfo next)
next
- The next function.public void setPrevFunction(RemoteFunctionInfo prev)
prev
- The previous function.public void setSpecificName(java.lang.String specificName)
specificName
- The specific name.public void setTimestamp(java.sql.Timestamp timestamp)
timestamp
- The timestamp.
|
IBM DB2 Information Integrator Java API Reference for Developing Wrappers |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
(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.