Skip to main content


persistent class EnsLib.PubSub.DomainName extends %Library.Persistent, %XML.Adaptor, %CSP.Util.AutoForm

SQL Table Name: EnsLib_PubSub.DomainName

Define a PubSub subscription DomainName; This is used to maintain separate lists of subscriptions.

Property Inventory

Method Inventory


parameter DOMAIN = Ensemble;
Use our own domain for localization
parameter XMLIGNORENULL = 1;
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.

parameter XMLNAME = Domain;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.


property Description as %String (MAXLEN = 500, XMLPROJECTION = "ATTRIBUTE");
Description of this domain
Property methods: DescriptionDisplayToLogical(), DescriptionGet(), DescriptionGetStored(), DescriptionIsValid(), DescriptionLogicalToDisplay(), DescriptionLogicalToOdbc(), DescriptionNormalize(), DescriptionSet()
property Name as %String (MAXLEN = 100, XMLPROJECTION = "ATTRIBUTE") [ Required ];
Name of this domain
Property methods: NameDisplayToLogical(), NameGet(), NameGetStored(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()


method OnSubmit(ByRef pID As %String, pSubmit As %String) as %Status
This callback is called when this form is submitted. pID is the ID value associated with the form. The default implementation will perform a Save if the AutoForm is a persistent object.
pSubmit is the name of the submit button (i.e., $AUTOFORM_SAVE).


query Enumerate()
SQL Query:
SELECT ID,Name,Description FROM DomainName ORDER BY Name


index (NameIDX on Name) [IdKey, Type = key];
Index methods: NameIDXCheck(), NameIDXDelete(), NameIDXExists(), NameIDXOpen(), NameIDXSQLCheckUnique(), NameIDXSQLExists(), NameIDXSQLFindPKeyByConstraint(), NameIDXSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods


Storage Model: Storage (EnsLib.PubSub.DomainName)

FeedbackOpens in a new tab