EnsLib.ITK.Setup.UI.Consumer

class EnsLib.ITK.Setup.UI.Consumer extends Ens.Settings, %ZEN.DataModel.Adaptor

Property Inventory

BusHost
BusHostId
BusHostStatus
ConsumerName
DistributionRules
Services
VirtualSettings

Method Inventory

%OpenId()
BusHostIdGet()
BusHostStatusGet()
OpenWithHost()
PopulateVirtualSettings()

Parameters

parameter SETTINGS = ConsumerName:Info:text?readOnly=1,Services:Consumer:consumerEditor,DistributionRules:Consumer:consumerEditor;

Inherited description: List of properties can be set as settings in the configuration file format is a comma separated list of property names

Properties

property BusHost as Ens.Config.Item;

Property methods: BusHostGet(), BusHostGetObject(), BusHostGetObjectId(), BusHostGetSwizzled(), BusHostIsValid(), BusHostNewObject(), BusHostSet(), BusHostSetObject(), BusHostSetObjectId(), BusHostUnSwizzle()

property BusHostId as %String [ Calculated ];

Property methods: BusHostIdDisplayToLogical(), BusHostIdIsValid(), BusHostIdLogicalToDisplay(), BusHostIdLogicalToOdbc(), BusHostIdNormalize()

property BusHostStatus as %String [ Calculated ];

Property methods: BusHostStatusDisplayToLogical(), BusHostStatusIsValid(), BusHostStatusLogicalToDisplay(), BusHostStatusLogicalToOdbc(), BusHostStatusNormalize()

property ConsumerName as %String;

Property methods: ConsumerNameDisplayToLogical(), ConsumerNameGet(), ConsumerNameIsValid(), ConsumerNameLogicalToDisplay(), ConsumerNameLogicalToOdbc(), ConsumerNameNormalize(), ConsumerNameSet()

property DistributionRules as %String;

Number of Distrubution Rules with this Consumer as the target. Click magnifying glass to edit list.

Property methods: DistributionRulesDisplayToLogical(), DistributionRulesGet(), DistributionRulesIsValid(), DistributionRulesLogicalToDisplay(), DistributionRulesLogicalToOdbc(), DistributionRulesNormalize(), DistributionRulesSet()

property Services as %String;

Number of Services configured for consumption. Click magnifying glass to edit list.

Property methods: ServicesDisplayToLogical(), ServicesGet(), ServicesIsValid(), ServicesLogicalToDisplay(), ServicesLogicalToOdbc(), ServicesNormalize(), ServicesSet()

property VirtualSettings as list of %String;

Property methods: VirtualSettingsBuildValueArray(), VirtualSettingsCollectionToDisplay(), VirtualSettingsCollectionToOdbc(), VirtualSettingsDisplayToCollection(), VirtualSettingsDisplayToLogical(), VirtualSettingsGet(), VirtualSettingsGetObject(), VirtualSettingsGetObjectId(), VirtualSettingsGetSwizzled(), VirtualSettingsIsValid(), VirtualSettingsLogicalToDisplay(), VirtualSettingsLogicalToOdbc(), VirtualSettingsNormalize(), VirtualSettingsOdbcToCollection(), VirtualSettingsSet(), VirtualSettingsSetObject(), VirtualSettingsSetObjectId()

Methods

classmethod %OpenId(pId As %String) as Consumer

Return the object populated with name (matching a SystemDefinition) and a list of the ConsumerServiceRegistry objects if defined

method BusHostIdGet() as %String

method BusHostStatusGet() as %String

classmethod OpenWithHost(pId As %String, pProdId As %String) as Consumer

Special version of openId that takes a production id This is needed so we can check id there is a business operation associated with this consumer

method PopulateVirtualSettings() as %Status

Populate the VirtualSettings collection.

Queries

query GetAll()

SQL Query:
SELECT ApplicationName as ID FROM EnsLib_ITK_Setup.SystemDefinition

query GetConsumerServicesByConsumerName(pName As %String)

SQL Query:
SELECT %ID FROM EnsLib_ITK_Setup.ConsumerServiceRegistry WHERE ConsumerName = :pName