Skip to main content

%Library.List

Class %Library.List [ ClassType = datatype, ClientDataType = LIST, System = 2 ]

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.

Parameters​

ODBCDELIMITER​

Parameter ODBCDELIMITER = ",";

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.

XSDTYPE​

Parameter XSDTYPE = "string";

Declares the XSD type used when projecting XML Schemas.

JSONTYPE​

Parameter JSONTYPE = "string";

JSONTYPE is JSON type used for this datatype.

Methods​

XSDToLogical​

ClassMethod XSDToLogical(val As %String) As %List [ CodeMode = generator ]

Converts the SOAP encoded input list value into a ObjectScript $list value.

LogicalToXSD​

ClassMethod LogicalToXSD(val As %List) As %String [ CodeMode = generator ]

Converts the ObjectScript $list value to the canonical SOAP encoded value.

LogicalToOdbc​

ClassMethod LogicalToOdbc(val = "") As %String [ CodeMode = generator ]

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​

ClassMethod OdbcToLogical(val = "") As %String [ CodeMode = generator ]

Converts the value of an incoming delimited string to $List format using the value of the ODBCDELIMITER parameter as a delimiter.