IRISLIB database
List Class Reference

The List data type class is used to represent data that is in $List format. More...

Inheritance diagram for List:

Static Public Member Functions

_.Library.String LogicalToOdbc (val)
 Converts the value of this data type from $List format to a delimited string. More...
 
_.Library.String LogicalToXSD (_.Library.List val)
 Converts the ObjectScript $list value to the canonical SOAP encoded value.
 
_.Library.String OdbcToLogical (val)
 Converts the value of an incoming delimited string to $List format. More...
 
_.Library.List XSDToLogical (_.Library.String val)
 Converts the SOAP encoded input list value into a ObjectScript $list value.
 

Static Public Attributes

 JSONTYPE = None
 JSONTYPE is JSON type used for this datatype.
 
 ODBCDELIMITER = None
 A List value is converted to a delimited string when. More...
 
 XSDTYPE = None
 Declares the XSD type used when projecting XML Schemas.
 

Detailed Description

The List data type class is used to represent data that is in $List format.

The logical value for List is a list of elements in $List format.

When a List data type value is projected to a client application, it exposes it as a syslist object. This allows the client application to efficiently manipulate the contents of the list.

Note that $List format is a compressed binary format; for this reason, a property of type of List cannot be set through SQL nor can its value be queried through SQL (such as with a WHERE clause).

Refer to the documentation on $List in the ObjectScript Reference for more information.

Member Function Documentation

◆ LogicalToOdbc()

_.Library.String LogicalToOdbc (   val)
static

Converts the value of this data type from $List format to a delimited string.

using the value of the ODBCDELIMITER parameter as a delimiter.

◆ OdbcToLogical()

_.Library.String OdbcToLogical (   val)
static

Converts the value of an incoming delimited string to $List format.

using the value of the ODBCDELIMITER parameter as a delimiter.

Member Data Documentation

◆ ODBCDELIMITER

ODBCDELIMITER = None
static

A List value is converted to a delimited string when.

it is projected via ODBC. ODBCDELIMITER is the delimiter character used to construct the delimited string.