|
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
CatalogInfo represents the base class for all the catalog classes and provides the infrastructure to manage a list of options.
This class is a collection style class that stores a sequential list of options that can be accessed either by their sequences or by their option names. This class uses the current option and the methods that relate to the option.
The CatalogInfo class is one of the catalog classes for the Java API.
Method Summary | |
void |
addOption(java.lang.String optionName,
java.lang.String optionValue,
int action,
java.lang.String optionType,
java.lang.String objectName)
Add an option to the options chain. |
void |
dropOption(CatalogOption option)
Delete an option from the options chain. |
CatalogOption |
getFirstOption()
Retrieve the first option from the chain. |
CatalogOption |
getNextOption(CatalogOption currentOption)
Retrieve the next option from the chain. |
CatalogOption |
getOption(java.lang.String optionName)
Retrieve the option object for the specified option name. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
public void addOption(java.lang.String optionName, java.lang.String optionValue, int action, java.lang.String optionType, java.lang.String objectName) 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.optionType
- The type of the object that owns the option. This parameter value is a token
that is used in the SQL1884 error message to identify the option type if this
is a duplicate option.objectName
- The name of the object that owns the option. This parameter value is a token
that is used in the SQL1884 error message to identify the owner object name
if this is a duplicate option.
WrapperException
- if the option already exists in the chain or if the action is invalid.public void dropOption(CatalogOption option) throws WrapperException
option
- The option to be deleted.
WrapperException
- if the option object is null.CatalogOption
public final CatalogOption getFirstOption()
CatalogOption
public final CatalogOption getNextOption(CatalogOption currentOption)
currentOption
- The current option in the chain.
CatalogOption
public final CatalogOption getOption(java.lang.String optionName) throws WrapperException
optionName
- The name of the option.
WrapperException
- if the option name is null.CatalogOption
|
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.