Custom Class Reference

Inheritance diagram for Custom:

Collaboration diagram for Custom:

Public Member Functions
_.Library.Status	OpenCursor ()
	User written code to open the cursor here, you may also add arguments to the method.
Public Member Functions inherited from IResultSet
_.Library.Status	CloseCursor ()
	This method is expected to be overridden by concrete subclasses.
_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...
_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...
_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Private Member Functions
_.Library.String	Get (_.Library.String colname)
	Get(colname) More...
_.Library.String	GetData (_.Library.Integer colnbr)
	GetData(<column number>) More...
	MetadataGet ()
	Override the Metadata property's Get() method.
_.Library.Integer	SendODBC ()
	Fetch and send a series of rows for the ODBC/JDBC server. More...

Static Private Member Functions
	GetSerializedMetaData ()
	Get the serialized Metadata property value. More...
_.Library.IResultSet	Prepare (_.Library.String queryId, _, _.SYSTEM.Error returnError, _, _.Library.RawString importPackages, _, args)
	Prepare() More...
_.ResultSet.MetaData	PrepareMetaData (_.Library.String class, _.SYSTEM.Error returnError, _.Library.RawString importPackages)
	PrepareMetaData is similar to Prepare except that no result set is instantiated. More...

Additional Inherited Members
Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...
	JAVATYPE = None
	The Java type to be used when exported.
	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Detailed Description

This class has been superseded. It will remain for compatibility with existing code and samples. We recommend using <class>SQL.CustomResultSet</class>.

Member Function Documentation

Get()

_.Library.String Get ( _.Library.String  colname )

private

Get(colname)

Get the value of the property whose column name is colname.

GetData()

_.Library.String GetData ( _.Library.Integer  colnbr )

private

GetData(<column number>)

        Returns the value of the column referenced by colnbr. Object values are not swizzled automatically.

GetSerializedMetaData()

GetSerializedMetaData ( )

staticprivate

Get the serialized Metadata property value.

Used by both the instance method MetadataGet and the PrepareMetaData class method.

Prepare()

_.Library.IResultSet Prepare ( _.Library.String  queryId,   _, _.SYSTEM.Error  returnError,   _, _.Library.RawString  importPackages,   _,   args  )

staticprivate

Prepare()

This method is different for each type of result set class. This method has two tasks. First, instantiate the correct
concrete result set class. Think of the first parameter, queryId, as being an "index key value" that is used to lookup
the correct query implementation. For non-cached (static) queries this is simply the name of the class that implements
the query, i.e. the %IResultSet interface. The second task is to prepare the resulting object for data
retrieval by the caller which is done in %OnNew. The assumption is that if the query requires any parameters
then the actual arguments are all literal or public variables.

queryId     the concrete subclass of %IResultSet that implements the desired query. For dynamic cached results this value
            is generally the query text that can be parsed, a hashed value computed and the cached result implementation class
            looked up in the query cache index.
%returnError    If an error occurs this is returned by reference and is a %SYSTEM.Error object
                with properties set to describe information about the error
%importPackages This is a comma delimited list of packages to import. This is only relevant if the result set implementation is
                generated and the query source might include unqualified names. The import packages list is used to resolve package/schema names for
                unqualified names.

PrepareMetaData()

_.ResultSet.MetaData PrepareMetaData ( _.Library.String  class, _.SYSTEM.Error  returnError, _.Library.RawString  importPackages  )

staticprivate

PrepareMetaData is similar to Prepare except that no result set is instantiated.

This

method returns a ResultSet.MetaData object. Be aware that the implementation of this method might cause the result set to be instantiated but that is up to the result set class itself and no result set is actually returned by this method - only metadata.

class This is the custom result set class

returnError If an error occurs this is returned by reference and is a SYSTEM.Error object with properties set to describe information about the error. returnError.Status contains the Status value. importPackages This is a comma delimited list of packages to import. This is only relevant if the result set implementation is generated and the query source might include unqualified names. The import packages list is used to resolve package/schema names for unqualified names.

SendODBC()

_.Library.Integer SendODBC ( )

private

Fetch and send a series of rows for the ODBC/JDBC server.

For internal use only.