HS.Reports.Management.Config

persistent class HS.Reports.Management.Config extends %Library.Persistent, %XML.Adaptor

SQL Table Name: HS_Reports_Management.Config

Property Inventory

Code
Name
ReportUIClass
ResourceRequired

Method Inventory

ListReportsClose()
ListReportsExecute()
ListReportsFetch()
ListReportsWeb()

Parameters

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 Code as %String (MAXLEN = 200) [ Required ];

Property methods: CodeDisplayToLogical(), CodeGet(), CodeGetStored(), CodeIsValid(), CodeLogicalToDisplay(), CodeLogicalToOdbc(), CodeNormalize(), CodeSet()

property Name as %String (MAXLEN = 200);

Property methods: NameDisplayToLogical(), NameGet(), NameGetStored(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()

property ReportUIClass as %String (MAXLEN = 200);

Property methods: ReportUIClassDisplayToLogical(), ReportUIClassGet(), ReportUIClassGetStored(), ReportUIClassIsValid(), ReportUIClassLogicalToDisplay(), ReportUIClassLogicalToOdbc(), ReportUIClassNormalize(), ReportUIClassSet()

property ResourceRequired as %String (MAXLEN = 200);

Property methods: ResourceRequiredDisplayToLogical(), ResourceRequiredGet(), ResourceRequiredGetStored(), ResourceRequiredIsValid(), ResourceRequiredLogicalToDisplay(), ResourceRequiredLogicalToOdbc(), ResourceRequiredNormalize(), ResourceRequiredSet()

Methods

classmethod ListReportsClose(ByRef qHandle As %Binary) as %Status

classmethod ListReportsExecute(ByRef qHandle As %Binary) as %Status

classmethod ListReportsFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status

classmethod ListReportsWeb() as HS.Reports.Management.ConfigContainer

Queries

query ListReports()

Selects Code As %String, ReportUIClass As %String, Name As %String, ResourceRequired As %String

List receiving systems via web service call

query Reports()

SQL Query:
SELECT Code, ReportUIClass, Name, ResourceRequired FROM Config ORDER BY Name

Indexes

index (ClassIndex on ReportUIClass);

Index methods: ClassIndexExists()

index (CodeIndex on Code) [IdKey, Type = key, Unique];

Index methods: CodeIndexCheck(), CodeIndexDelete(), CodeIndexExists(), CodeIndexOpen(), CodeIndexSQLCheckUnique(), CodeIndexSQLExists(), CodeIndexSQLFindPKeyByConstraint(), CodeIndexSQLFindRowIDByConstraint()

index (NameIndex on Name) [Unique];

Index methods: NameIndexCheck(), NameIndexCheckUnique(), NameIndexDelete(), NameIndexExists(), NameIndexOpen(), NameIndexSQLCheckUnique(), NameIndexSQLExists(), NameIndexSQLFindPKeyByConstraint(), NameIndexSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods

Storage

Storage Model: Storage (HS.Reports.Management.Config)

^HS.Reports.Management.ConfigD(ID)

%%CLASSNAME

Name

ResourceRequired

ReportUIClass