EnsLib.PubSub.Subscriber
persistent class EnsLib.PubSub.Subscriber extends EnsLib.PubSub.Target, %CSP.Util.AutoForm
SQL Table Name: EnsLib_PubSub.Subscriber
Represents a subscriber to a Publish / Subscribe list.Property Inventory
Method Inventory
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.
Property methods: DomainNameGet(), DomainNameGetObject(), DomainNameGetObjectId(), DomainNameGetStored(), DomainNameGetSwizzled(), DomainNameIsValid(), DomainNameNewObject(), DomainNameSet(), DomainNameSetObject(), DomainNameSetObjectId(), DomainNameUnSwizzle()
relationship Subscriptions as array of Subscription (XMLPROJECTION = "NONE") [ InitialExpression = $listbuild("EnsLib.PubSub.Subscription","Subscriber",+$this,"many",1,1) , Transient , Inverse = Subscriber , Cardinality = many ];
Subscriptions for this subscriber
Property methods: SubscriptionsGet(), SubscriptionsGetObject(), SubscriptionsGetObjectId(), SubscriptionsGetSwizzled(), SubscriptionsIsEmpty(), SubscriptionsIsValid(), SubscriptionsNewObject(), SubscriptionsRClose(), SubscriptionsRExec(), SubscriptionsRFetch(), SubscriptionsRelate(), SubscriptionsSQLCompute(), SubscriptionsSet(), SubscriptionsUnRelate()
Methods
classmethod FindSubscriber(pDomain As %String = "", pName As %String) as Subscriber
Look up a subscriber object given a domain and subscriber name.
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
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)
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
Indexes
index (NameIdx on DomainName,Name) [Unique];
Index methods: NameIdxCheck(), NameIdxCheckUnique(), NameIdxDelete(), NameIdxExists(), NameIdxOpen(), NameIdxSQLCheckUnique(), NameIdxSQLExists(), NameIdxSQLFindPKeyByConstraint(), NameIdxSQLFindRowIDByConstraint()
Inherited Members
Inherited Properties
Inherited 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()
- GetComboBoxHTML()
- GetFormError()
- OnDefineButtons()
- OnSubmit()
- ProcessSubmit()
- SetFormError()
- Submit()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
Storage
Gray indicates storage defined by superclasses.
Storage Model: CacheStorage (EnsLib.PubSub.Target)
^EnsLib.PubSub.TargetD(ID) | = | %%CLASSNAME
%CorrespondingResponse
Channel
Name
Target
Transform
Address
|
^EnsLib.PubSub.TargetD(ID,"Subscriber") | = | DomainName
|