Skip to main content

%Library.Boolean

Class %Library.Boolean Extends %Integer [ ClientDataType = BOOLEAN, OdbcType = BIT, SqlCategory = INTEGER, System = 2 ]

The %Boolean data type class represents a boolean value.

The logical value of the %Boolean data type is an integer with value of 0 (false) and 1 (true).

Parameters​

XSDTYPE​

Parameter XSDTYPE = "boolean";

Declares the XSD type used when projecting XML Schemas.

JSONTYPE​

Parameter JSONTYPE = "boolean";

Methods​

XSDToLogical​

ClassMethod XSDToLogical(%val As %String) As %Boolean [ CodeMode = generator, ServerOnly = 1 ]

Converts the SOAP encoded input value, which is true, false 1 or 0, into a %Boolean value.

LogicalToXSD​

ClassMethod LogicalToXSD(%val As %Boolean) As %String [ CodeMode = generator, ServerOnly = 1 ]

Converts the %Boolean value to the canonical SOAP encoded value.

DisplayToLogical​

ClassMethod DisplayToLogical(%val As %String) As %Boolean [ ServerOnly = 0 ]

Converts the input value %val, which is a string representing a boolean value, into a boolean value.

Returns the boolean value of the input string %val.

Normalize​

ClassMethod Normalize(%val As %RawString) As %Integer [ ServerOnly = 1 ]

Converts %val to a normalized value.

IsValid​

ClassMethod IsValid(%val As %RawString = "") As %Status [ CodeMode = generator, ServerOnly = 0 ]

Tests if the boolean value %val is valid.

LogicalToDisplay​

ClassMethod LogicalToDisplay(%val As %Boolean) As %String [ ServerOnly = 0 ]

Converts the value of %val, which is in boolean format, into a display string.

Returns the formatted value of %val.