Class %Library.List

datatype class %Library.List

ODBC Type: VARCHAR

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.

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
3		4

Summary

Methods
LogicalToOdbc	LogicalToXSD	OdbcToLogical	XSDToLogical

Subclasses
%IPM.DataType.ListOfOptions	%Library.ListOfBinary

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 LogicalToOdbc(val="") as %String

Converts the value of this data type from $List 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 $List 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.


[USER] > [%Library] > [List]		Private Storage