Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [EnsLib] >  [PubSub] >  [Subscriber]
Private  Storage   

persistent class EnsLib.PubSub.Subscriber extends EnsLib.PubSub.Target, %CSP.Util.AutoForm

Represents a subscriber to a Publish / Subscribe list.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 2 3 2 1


Summary

Properties
%CorrespondingResponse Address DomainName Name
Subscriptions Target

Methods
%AddToSaveSet %AddToSyncSet %BMEBuilt %CheckConstraints
%CheckConstraintsForExtent %ClassIsLatestVersion %ClassName %ComposeOid
%ConstructClone %Delete %DeleteExtent %DeleteId
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Exists
%ExistsId %Extends %GUID %GUIDSet
%GetLock %GetParameter %GetSwizzleObject %Id
%InsertBatch %IsA %IsModified %IsNull
%KillExtent %KillExtentData %LoadFromMemory %LockExtent
%LockId %New %NormalizeObject %ObjectIsNull
%ObjectModified %Oid %OnBeforeAddToSync %OnDetermineClass
%Open %OpenId %OriginalNamespace %PackageName
%PhysicalAddress %PurgeIndices %Reload %RemoveFromSaveSet
%ResolveConcurrencyConflict %RollBack %Save %SaveDirect
%SaveIndices %SerializeObject %SetModified %SortBegin
%SortEnd %SyncObjectIn %SyncTransport %UnlockExtent
%UnlockId %ValidateIndices %ValidateObject CreateInstance
DispatchSubmit DoSubmit DrawFormButtons DrawHTMLForm
DrawHTMLTable FindSubscriber FindSubscriberId GetComboBoxHTML
GetFormError OnDefineButtons OnSubmit ProcessSubmit
SetFormError Submit XMLDTD XMLExport
XMLExportToStream XMLExportToString XMLNew XMLSchema
XMLSchemaNamespace XMLSchemaType


Parameters

• parameter DOMAIN = "Ensemble";
Use our own domain for localization

Properties

• property DomainName as DomainName(XMLNAME="Domain",XMLPROJECTION="ATTRIBUTE",XMLREFERENCE="ID");
Domain value used to keep this subscriber separate from others.
• relationship Subscriptions as Subscription(XMLPROJECTION="NONE") [ Inverse = Subscriber,Cardinality = many ];
Subscriptions for this subscriber

Methods

• classmethod FindSubscriber(pDomain As %String = "", pName As %String) as Subscriber
Look up a subscriber object given a domain and subscriber name.
• classmethod FindSubscriberId(pDomain As %String = "", pName As %String) as %String
Look up a subscriber object id given a domain and subscriber name.

Queries

• query Enumerate()
SQL Query :
SELECT %ID,DomainName,Name,Target,Address
FROM Subscriber
ORDER BY DomainName,Name
Provide a list of subscribers.
• query SubscriberList()
SQL Query :
SELECT %ID,
CASE
WHEN DomainName IS NULL THEN Name
ELSE DomainName || '/' || Name
END As Name
FROM Subscriber
ORDER BY (DomainName),(Name)
Provide a list of subscribers with domain names

Indices

•index (NameIdx on DomainName,Name) [Unique];


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.