%Library.List

datatype class %Library.List

ODBC Type: VARCHAR

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 $ListOpens in a new tab in the ObjectScript Reference for more information.

Method Inventory

• IsValid()
• LogicalToOdbc()
• LogicalToXSD()
• OdbcToLogical()
• XSDToLogical()

Parameters

parameter JSONTYPE = string;

JSONTYPE is JSON type used for this datatype.

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.

parameter XSDTYPE = string;

Declares the XSD type used when projecting XML Schemas.

Methods

classmethod IsValid(%val As %RawString = "") as %Status

Tests if the list value %val is valid.

classmethod LogicalToOdbc(val="") as %String

Converts the value of this data type from $ListOpens in a new tab format to a delimited string using the value of the ODBCDELIMITER parameter as a delimiter.

classmethod LogicalToXSD(val As %List) as %String

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

classmethod OdbcToLogical(val="") as %String

Converts the value of an incoming delimited string to $ListOpens in a new tab format using the value of the ODBCDELIMITER parameter as a delimiter.

classmethod XSDToLogical(val As %String) as %List

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