Skip to main content

%SYS.PTools.ModuleName

Class %SYS.PTools.ModuleName Extends %String [ ClassType = datatype, ClientDataType = VARCHAR, OdbcType = VARCHAR, SqlCategory = STRING, System = 4 ]

Parameters​

MAXVAL;​

Parameter MAXVAL;

The maximum allowed logical value for the data type.

MINVAL;​

Parameter MINVAL;

The minimum allowed logical value for the data type.

Methods​

IsValid​

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

Tests if the logical value %val, which represents an SQL Module 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.

DisplayToLogical​

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

Converts the input value %val, which represents an SQL Module in display format (String), into an SQL Module # (logical format).

Returns the logical value of the input string %val.

LogicalToDisplay​

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

Converts the value of %val, which represents an SQL Module in logical format (Integer), into an SQL Module Name (display string).

Returns the display value of input string %val.

OdbcToLogical​

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

Converts the input value %val, which represents an SQL Module in ODBC format (String), into an SQL Module # (logical format).

Returns the ODBC logical value of the input string %val.

LogicalToOdbc​

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

Converts the value of %val, which represents an SQL Module in logical format (Integer), into an SQL Module Name (ODBC VARCHAR).

Returns the ODBC display value of input string %val.