Skip to main content

%Library.Integer

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

The %Integer data type class represents an integer value.

The logical value of the %Integer data type is an integer. The %Integer datatype does not have built-in limits. It is a hybrid datatype the values of which is not exact outside of a certain range (currently it is the same range as that of the 64-bit integer value). The current range for xDBC projections can be seen under configuration/advanced. Its default corresponds to the usual signed 32-bit integer limits.

Parameters​

FORMAT;​

Parameter FORMAT;

The format specification for the data type's display value.

The value of FORMAT corresponds to the formatting option of the $FNUMBER function, which is used to perform the formatting.

MAXVAL​

Parameter MAXVAL As INTEGER;

The maximum allowed logical value for the data type.

MINVAL​

Parameter MINVAL As INTEGER;

The minimum allowed logical value for the data type.

XMLTotalDigits;​

Parameter XMLTotalDigits;

The total number of digits for XML verification as defined by http://www.w3.org/TR/xmlschema-2/#rf-totalDigits

VALUELIST;​

Parameter VALUELIST;

Used for enumerated (multiple-choice) attributes. VALUELIST is either a null string ("") or a delimiter separated list (where the delimiter is the first character) of logical values. If a non-null value is present, then the attribute is restricted to values in the list, and the validation code simply checks to see if the value is in the list.

DISPLAYLIST;​

Parameter DISPLAYLIST;

Used for enumerated (multiple-choice) attributes. Used in conjunction with the VALUELIST parameter for enumerated (multiple-choice) attributes. DISPLAYLIST, if not null, represents the display values for the attribute corresponding with the logical values listed in VALUELIST.

The display values are returned by the LogicalToDisplay method.

XSDTYPE​

Parameter XSDTYPE = "long";

Declares the XSD type used when projecting XML Schemas.

JSONTYPE​

Parameter JSONTYPE = "number";

STRICT​

Parameter STRICT = 0;

If '1' then IsValid will return false for numbers that are not integers e.g. 1.2, -0.01 rather than the default behavior which is to allow these an normalize them to an integer. This validation is done by $number using "I" format, so the rules associated with this function apply.

Methods​

XSDToLogical​

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

Converts the SOAP encoded input decimal value into a logical value. Returns "" for error.

DisplayToLogical​

ClassMethod DisplayToLogical(%val As %String) As %Integer [ CodeMode = generator, ServerOnly = 0 ]

Converts the input value %val, which is a string representing an integer, into a logical integer value.

Returns the logical integer 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 logical value %val, which is an integer value, is valid. The validation is based on the class parameter settings used for the class attribute this data type is associated with. In this case, MAXVAL and MINVAL.

LogicalToDisplay​

ClassMethod LogicalToDisplay(%val As %Integer) As %String [ CodeMode = generator, ServerOnly = 0 ]

Converts the value of %val, which is in logical integer format, into a display string. The formatting is based on the value of the FORMAT parameter.

Returns the formatted value of %val.