Home > Class Reference > ENSLIB namespace > EnsLib.PubSub.Target

EnsLib.PubSub.Target

persistent class EnsLib.PubSub.Target extends %Library.Persistent, %XML.Adaptor

SQL Table Name: EnsLib_PubSub.Target

Represents a target for a publish/subscribe message routing request.

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

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 XMLSUMMARY = Name;
Inherited description: The summary fields to be used when an object is referenced are specified by the object's XMLSUMMARY class parameter. XMLSUMMARY is a comma separated, unordered list of properties to include in the object summary. Properties are mapped to the XML in the order that the properties appear in the class not in the list order. If XMLSUMMARY is not specified then all properties are included in the summary.

Properties (Including Private)

property %CorrespondingResponse as EnsLib.PubSub.Response (XMLPROJECTION = "NONE");
(internal) This is set for target objects that are to be deleted when their corresponding response object is deleted.
Property methods: %CorrespondingResponseGet(), %CorrespondingResponseGetObject(), %CorrespondingResponseGetObjectId(), %CorrespondingResponseGetStored(), %CorrespondingResponseGetSwizzled(), %CorrespondingResponseIsValid(), %CorrespondingResponseNewObject(), %CorrespondingResponseSet(), %CorrespondingResponseSetObject(), %CorrespondingResponseSetObjectId(), %CorrespondingResponseUnSwizzle()
property Address as %String (MAXLEN = 128, XMLPROJECTION = "ATTRIBUTE");
(optional) External address used to send the message. (For example, an e-mail address).
Property methods: AddressDisplayToLogical(), AddressGet(), AddressGetStored(), AddressIsValid(), AddressLogicalToDisplay(), AddressLogicalToOdbc(), AddressNormalize(), AddressSet()
property Name as %String (MAXLEN = 128, XMLPROJECTION = "ATTRIBUTE");
(Optional) Name of this target
Property methods: NameDisplayToLogical(), NameGet(), NameGetStored(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()
property Target as %String (MAXLEN = 128, XMLPROJECTION = "ATTRIBUTE");
Target to which message should be sent. This is the name of a configured Business Process or Operation within the current production.
Property methods: TargetDisplayToLogical(), TargetGet(), TargetGetStored(), TargetIsValid(), TargetLogicalToDisplay(), TargetLogicalToOdbc(), TargetNormalize(), TargetSet()

Methods (Including Private)

private method %OnNew(pResponse As %CacheString) as %Status
Inherited description: This callback method is invoked by the %New() method to provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created.

It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:

Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.

Inherited Members

Inherited Methods (Including Private)

Storage

Storage Model: CacheStorage (EnsLib.PubSub.Target)

^EnsLib.PubSub.TargetD(ID)
=
%%CLASSNAME
%CorrespondingResponse
Channel
Name
Target
Transform
Address

Subclasses