IBM DB2 Information Integrator
Java API Reference
for Developing Wrappers

com.ibm.db2.wrapper
Class CatalogOption

java.lang.Object
  extended bycom.ibm.db2.wrapper.CatalogOption

public class CatalogOption
extends java.lang.Object

The CatalogOption class represents the base class for options of the catalog objects. This class encapsulates one or more name-value pairs and links to the next option and the previous option.

The CatalogOption class is one of the catalog classes for the Java API.

Since:
IBM DB2 Information Integrator Version 8.2

Field Summary
static int ADD
          Action constant; indicates that the option is added to the catalog.
static int DROP
          Action constant; indicates that the option is dropped from the catalog.
static int NONE
          Action constant; indicates no action for the option.
static int SET
          Action constant; indicates that the option is set to a new value.
 
Method Summary
 int getAction()
          Retrieve the action for the option.
 java.lang.String getName()
          Retrieve the name of the option.
 CatalogOption getNextOption()
          Retrieve the next option in the chain that this option belongs to.
 CatalogOption getPrevOption()
          Retrieve the previous option in the chain that this option belongs to.
 java.lang.String getValue()
          Retrieve the option value.
 boolean isReserved()
          Indicate whether the option is a DB2-reserved option.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ADD

public static final int ADD
Action constant; indicates that the option is added to the catalog.

Since:
IBM DB2 Information Integrator Version 8.2
See Also:
Constant Field Values

DROP

public static final int DROP
Action constant; indicates that the option is dropped from the catalog.

Since:
IBM DB2 Information Integrator Version 8.2
See Also:
Constant Field Values

NONE

public static final int NONE
Action constant; indicates no action for the option.

Since:
IBM DB2 Information Integrator Version 8.2
See Also:
Constant Field Values

SET

public static final int SET
Action constant; indicates that the option is set to a new value. The option to set to a new value must already be in the catalog.

Since:
IBM DB2 Information Integrator Version 8.2
See Also:
Constant Field Values
Method Detail

getAction

public final int getAction()
Retrieve the action for the option.

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

getName

public final java.lang.String getName()
Retrieve the name of the option.

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

getNextOption

public final CatalogOption getNextOption()
Retrieve the next option in the chain that this option belongs to.

Returns:
The next option in the chain or null if there are no more options.
Since:
IBM DB2 Information Integrator Version 8.2

getPrevOption

public final CatalogOption getPrevOption()
Retrieve the previous option in the chain that this option belongs to.

Returns:
The previous option in the chain or null if there are no previous options.
Since:
IBM DB2 Information Integrator Version 8.2

getValue

public java.lang.String getValue()
Retrieve the option value.

Returns:
The option value as a string.
Since:
IBM DB2 Information Integrator Version 8.2

isReserved

public final boolean isReserved()
Indicate whether the option is a DB2-reserved option.

Returns:
true if the option is a DB2-reserved option, false otherwise.
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.