Print Page as PDF
xobw.error.DialogError ICR (5460)

xobw.error.DialogError    ICR (5460)

Name Value
NUMBER 5460
IA # 5460
DATE CREATED 2009/06/10
CUSTODIAL PACKAGE WEB SERVICES CLIENT
USAGE Supported
TYPE Other
DBIC APPROVAL STATUS APPROVED
NAME xobw.error.DialogError
GENERAL DESCRIPTION 
class xobw.error.DialogError extends
xobw.error.AbstractError

Class for errors associated with DIALOG file (#.84) entries and used by the
HWSC error processing sub-system

The Kernel API EZBLD^DIALOG should be used to produce the 'text' property
value and the ien of the DIALOG file entry should be the 'code' property
value.
STATUS Active
DURATION Till Otherwise Agreed
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
code 
property code As %String (TRUNCATE = 1)

Code associated with the error.
errorType 
property errorType As %String (TRUNCATE = 1)

Human readable name for the type of error.
text 
list property text As %String (TRUNCATE = 1)

Human readable text that provides information about the error.
decompose 
method decompose(ByRef error) returns nothing.

This method converts the error object properties into a traditional M array.
VARIABLES TYPE VARIABLES DESCRIPTION
error Both 
pass by reference. Structure of ARRAY returned in
this parameters:

ARRAY("errorType") = type of error (BASIC, DIALOG) ARRAY("code") = error code
ARRAY("text") = ARRAY("text",i..n) =
display 
method display() returns nothing.

This method provides a simple display of the error using MUMPS WRITE commands.

Information displayed: - Class name - Properties:
- code
- text
DATE ACTIVATED: JUN 17, 2009