IRISLIB database
Status Class Reference

The Status data type class is used to represent an error status code. More...

Static Public Member Functions

_.Library.String LogicalToOdbc (_, val)
 Converts the value of this data type from $List format to a delimited string. More...
 
_.Library.String LogicalToXSD (_, _.Library.Binary val)
 Converts the Binary value to the SOAP base64 encoded value.
 
_.Library.Binary XSDToLogical (_, _.Library.String val)
 Converts the SOAP encoded base64 input value to a logical value.
 

Static Public Attributes

 JSONTYPE = None
 The Status data type class is used to represent an error status code. More...
 
 XSDTYPE = None
 Declares the XSD type used when projecting XML Schemas.
 

Detailed Description

The Status data type class is used to represent an error status code.

Many of the methods provided by the system classes return error status information using the Status data type. The include file occStatus.INC contains several macro definitions that are useful in testing the value of an error code in Status format. These macros include:

  • $$$ISOK(status:Status) returns true (1) if the status code status does not represent an error condition.
  • $$$ISERR(status:Status) returns true (1) if the status code status represents an error condition.

You can get a more detailed description of an error by using
$system.Status.DecomposeStatus(status:Status,&err,flag), which takes a status code and returns an array of error strings; see <class>SYSTEM.Status</class>.

For example:

Set status=obj.Save() If $$$ISERR(status) Do $system.Status.DecomposeStatus(status,.err,"-d") For i=1:1:err Write err(i),!

Member Function Documentation

◆ LogicalToOdbc()

_.Library.String LogicalToOdbc (   _,
  val 
)
static

Converts the value of this data type from $List format to a delimited string.

using the value of the ODBCDELIMITER parameter as a delimiter.

Member Data Documentation

◆ JSONTYPE

JSONTYPE = None
static

The Status data type class is used to represent an error status code.

Many of the methods provided by the system classes return error status information using the Status data type. The include file occStatus.INC contains several macro definitions that are useful in testing the value of an error code in Status format. These macros include:

  • $$$ISOK(status:Status) returns true (1) if the status code status does not represent an error condition.
  • $$$ISERR(status:Status) returns true (1) if the status code status represents an error condition.

You can get a more detailed description of an error by using
$system.Status.DecomposeStatus(status:Status,&err,flag), which takes a status code and returns an array of error strings; see <class>SYSTEM.Status</class>.

For example:

Set status=obj.Save() If $$$ISERR(status) Do $system.Status.DecomposeStatus(status,.err,"-d") For i=1:1:err Write err(i),!

JSONTYPE is JSON type used for this datatype.