| Previous Contents Index DocHome Next |
| iPlanet Unified Integration Framework Developer's Guide |
Chapter 7 API Reference
This chapter describes the interfaces and methods used from your Servlet, JSP, or EJB to access and manipulate data stored on an EIS system.This chapter contains the following sections:
IBSPRuntime Interface
IBSPDataObjectPrimitive Interface
IBSPDataObjectPrimitiveInfo Interface
IBSPDataObjectCollection Interface
IBSPDataObjectStructure Interface
IBSPDataObjectStructureInfo Interface
IBSPDataObjectListInfo Interface
IBSPDataObjectArrayInfo Interface
IBSPDataObjectDataItr Interface
FieldNameIsNullException Class
FieldNameTooLongException Class
IllegalRecusionException Class
IndexOutOfBoundsException Class
IBSPRuntime Interface
The IBSPRuntime interface defines the methods to create service provider and function objects.
Syntax
public
netscape.bsp.runtime.IBSPFunctionObject createFunctionObject(
java.lang.String pAdapterName,
java.lang.String pFunctionObjectName);pAdapterName - A string that specifies the connector name.
pFunctionObjectName - A string that specifies the function object name.
Usage
Specify the datasource name and a function object name from the repository.
Example
IBSPFunctionObject fn = null;if( (runtime != null) && (sp != null) )
fn = runtime.createFunctionObject("<connector>", "phonebook");
Return Value
An IBSPFunctionObject.
Creates a service provider object.
Syntax
public
netscape.bsp.runtime.IBSPServiceProvider createServiceProvider(
java.lang.String pAdapterName,
java.lang.String pServiceProviderName);pAdapterName - A string that specifies the connector name.
pServiceProviderName - A string that specifies the service provider name.
Usage
Specify the datasource name and a service provider name from the repository.
Example
IBSPServiceProvider sp = null;sp = runtime.createServiceProvider("<connector>", "<connector>_sp1");
Return Value
An IBSPServiceProviderObject object.
Retrieves the server's context object.
Syntax
public com.kivasoft.IContext getServerContext();
Return Value
The IContext object associated with this runtime object.
IBSPServiceProvider Interface
The IBSPServiceProvider interface defines the methods to enable or disable a connection to an EIS server from a Servlet, JSP, or EJB.
Usage
The disable() method causes the connection with the EIS to be dropped. The application needs to disable sp-bound connections after they are no longer needed. After calling the disable() method, the connection is no longer valid and the connection is returned to the pool. The application can call enable() to reestablish the connection.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Usage
The enable() method validates the logical connection with the EIS system and establishes a physical connection. The application must enable the connection before it associates a service provider with a function object. For method-bound connections, the connection is automatically released after the method call.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Syntax
public int extendBindDuration();
Usage
The extendBindDuration() method increases the bind duration timeout value beyond the bind duration specified in the repository. Call this method when the application expects a long transaction and want to hold the same physical connection. For information about bind durations, see "Bind Durations" on page 73.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Determines the configuration of the EIS connection.
Syntax
public netscape.bsp.dataobject.IBSPDataObject getConfig();
Usage
Use this method to set up configuration information for an EIS connection.
Return Value
An IBSPDataObject object that contains the configuration information.
Determines whether the EIS connection is enabled.
Syntax
public boolean isEnabled();
Return Value
A boolean value that is true if the connection is enabled; otherwise, it is false.
IBSPFunctionObject Interface
The IBSPFunctionObject interface defines the methods the application needs to specify a service provider which prepares and executes an EIS request to obtain properties and data from the EIS.
Usage
Calls the prepare() method before calling execute().
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Retrieves a data block from the EIS system.
Syntax
public netscape.bsp.dataobject.IBSPDataObject getDataBlock();
Return Value
An IBSPDataObject object that contains the data block.
Determines the EIS system properties.
Syntax
public netscape.bsp.dataobject.IBSPDataObject getProperties();
Return Value
An IBSPDataObject object that contains the properties for the current operation.
Determines the service provider.
Syntax
public netscape.bsp.dataobject.IBSPServiceProvider getServiceProvider();
Return Value
An IBSPServiceProvider object that represents a connection to the EIS.
Syntax
public int prepare(java.lang.String pOperation);pOperation - A string that specifies the operation to perform.
Usage
Specify an operation by name from the repository. The prepare() method sets up the data block and properties for the specified operation and causes the specified operation to become the current operation for this function object.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
IBSPDataObjectMgr Interface
The IBSPDataObjectMgr interface implements a method for examining the contents of a data object. The following example shows how to create an reference to an IBSPDataObjectMgr object:netscape.bsp.dataobject.IBSPDataObjectMgr doMgr =
netscape.bsp.dataobject.access_cDataObject.getcDataObject(
context, null, null);
Note Currently, data object creation methods are not exposed. The application can only create a data object by creating the object info in the repository and accessing the repository.
Package
netscape.bsp.dataobject
Displays the data contained in a data object on the console.
Syntax
public int dumpDataObject(
netscape.bsp.dataobject.IBSPDataObject dataObject);dataObject - The IBSPDataObject object whose data the application wants to display.
Usage
Use the dumpDataObject() method for debugging. The data is displayed on the console.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
IBSPDataObject Interface
The IBSPDataObject interface implements methods for accessing data objects and their attributes.
Package
netscape.bsp.dataobject
Determines whether an attribute exists in the instance.
Syntax
public boolean attrExists(java.lang.String path);path - The path to a data attribute the application wants to check.
Usage
Specify the path for the data object attribute, that needs checking.
Return Value
A boolean value that is true if the attribute exits; otherwise, it is false.
Determines whether an attribute is defined in the repository.
Syntax
public boolean attrIsDefined(java.lang.String path);path - The path to a data attribute the application wants to check.
Usage
Specify the path for the data object attribute, that needs checking.
Return Value
A boolean value that is true if the attribute is defined; otherwise, it is false.
Creates a copy of this object.
Syntax
public netscape.bsp.dataobject.IBSPDataObject copy();
Usage
The copy() method performs a deep copy.
Return Value
A copy of the data object.
Determines the attribute at the specified path.
Syntax
public netscape.bsp.dataobject.IBSPDataObject
getAttr(java.lang.String path);path - The path to a data attribute the application wants to check.
Usage
Specify the path of the Data Object attribute to obtain the attribute value.
Return Value
An IBSPDataObject object that contains the attribute.
Determines the value of a byte array attribute.
Syntax
public byte[] getAttrBinary(java.lang.String path);path - The path to a data attribute the application wants to check.
Return Value
A byte array that contains the value.
Determines the current size of a byte array attribute.
Syntax
public int getAttrBinarySize(java.lang.String path);path - The path to a byte array attribute whose size the application wants to obtain.
Return Value
An integer that contains the size, in bytes.
Determines the number of attributes in the data object.
Syntax
public int getAttrCount();
Return Value
An integer that specifies the number of attributes.
Determines the value of a double precision floating point attribute.
public double getAttrDouble(java.lang.String path);
path - The path to a data attribute the application wants to check.
Return Value
A double precision floating point number that contains the value.
Determines the value of a floating point attribute.
Syntax
public float getAttrFloat(java.lang.String path);path - The path to a data attribute whose value the application wants to obtain.
Return Value
A floating point number that contains the value.
Determines the value of a fixed length string attribute.
Syntax
public java.lang.String getAttrFString(java.lang.String path);path - The path to a data attribute whose value the application wants to obtain.
Return Value
A string that contains the value.
Determines the maximum length of a fixed size string attribute.
Syntax
public int getAttrFStringMaxLen(java.lang.String path);path - The path to a fixed length string attribute whose maximum length the application wants to obtain.
Return Value
An integer that contains the maximum length, in bytes.
Determines the value of an integer attribute.
Syntax
public int getAttrInt(java.lang.String path);path - The path to a data attribute whose value the application wants to obtain.
Return Value
An integer that contains the value.
Determines the value of a string attribute.
Syntax
public java.lang.String getAttrString(java.lang.String path);path - The path to a data attribute whose value the application wants to obtain.
Return Value
A string that contains the value.
Determines the data type of an attribute.
Syntax
public int getAttrType(java.lang.String path);path - The path to a data attribute whose value the application wants to determine.
Usage
The attribute type may be one of the following:
The application should always use a constant instead of a value in its Servlet, JSP, or EJB.
Return Value
An integer that contains the type number.
Determines the value of a variable size byte array attribute.
Syntax
public byte[] getAttrVBinary(java.lang.String path);path - The path to a data attribute whose value the application wants to obtain.
Return Value
A byte array that contains the value.
Determines the current size of a variable byte array attribute.
Syntax
public int getAttrVBinarySize(java.lang.String path);path - The path to a variable length byte array attribute whose size the application wants to obtain.
Return Value
An integer that contains the size, in bytes.
Retrieves the data iterator for this object.
Syntax
public
netscape.bsp.dataobject.IBSPDataObjectDataItr getDataItr();
Usage
For information about the IBSPDataObjectDataItr interface, see "IBSPDataObjectDataItr Interface" on page 163.
Return Value
An IBSPDataObjectDataItr object.
Determines the type information for this object.
Syntax
public
netscape.bsp.dataobject.IBSPDataObjectInfo getTypeInfo();
Return Value
An IBSPDataObjectInfo object.
Determines whether an attribute's type matches the specified type.
Syntax
public
boolean isAttrType(java.lang.String path, int typeNumber);typeNumber - The specified type.
Usage
The attribute type may be one of the following:
Return Value
A boolean value that is true if the types match; otherwise, it is false.
Determines whether the type matches the specified type.
Syntax
public boolean isType(int typeNumber);typeNumber - The specified type.
Usage
The attribute type may be one of the following:
Return Value
A boolean value that is true if the types match; otherwise, it is false.
Syntax
public int removeAttr(java.lang.String path);path - The path to a data attribute the application wants to remove.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Sets the value of a byte array attribute.
Syntax
public int setAttrBinary(java.lang.String path, byte[] buf);path - The path to a data attribute whose value the application wants to set.
buf - The value with which to set the attribute.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Sets the value of an attribute to a data object.
Syntax
public int setAttrDataObject(java.lang.String path,
netscape.bsp.dataobject.IBSPDataObject value);path - The path to a data attribute whose value the application wants to set.
value - The object that the application wants to associate with the attribute.
Usage
A value for a primitive data type is unwrapped and copied when it is set in the object; in other words, the value is stored in the object, not an object that contains the value. Otherwise, the data object itself is set to the value.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Sets the value of an attribute to a new empty list.
Syntax
public int setAttrDataObjectList(java.lang.String path);path - The path to a data attribute whose value the application wants to set.
Usage
An empty list is created at the specified path.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Sets the value of an attribute to a new empty structure.
Syntax
public int setAttrDataObjectStructure(java.lang.String path);path - The path to a data attribute whose value the application wants to set.
Usage
An empty structure is created at the specified path.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Sets the value of a double precision floating point attribute.
Syntax
public int setAttrDouble(java.lang.String path, double value);path - The path to a data attribute whose value the application wants to set.
value - The value with which to set the attribute.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Sets the value of a floating point attribute.
Syntax
public int setAttrFloat(java.lang.String path, float value);path - The path to a data attribute whose value the application wants to set.
value - The value with which to set the attribute.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Sets the value of a fixed length string attribute.
Syntax
public int setAttrFString( java.lang.String path,
java.lang.String stringValue);path - The path to a data attribute whose value the application wants to set.
stringValue - The value with which to set the attribute.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Sets the value of an integer attribute.
Syntax
public int setAttrInt(java.lang.String path, int intValue);path - The path to a data attribute whose value the application wants to set.
intValue - The value with which to set the attribute.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Sets the value of a string attribute.
Syntax
public int setAttrString(java.lang.String path,
java.lang.String stringValue);path - The path to a data attribute whose value the application wants to set.
stringValue - The value with which to set the attribute.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Sets the value of a variable size byte array attribute.
Syntax
public int setAttrVBinary(java.lang.String path, byte[] buf);path - The path to a data attribute whose value the application wants to set.
buf - The value with which to set the attribute.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
IBSPDataObjectPrimitive Interface
The IBSPDataObjectPrimitive interface defines methods for accessing primitive data objects, which include integers, floating point numbers, double precision floating point numbers, byte arrays, and strings.
Package
netscape.bsp.dataobject
Method
Description
Determines the value of a double precision floating point number.
Determines the value of a byte array.
Syntax
public byte[] getBinary();
Return Value
A byte array that contains the value.
Determine the size of a byte array.
Syntax
public int getBinarySize();
Return Value
An integer that contains the size, in bytes.
Determines the value of a double precision floating point number.
Syntax
public double getDouble();
Return Value
A double precision floating point number that contains the value.
Determines the value of a floating point number.
Syntax
public float getFloat();
Return Value
A floating point number that contains the value.
Determines the value of a fixed length string.
Syntax
public java.lang.String getFString();
Return Value
A string that contains the value.
Determines the maximum length of a fixed size string.
Syntax
public int getFStringMaxLen();
Return Value
An integer that contains the maximum length, in bytes.
Determines the value of an integer.
Return Value
An integer that contains the value.
Determines the value of a string.
Syntax
public java.lang.String getString();
Return Value
A string that contains the value.
Determines the value of a variable size binary number.
Syntax
public byte[] getVBinary();
Return Value
A byte array that contains the value.
Determine the size of a variable byte array.
Syntax
public int getVBinarySize();
Return Value
An integer that contains the size, in bytes.
Sets the value of a binary number.
Syntax
public int setBinary(byte[] buf);buf - The value with which to set the object.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Sets the value of a double precision floating point number.
Syntax
public int setDouble(double value);value - The value with which to set the object.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Sets the value of a floating point number.
Syntax
public int setFloat(float value);value - The value with which to set the object.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Sets the value of a fixed length string.
Syntax
public int setFString(java.lang.String stringValue);stringValue - The value with which to set the object.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Syntax
public int setInt(int intValue);intValue - The value with which to set the object.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Syntax
public int setString(java.lang.String stringValue);stringValue - The value with which to set the attribute.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Sets the value of a variable size byte array.
Syntax
public int setVBinary(byte[] buf);buf - The value with which to set the object.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
IBSPDataObjectPrimitiveInfo Interface
The IBSPDataObjectPrimitiveInfo interface defines methods for getting and setting the default values and lengths of primitive data types.
Package
netscape.bsp.dataobject
- Determines the default primitive data object.
Syntax
public netscape.bsp.dataobject.IBSPDataObjectPrimitive
getPrimDefault();
Return Value
The default IBSPDataObjectPrimitive object.
Determines the default value of a byte array.
Syntax
public byte[] getPrimDefaultBinary();
Return Value
A byte array that contains the value.
Determines the default primitive data object.
Syntax
public netscape.bsp.dataobject.IBSPDataObjectPrimitive
getPrimDefaultDataObject();
Return Value
The default IBSPDataObjectPrimitive object.
Determines the default value of a double precision floating point number.
Syntax
public double getPrimDefaultDouble();
Return Value
A double precision floating point number that contains the value.
Determines the default value of a floating point number.
Syntax
public float getPrimDefaultFloat();
Return Value
A floating point number that contains the value.
Determines the default value of a fixed length string.
Syntax
public java.lang.String getPrimDefaultFString();
Return Value
A string that contains the value.
Determines the default maximum length of a fixed size string.
Syntax
public int getPrimDefaultFStringMaxLen();
Return Value
An integer that contains the size, in bytes.
Determines the default value of an integer.
Syntax
public int getPrimDefaultInt();
Return Value
An integer that contains the value.
Determines the default value of a variable size byte array.
Syntax
public byte[] getPrimDefaultVBinary();
Return Value
A byte array that contains the value.
Determines the size of the defined primitive data object.
Syntax
public int getPrimSize();
Return Value
An integer that contains the size, in bytes.
Determines the data type of the defined primitive data object.
Usage
The primitive type may be one of the following:
The application should always use a constant instead of a value in its Servlet, JSP, or EJB.
Return Value
An integer that contains the type number.
Sets the default value of a binary number.
Syntax
public int setPrimDefaultBinary(byte[] buf);buf - The default value with which to set the default.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Sets the default primitive data object.
Syntax
public int setPrimDefaultDataObject(
netscape.bsp.dataobject.IBSPDataObjectPrimitive value);value - The value with which to set the default.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Sets the default value of a double precision floating point number.
Syntax
public int setPrimDefaultDouble(double value);value - The value with which to set the default.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Sets the default value of a floating point number.
Syntax
public int setPrimDefaultFloat(float value);value - The value with which to set the default.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Sets the default value of a fixed length string.
Syntax
public int setPrimDefaultFString(java.lang.String value);stringValue - The value with which to set the default.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Sets the default value of an integer.
Syntax
public int setInt(int intValue);intValue - The value with which to set the default.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Sets the default value of a string.
Syntax
public int setString(java.lang.String stringValue);stringValue - The value with which to set the default.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Sets the default value of a variable size byte array.
Syntax
public int setVBinary(byte[] buf);buf - The value with which to set the default.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
IBSPDataObjectCollection Interface
The IBSPDataObjectCollection interface defines an interface from which collections, such as data object lists and structures are derived. The interface currently has no methods.
IBSPDataObjectList Interface
The IBSPDataObjectList interface defines methods for accessing elements of list data objects. The interface defines an ordered list in which new elements are added to the end.
Note An element must be added to the list before the element can be set.
Package
netscape.bsp.dataobject
Method
Description
Determines the value of a double precision floating point number element.
Sets the value of a double precision floating point number element.
Element Insertion and Deletion Methods
Method
Description
Adds a double precision floating point number as an element in the list.
Adds a variable length byte array as an element in the list.
Method
Description
Determines the maximum length of a fixed length string element.
Adds a byte array as an element in the list.
Syntax
public int addElemBinary(byte[] buf);buf - The value with which to set the element.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Adds a data object as an element in the list.
Syntax
public int addElemDataObject
(netscape.bsp.dataobject.IBSPDataObject value);value - The value with which to set the element.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Adds a new empty list as an element in the list.
Syntax
public int addElemDataObjectList();
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Adds a new empty structure as an element in the list.
Syntax
public int addElemDataObjectStructure();
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Adds a double precision floating point number as an element in the list.
Syntax
public int addElemDouble(double value);value - The value with which to set the element.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Adds a floating point number as an element in the list.
Syntax
public int addElemFloat(float value);value - The value with which to set the element.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Adds a fixed length string as an element in the list.
Syntax
public int addElemFString(java.lang.String value);value - The value with which to set the element.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Adds an integer number as an element in the list.
Syntax
public int addElemInt(int value);value - The value with which to set the element.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Adds a string as an element in the list.
Syntax
public int addElemString(java.lang.String value);value - The value with which to set the element.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Adds a variable length byte array as an element in the list.
Syntax
public int addElemVBinary(byte[] buf);buf - The value with which to set the element.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Determines whether an element exists in the instance.
Syntax
public boolean elemExists(int index);index - The position of the element to test.
Usage
An element exists if its value exists in the object. The first index position in the list is 0.
Return Value
A boolean value that is true if the element exists; otherwise, it is false.
Determines whether an element is defined in the repository.
Syntax
public boolean elemIsDefined(int index);index - The position of the element to test.
Usage
An element is defined if its index is between 0 and one less than the maximum element count, inclusive.
Return Value
A boolean value that is true if the element is defined; otherwise, it is false.
Determines the value of an element.
Syntax
public
netscape.bsp.dataobject.IBSPDataObject getElem(int index);index - The position of the element whose value the application wants to determine.
Usage
If the returned value is of a primitive data type, it is copied into a primitive data object and the primitive data object is returned; otherwise, a reference to the data object is returned. The first index position in the list is 0.
Return Value
An IBSPDataObject object that contains the value.
Determines the value of a byte array element.
Syntax
public byte[] getElemBinary(int index);index - The position of the element whose value the application wants to determine.
Usage
The first index position in the list is 0.
Return Value
A byte array that contains the value.
Determines the size of a byte array element.
Syntax
public byte[] getElemBinaryize(int index);index - The position of the element whose size the application wants to determine.
Usage
The first index position in the list is 0.
Return Value
An integer that contains the size, in bytes.
Determines the current number of elements in the list.
Syntax
public int getElemCount();
Return Value
An integer that contains the number of elements.
Determines the data object stored in an element.
Syntax
public netscape.bsp.dataobject.IBSPDataObject getElemDataObject
(int index);index - The position of the element whose value the application wants to determine.
Usage
The first index position in the list is 0.
Return Value
A double precision floating point number that contains the value.
Determines the value of a double precision floating point number element.
Syntax
public double getElemDouble(int index);index - The position of the element whose value the application wants to determine.
Usage
The first index position in the list is 0.
Return Value
A double precision floating point number that contains the value.
Determines the value of a floating point number element.
Syntax
public float getElemFloat(int index);index - The position of the element whose value the application wants to determine.
Usage
The first index position in the list is 0.
Return Value
A floating point number that contains the value.
Determines the value of a fixed length string element.
Syntax
public java.lang.String getElemFString(int index);index - The position of the element whose value the application wants to determine.
Usage
The first index position in the list is 0.
Return Value
A string that contains the value.
Determines the maximum length of a fixed length string element.
Syntax
public int getElemStringMaxLen(int index);index - The position of the element whose value the application wants to determine.
Usage
The first index position in the list is 0.
Return Value
An integer that contains the size, in bytes.
Determines the value of an integer element.
Syntax
public int getElemInt(int index);index - The position of the element whose value the application wants to determine.
Usage
The first index position in the list is 0.
Return Value
An integer that contains the value.
Determines the value of a string element.
Syntax
public java.lang.String getElemString(int index);index - The position of the element whose value the application wants to determine.
Usage
The first index position in the list is 0.
Return Value
A string that contains the value.
Determines the type of an element.
Syntax
public int getElemType(int index);index - The position of the element whose value the application wants to determine.
Usage
The first index position in the list is 0.
Return Value
An integer value that specifies the type, which may be one of the following types:
Determines the value of a variable size byte array element.
Syntax
public byte[] getElemVBinary(int index);index - The position of the element whose value the application wants to determine.
Variable Size Usage
The first index position in the list is 0.
Return Value
A byte array that contains the value.
Determines the size of a variable byte array element.
Syntax
public int getElemVBinarySize(int index);index - The position of the element whose value the application wants to determine.
Usage
The first index position in the list is 0.
Return Value
An integer that contains the size, in bytes.
Determines the maximum number of elements in the list.
Syntax
public int getMaxElemCount();
Return Value
An integer that contains the number of elements.
Compares the element with the specified type.
Syntax
public boolean isElemType(int index,int typeNumber);index - The position of the element whose value the application wants to determine.
typeNumber - The type with which the application wants to compare this element.
Usage
The first index position in the list is 0. The type may be one of the following:
The application should always use a constant instead of a value in its Servlet, JSP, or EJB.
Return Value
A boolean value that is true if the type of the element matches the specified type; otherwise, it is false.
Removes an element in the list.
Syntax
public int removeElem(int index);index - The position of the element to remove.
Usage
Elements after the element that was removed are moved down by one position in the list; for example, if the application removes element 0, all elements are shifted down by one such that element 1 becomes element 0, element 2 becomes element 1, and so on. The first index position in the list is 0.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Sets the value of a binary number element.
Syntax
public int setElemBinary(int index, byte[] buf);index - The position of the element whose value the application wants to set.
buf - The value with which to set the object.
Usage
The first index position in the list is 0.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Sets the data object stored in an element.
Syntax
public int setElemDataObject(int index,
netscape.bsp.dataobject.IBSPDataObject value);index - The position of the element whose value the application wants to set.
value - The value with which to set the element.
Usage
A value for a primitive data type is unwrapped and copied when it is set in the object; in other words, the value is stored in the object, not an object that contains the value. Otherwise, the data object itself is set to the value. The first index position in the list is 0.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Sets an element to a new empty list.
Syntax
public int setElemDataObjectList(int index);index - The position of the element to set.
Usage
An empty list is created at the specified index. The first index position in the list is 0.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Sets an element to a new empty structure.
Syntax
public int setElemDataObjectStructure(int index);index - The position of the element to set.
Usage
An empty structure is created at the specified index. The first index position in the list is 0.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Sets the value of a double precision floating point number element.
Syntax
public int setElemDouble(int index, double value);index - The position of the element whose value the application wants to set.
value - The value with which to set the element.
Usage
The first index position in the list is 0.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Sets the value of a floating point number element.
Syntax
public int setElemFloat(int index, float value);index - The position of the element whose value the application wants to set.
value - The value with which to set the element.
Usage
The first index position in the list is 0.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Sets the value of a fixed length string element.
Syntax
public
int setElemFString(int index, java.lang.String stringValue);index - The position of the element whose value the application wants to set.
stringValue - The value with which to set the element.
Usage
The first index position in the list is 0.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Sets the value of an integer element.
Syntax
public int setElemInt(int index, int intValue);index - The position of the element whose value the application wants to set.
intValue - The value with which to set the element.
Usage
The first index position in the list is 0.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Sets the value of a string element.
Syntax
public
int setElemString(int index, java.lang.String stringValue);index - The position of the element whose value the application wants to set.
stringValue - The value with which to set the element.
Usage
The first index position in the list is 0.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Sets the value of a variable size byte array element.
Syntax
public int setElemBinary(int index, byte[] buf);index - The position of the element whose value the application wants to set.
buf - The value with which to set the element.
Usage
The first index position in the list is 0.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Specifies the maximum number of elements in the list.
Syntax
public int setMaxElemCount(int maxElemCount);maxElemCount - The maximum number of elements the application wants to specify.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
IBSPDataObjectArray Interface
The IBSPDataObjectArray interface extends the IBSPDataObjectList interface to provide methods for accessing homogeneous data objects; an array's elements are homogeneous. An IBSPDataObjectInfo object is associated with an array to define the type of objects that the array contains.
Package
netscape.bsp.dataobject
Usage
The method creates an instance of the element type info object and adds it to the array. The data type of the element added is determined by the type information object associated with this array.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Determine the type information associated with an array.
Syntax
public
netscape.bsp.dataobject.IBSPDataObjectInfo getElemTypeInfo();
Return Value
An IBSPDataObjectInfo object that contains the type information.
IBSPDataObjectStructure Interface
The IBSPDataObjectStructure interface defines methods for accessing fields in a structure.
Package
netscape.bsp.dataobject
Method
Description
Determines the value of a double precision floating point number field.
Sets the value of a double precision floating point number. field.
Method
Description
Determines the maximum length of a fixed length string field.
Determines whether a field exists in the instance.
Syntax
public boolean fieldExists(java.lang.String fieldName);fieldName - The name of the field to test.
Usage
A field exists if its value exists in the object.
Return Value
A boolean value that is true if the field exists; otherwise, it is false.
Determines whether a field is defined in the repository.
Syntax
public boolean fieldIsDefined(java.lang.String fieldName);fieldName - The name of the field to test.
Usage
A field is defined if its type information is defined in the repository.
Return Value
A boolean value that is true if the field is defined; otherwise, it is false.
Determines the value of a field.
Syntax
public netscape.bsp.dataobject.IBSPDataObject getField(
java.lang.String fieldName);fieldName - The name of the field whose value the application wants to determine.
Usage
If the returned value is of a primitive data type, it is copied into a new primitive data object and the primitive data object is returned; otherwise, a reference to the data object is returned.
Return Value
An IBSPDataObject object that contains the value.
Determines the value of a byte array field.
Syntax
public byte[] getFieldBinary(java.lang.String fieldName);fieldName - The name of the field whose value the application wants to determine.
Return Value
A byte array that contains the value.
Determine the size of a byte array field.
Syntax
public int getFieldBinarySize(java.lang.String fieldName);fieldName - The name of the field whose value the application wants to determine.
Return Value
An integer that contains the size, in bytes.
Determines the current number of fields in the structure.
Syntax
public int getFieldCount();
Return Value
An integer that contains the number of fields.
Determines the data object stored in an field.
Syntax
public
netscape.bsp.dataobject.IBSPDataObject getFieldDataObject(
java.lang.String fieldName);fieldName - The name of the field whose value the application wants to determine.
Return Value
An IBSPDataObject object.
Determines the value of a double precision floating point number field.
Syntax
public double getFieldDouble(java.lang.String fieldName);fieldName - The name of the field whose value the application wants to determine.
Return Value
A double precision floating point number that contains the value.
Determines the value of a floating point number field.
Syntax
public float getFieldFloat(java.lang.String fieldName);fieldName - The name of the field whose value the application wants to determine.
Return Value
A floating point number that contains the value.
Determines the value of a fixed length string field.
Syntax
public java.lang.String getFieldFString(java.lang.String fieldName);fieldName - The name of the field whose value the application wants to determine.
Return Value
A string that contains the value.
Determines the maximum length of a fixed length string field.
Syntax
public int getFieldFStringMaxLen(java.lang.String fieldName);fieldName - The name of the field whose size the application wants to determine.
Return Value
An integer that contains the size, in bytes.
Determines the value of an integer field.
Syntax
public int getFieldInt(java.lang.String fieldName);fieldName - The name of the field whose value the application wants to determine.
Return Value
An integer that contains the value.
Determines the value of a string field.
Syntax
public
java.lang.String getFieldString(java.lang.String fieldName);fieldName - The name of the field whose value the application wants to determine.
Return Value
A string that contains the value.
Determines the type of a field.
Syntax
public int getFieldType(java.lang.String fieldName);fieldName - The name of the field whose value the application wants to determine.
Usage
The first index position in the list is 0.
Return Value
An integer value that specifies the type, which may be one of the following types:
Determines the value of a variable size byte array field.
Syntax
public byte[] getFieldVBinary(java.lang.String fieldName);fieldName - The name of the field whose value the application wants to determine.
Return Value
A byte array that contains the value.
Determines the size of a variablebyte array field.
Syntax
public int getFieldVBinarySize(java.lang.String fieldName);fieldName - The name of the field whose value the application wants to determine.
Return Value
An integer that contains the size, in bytes.
Compares the field type with the specified type.
Syntax
public boolean isFieldType(java.lang.String fieldName,
int typeNumber);fieldName - The name of the field whose value the application wants to determine.
typeNumber - The type with which the application wants to compare this element.
Usage
The first index position in the list is 0. The type may be one of the following:
The application should always use a constant instead of a value in its Servlet, JSP, or EJB; values are subject to change.
Return Value
A boolean value that is true if the type of the element matches the specified type; otherwise, it is false.
Syntax
public int removeField(java.lang.String fieldName);fieldName - The name of the field the application wants to remove.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Sets the value of a binary number field.
Syntax
public
int setFieldBinary(java.lang.String fieldName, byte[] buf);fieldName - The name of the field whose value the application wants to set.
buf - The value with which to set the field.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Sets the data object stored in an field.
Syntax
public int setFieldDataObject(java.lang.String fieldName,
netscape.bsp.dataobject.IBSPDataObject value;fieldName - The name of the field whose value the application wants to set.
value - The value with which to set the field.
Usage
A value for a primitive data type is unwrapped and copied when it is set in the object; in other words, the value is stored in the object, not an object that contains the value. Otherwise, the data object itself is set to the value.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Sets an element to a new empty list.
Syntax
public int setFieldDataObjectList(java.lang.String fieldName);fieldName - The name of the field whose value the application wants to set.
Usage
An empty list is created in the specified field.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Sets an element to a new empty structure.
Syntax
public
int setFieldDataObjectStructure(java.lang.String fieldName);fieldName - The name of the field whose value the application wants to set.
Usage
An empty structure is created in the specified field.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Sets the value of a double precision floating point number. field.
Syntax
public
int setFieldDouble(java.lang.String fieldName, double value);fieldName - The name of the field whose value the application wants to set.
value - The value with which to set the field.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Sets the value of a floating point number field.
Syntax
public
int setFieldFloat(java.lang.String fieldName, float value);fieldName - The name of the field whose value the application wants to set.
value - The value with which to set the field.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Sets the value of a fixed length string field.
Syntax
public
int setFieldFString(java.lang.String fieldName,
java.lang.String stringValue);fieldName - The name of the field whose value the application wants to set.
stringValue - The value with which to set the field.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Sets the value of an integer field.
Syntax
public
int setFieldInt(java.lang.String fieldName, int intValue);fieldName - The name of the field whose value the application wants to set.
intValue - The value with which to set the field.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Sets the value of a string field.
Syntax
public int setFieldString( java.lang.String fieldName,
java.lang.String stringValue);fieldName - The name of the field whose value the application wants to set.
stringValue - The value with which to set the field.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Sets the value of a variable size byte array field.
Syntax
public
int setFieldBinary(java.lang.String fieldName, byte[] buf);fieldName - The name of the field whose value the application wants to set.
buf - The value with which to set the field.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
IBSPDataObjectStructureInfo Interface
The IBSPDataObjectStructureInfo interface defines methods for obtaining information about a IBSPDataObjectStructure object.
Package
netscape.bsp.dataobject
Method
Description
Determines if a field is defined in the structure information.
Determines the field information for a field in a structure object.
Determines if a field is defined in the structure information.
Syntax
public boolean definesField(java.lang.String fieldName);fieldName - The name of the field to test.
Return Value
A boolean value that is true if the field is defined; otherwise, it is false.
Determines the field information for a field in a structure object.
Syntax
public netscape.bsp.dataobject.IBSPDataObjectInfo getFieldInfo(
java.lang.String fieldName);fieldName - The name of the field whose information the application wants to obtain.
Return Value
A IBSPDataObject object the contains the field information.
Determines which fields are in a structure object.
Syntax
public netscape.bsp.dataobject.IBSPDataObjectStructure getFields);
Return Value
A IBSPDataObjectStructure object the contains the fields.
IBSPDataObjectInfo Interface
The IBSPDataObjectInfo interface defines a method for creating an instance of a data object of the same type as the interface.
Package
netscape.bsp.dataobject
Creates an instance of the IBSPDataObjectInfo object.
Syntax
public netscape.bsp.dataobject.IBSPDataObject createInstance();
Return Value
An instance of an IBSPDataObject object.
IBSPDataObjectListInfo Interface
The IBSPDataObjectListInfo interface defines methods for determining or specifying the initial size and maximum size of a list object.
Package
netscape.bsp.dataobject
Determines the initial capacity of the list.
Syntax
public int getInitialSize();
Return Value
An integer that contains the initial size of the list.
Determines the maximum number of elements.
Syntax
public int getInitialSize();
Return Value
An integer that contains the maximum size of the list.
Specifies the initial capacity of the list.
Syntax
public int setInitialSize(int intialSize);initialSize - The initial capacity of the list.
Usage
The list does not physically grow until the capacity has been exceeded.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Specifies the maximum number of elements.
Syntax
public int setMaxElemCount(int maxElemCount);maxElemCount - The maximum size of the list.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
IBSPDataObjectArrayInfo Interface
The IBSPDataObjectArrayInfo interface extends the IBSPDataObjectListInfo interface to define methods for getting and setting the type of elements in the array and the info object associated with the array.
Package
netscape.bsp.dataobject
Determines the array's element type.
Syntax
public int getArrayElemType();
Usage
Use this method if the type is primitive; otherwise, use setArrayElemTypeInfo(). The element type may be one of the following:
The application should always use a constant instead of a value in its Servlet, JSP, or EJB.
Return Value
An integer that contains the type number.
Retrieves the array's type info object.
Syntax
public netscape.bsp.dataobject.IBSPDataObjectInfo
getArrayElemTypeInfo();
Return Value
An IBSPDataObjectInfo object.
Specifies the array's element type.
Syntax
public int setArrayElemType(int elemTypeNumber);elemTypeNumber - The type of elements in the array.
Usage
Use this method if the type is primitive; otherwise, use setArrayElemTypeInfo(). The element type may be one of the following:
The application should always use a constant instead of a value in its Servlet, JSP, or EJB.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Sets the array's type info object.
Syntax
public int setArrayElemTypeInfo
(netscape.bsp.dataobject.IBSPDataObjectInfo elemTypeInfo);elemTypeInfo - The type info object to associate with this array.
Usage
Use this method if the type is not primitive; otherwise, use setArrayElemType(). This method calls setArrayElemType() to set the element type.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
IBSPDataObjectDataItr Interface
The IBSPDataObjectDataItr interface defines methods for iterating over objects in a list, array, or structure. The application calls the next() method to move to the next position in the list, array, or structure. The application calls the getCurrentType() method to determine the type of object at the current location.
Package
netscape.bsp.dataobject
Determines the value of the attribute at the current position.
Syntax
public netscape.bsp.dataobject.IBSPDataObject getCurrent();
Usage
If the returned value is of a primitive data type, it is copied into a new primitive data object and the primitive data object is returned; otherwise, a reference to the data object is returned.
Return Value
An IBSPDataObject object that contains the value at the current position.
Determines the value of a byte array attribute at the current position.
Syntax
public byte[] getCurrentBinary();
Return Value
A byte array that contains the value.
Determines the size of the byte array attribute at the current position.
Syntax
public int getCurrentBinarySize();
Return Value
An integer that contains the size, in bytes.
Determines the value of a data object attribute at the current position.
Syntax
public netscape.bsp.dataobject.IBSPDataObject
getCurrentDataObject();
Return Value
An IBSPDataObject object.
Determines the value of a double precision floating point number attribute at the current position.
Syntax
public double getCurrentDouble();
Return Value
A double precision floating point number that contains the value.
Determines the field name of the field at the current position.
Syntax
public java.lang.String getCurrentFieldName();
Usage
When iterating over a structure, the field name is returned. When iterating over a list or array, the element number is returned as a string enclosed in brackets; for example, [0] is returned for the first element.
Return Value
An string that contains the name.
Determines the value of a floating point number attribute at the current position.
Syntax
public float getCurrentFloat();
Return Value
A floating point number that contains the value.
Determines the value of a fixed length string attribute at the current position.
Syntax
public java.lang.String getCurrentFString();
Return Value
A string that contains the value.
Determines the value of an integer attribute at the current position.
Syntax
public int getCurrentInt();
Return Value
An integer that contains the value.
Determines the value of a string attribute at the current position.
Syntax
public java.lang.String getCurrentString();
Return Value
A string that contains the value.
Determines the type of the attribute at the current position.
Syntax
public int getCurrentType();
Return Value
An integer value that specifies the type. The type may be one of the following:
Determines the value of a variable length byte array attribute at the current position.
Syntax
public byte[] getCurrentBinary();
Return Value
A byte array that contains the value.
Determines the size of the variable length byte array attribute at the current position.
Syntax
public int getCurrentVBinarySize();
Return Value
An integer that contains the size, in bytes.
Compares the type of the attribute at the current position with the specified type.
Syntax
public boolean isCurrentType(int typeNumber);TypeNumber - The type with which the application wants to compare the attribute at this position.
Usage
The type may be one of the following:
The application should always use a constant instead of a value in its Servlet, JSP, or EJB.
Return Value
A boolean value that is true if the type of the attribute matches the specified type; otherwise, it is false.
Advances the current position to the next attribute.
Usage
Use the next() method to advance the current position to the next one in the list or structure. After the application calls next() the first time, the current position becomes 0.
Return Value
A boolean value that is true if there are more attributes in the list or structure; it is false if the current position is the last position in the list or structure.
Specifies the value of a byte array attribute at the current position.
Syntax
public int setCurrentBinary(byte[] buf);buf - The value with which to set the attribute.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Specifies the value of a data object attribute at the current position.
Syntax
public int setCurrentDataObject(
netscape.bsp.dataobject.IBSPDataObject value);value - The value with which to set the attribute.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Specifies the value of a double precision floating point number attribute at the current position.
Syntax
public int setCurrentDouble(double value);value - The double precision floating point number with which to set the attribute.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Specifies the value of a floating point number attribute at the current position.
Syntax
public int setCurrentFloat(float value);value - The floating point number with which to set the attribute.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Specifies the value of a fixed length string attribute at the current position.
Syntax
public int setCurrentFString(java.lang.String value);value - The string value with which to set the attribute.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Specifies the value of an integer attribute at the current position.
Syntax
public int setCurrentInt(int value);value - The floating point number with which to set the attribute.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Specifies the value of a string attribute at the current position.
Syntax
public int setCurrentString(java.lang.String value);value - The string value with which to set the attribute.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
Specifies the value of a string attribute at the current position.
Syntax
public int setCurrentVBinary(byte[] buf);buf - The value with which to set the attribute.
Return Value
An integer that contains:
- GXE.SUCCESS - if the operation is successful
- GXE.FAIL - if the operation fails
BspException Class
The netscape.bsp.BspException exception extends the java.lang.RuntimeException. All exceptions thrown in UIF and the enterprise connector extend the netscape.bsp.BspException class.
Gets the exception information details.
Syntax
public IBSPDataObjectStructure getInfo();
Return Value
IBSPDataObjectStructure object containing the exception information.
DataObjectException Class
The DataObjectException exception is thrown when a data object exception occurs in the UIF runtime. DataObjectException extends netscape.bsp.BspException. Note that all data object exceptions extend the DataObjectException interface.
Package
netscape.bsp.dataobject.exceptions
FieldNameIsNullException Class
The FieldNameIsNullException is thrown when a data object field name being accesed is null. Please check the UIF Repository contents to determine the availability of the field being accessed and make sure a name is assigned to a field.
Package
netscape.bsp.dataobject.exceptions
FieldNameTooLongException Class
The FieldNameTooLongException exception is thrown when a data object field is being accessed whose name is too long. The maximum field length allowed is 64. Please check the UIF repository content and modify the name accordingly.
Package
netscape.bsp.dataobject.exceptions
FieldNotFoundException Class
The FieldNotFoundException exception is thrown when a data object field or the data object is not found in the repository. Check the UIF Repository content and make sure the field being accessed exist in the UIF Repository.
Package
netscape.bsp.dataobject.exceptions
IllegalPathException Class
The IllegalPathException exception is thrown when a data object or data object field name is specified wrong. Please verify the application against the UIF Repository contents and modify the application accordingly.
Package
netscape.bsp.dataobject.exceptions
IllegalRecusionException Class
The IllegalRecusionException exception is thrown when data objects are being accessed in the wrong manner. Please refer to Chapter 5 "Programming Model" for more details on the illegal data object recursions.
Package
netscape.bsp.dataobject.exceptions
IndexOutOfBoundsException Class
The IndexOutOfBoundsException exception is thrown when the application tries to traverse a non existing index.
Package
netscape.bsp.dataobject.exceptions
MethodUnsupportedException Class
The MethodUnsupportedException exception is thrown when the application tries to access a method that is unsupported on a given data object.
Package
netscape.bsp.dataobject.exceptions
TypeMismatchException Class
The TypeMismatchException exception is thrown when a type mismatch in the data object values are being set by the application. Please check the data type in the UIF Repository and set the values accordingly.
Package
netscape.bsp.dataobject.exceptions
Previous Contents Index DocHome Next
Copyright © 2000 Sun Microsystems, Inc. Some preexisting portions Copyright © 2000 Netscape Communications Corp. All rights reserved.
Last Updated October 19, 2000