IRISLIB database
StatementColumn Class Reference

SQL.StatementColumn - contains the metadata for a statement column whose column type is SQLRESULTCOL. More...

Inheritance diagram for StatementColumn:
Collaboration diagram for StatementColumn:

Public Attributes

 ODBCType
 The column ODBC type integer: More...
 
 clientType
 Returns the type of column n in the result set where type is an integer associated with. More...
 
 colName
 The column name. More...
 
 isAliased
   More...
 
 isAutoIncrement
   More...
 
 isCaseSensitive
   More...
 
 isCurrency
   More...
 
 isExpression
   More...
 
 isHidden
   More...
 
 isIdentity
   More...
 
 isKeyColumn
   More...
 
 isList
   More...
 
 isNullable
 isNullable is TRUE (1) if the column value can be NULL. More...
 
 isReadOnly
   More...
 
 isRowId
   More...
 
 isRowVersion
   More...
 
 isUnique
   More...
 
 label
   More...
 
 precision
 Precision. More...
 
 property
 If this column corresponds to a property from the class that projected. More...
 
 qualifier
   More...
 
 scale
 Scale. More...
 
 schemaName
 The schema qualifier of tableName. More...
 
 tableName
 The table where this column originates. More...
 
 typeClass
 The objects type class. More...
 

Private Member Functions

_.Library.DynamicObject ToDynamicObject (_.Library.DynamicObject target, ignoreUnknown)
 Default mechanism for mapping the fields of a registered object to. More...
 
_.Library.String ToJSONValue (outstr)
 Default behavior of the JSON generation facility. More...
 

Additional Inherited Members

- Public Member Functions inherited from SwizzleObject
_.Library.Status OnJournalObject (_.Library.Integer tranid, _.Library.Integer jrnid, _.Library.String filter)
 This callback method is invoked by the <METHOD>JournalObject</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 OnClose ()
 This callback method is invoked by the <METHOD>Close</METHOD> method to. 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...
 
- Static Public Member Functions inherited from SerialObject
_.Library.String LogicalToOdbc (_.Library.String val)
 Converts the serial state of this serial object to a delimited string. More...
 
_.Library.String OdbcToLogical (_.Library.String val)
 Converts the value of an incoming delimited string to a serialized state. More...
 
- Static Public Attributes inherited from SerialObject
 ODBCDELIMITER = None
 A serial object is converted to a delimited string containing the. More...
 
 SERIALDELIMITER = None
 This parameter specifies the delimiter character used when created a serialized. More...
 
 VALIDIFNULL = None
 If true, ValidateObject will return $$$OK for instances that are null as determined by IsNull(). More...
 
- Static Public Attributes inherited from SwizzleObject
 DEFAULTCONCURRENCY = None
 DEFAULTCONCURRENCY is the default value for the concurrency formal argument. More...
 
 JOURNALSTREAM = None
 If OBJJOURNAL is true then the value of the JOURNALSTREAM parameter defines whether or not. More...
 
 OBJJOURNAL = None
 if OBJJOURNAL is TRUE then inserts, updates and deletes will be logged in ^OBJ.JournalT More...
 
- 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

SQL.StatementColumn - contains the metadata for a statement column whose column type is SQLRESULTCOL.

Member Function Documentation

◆ ToDynamicObject()

_.Library.DynamicObject ToDynamicObject ( _.Library.DynamicObject  target,
  ignoreUnknown 
)
private

Default mechanism for mapping the fields of a registered object to.

the key-value pairs of a dynamic entity. This method exists only to provide the user with the ability to override the default composition of a dynamic object from a registered object.

◆ ToJSONValue()

_.Library.String ToJSONValue (   outstr)
private

Default behavior of the JSON generation facility.

Map the current

registered object into a dynamic one via $toAbstractObject() and output the JSON representation of the abstract object. Subclasses may wish to override this routine to perform post processing on the abstract object prior to JSON generation, or dispense with the abstract layer entirely in favor of direct, local JSON output

Member Data Documentation

◆ ODBCType

ODBCType

The column ODBC type integer:

 

◆ clientType

clientType

Returns the type of column n in the result set where type is an integer associated with.

the client datatype. If the type cannot be determined, 0 (zero) is returned.

1BINARY
2DATE
3DOUBLE
4HANDLE
5INTEGER
6LIST
7LONGVARCHAR
8TIME
9TIMESTAMP
10VARCHAR
11STATUS
12BINARYSTREAM
13CHARACTERSTREAM
14NUMERIC
15CURRENCY
16BOOLEAN
17OID
18BIGINT
19FDATE
20FTIMESTAMP

 

◆ colName

colName

The column name.

 

◆ isAliased

isAliased

 

 

◆ isAutoIncrement

isAutoIncrement

 

 

◆ isCaseSensitive

isCaseSensitive

 

 

◆ isCurrency

isCurrency

 

 

◆ isExpression

isExpression

 

 

◆ isHidden

isHidden

 

 

◆ isIdentity

isIdentity

 

 

◆ isKeyColumn

isKeyColumn

 

 

◆ isList

isList

 

 

◆ isNullable

isNullable

isNullable is TRUE (1) if the column value can be NULL.

 

◆ isReadOnly

isReadOnly

 

 

◆ isRowId

isRowId

 

 

◆ isRowVersion

isRowVersion

 

 

◆ isUnique

isUnique

 

 

◆ label

label

 

 

◆ precision

precision

Precision.

 

◆ property

property

If this column corresponds to a property from the class that projected.

the tableName table. This property is NULL if the column cannot be linked to a property.  

◆ qualifier

qualifier

 

 

◆ scale

scale

Scale.

 

◆ schemaName

schemaName

The schema qualifier of tableName.

 

◆ tableName

tableName

The table where this column originates.

 

◆ typeClass

typeClass

The objects type class.