Skip to main content

HS.Util.WebServices.ServiceStatus

class HS.Util.WebServices.ServiceStatus extends %Library.RegisteredObject, %XML.Adaptor, %JSON.Adaptor

Property Inventory

Parameters

parameter %JSONENABLED = 0;
If this parameter is true then JSON-enabling methods will be generated. Otherwise, the method generators do not produce a runnable method.
parameter XMLIGNOREINVALIDTAG = 1;
Inherited description: The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected elements in the XML input. The XMLIGNOREINVALIDTAG parameter will only take affect if XMLSEQUENCE = 0 (the default). By default (XMLIGNOREINVALIDTAG = 0), will treat an unexpected element as an error. If XMLIGNOREINVALIDTAG is set = 1 and XMLSEQUENCE = 0, then unexpected elements will be ignored.
parameter XMLIGNORENULL = inputonly;
Inherited description: XMLIGNORENULL allows the programmer to override the default XML handling of empty strings for properties of type %String. By default (XMLIGNORENULL = 0), empty strings in the XML input are stored as $c(0) and $c(0) is written to XML as an empty tag. A missing tag in the XML input is always stored as "" and "" is always output to XML as no tag.

If XMLIGNORENULL is set = 1, then both missing tags in the XML and empty strings are input as "", and both "" and $c(0) are output as empty tags (i.e. <tag></tag>).

If XMLIGNORENULL is set = "inputonly", then both missing tags in the XML and empty strings are input as "". Output of "" and $c(0) are for XMLIGNORENULL = 0: $c(0) is output as an empty tag (i.e. <tag></tag>) and "" is output as no tag.

If XMLIGNORENULL = "runtime" (runtime is not case sensitive), then the behavior of XMLIGNORENULL is determined by the format parameter of XMLExport, XMLImport and %XML.Reader.OpenFile. The default behavior for XMLIGNORENULL="runtime is the same as XMLIGNORENULL=0. Adding "ignorenull" to the format argument changes the behavior to that of XMLIGNORENULL=1. "ignorenull" shoud be separated by a comma from literal/encoded part of the format. Example values for format are "", ",ignorenull", "literal,ignorenull" and "encoded,ignorenull". Note that "inputonly" is equivalent to using ,ignorenull for XMLExport and not for %XML.Reader.

Properties

property %Gateway as %String [ InitialExpression = $namespace ];
Property methods: %GatewayDisplayToLogical(), %GatewayGet(), %GatewayIsValid(), %GatewayLogicalToDisplay(), %GatewayLogicalToOdbc(), %GatewayNormalize(), %GatewaySet()
property %Roles as %String) [ InitialExpression = $Roles ];
Property methods: %RolesDisplayToLogical(), %RolesGet(), %RolesIsValid(), %RolesLogicalToDisplay(), %RolesLogicalToOdbc(), %RolesNormalize(), %RolesSet()
property %User as %String [ InitialExpression = $Username ];
Property methods: %UserDisplayToLogical(), %UserGet(), %UserIsValid(), %UserLogicalToDisplay(), %UserLogicalToOdbc(), %UserNormalize(), %UserSet()
property Status as %Status;
Property methods: StatusGet(), StatusIsValid(), StatusLogicalToOdbc(), StatusLogicalToXSD(), StatusSet(), StatusXSDToLogical()

Inherited Members

Inherited Methods

Subclasses

FeedbackOpens in a new tab