Skip to main content

EMS.Service.Base

SQL Table Name: EMS_Service.Base

Base class for handling EMS Services on the Managed Instance This class is used internally by Caché. You should not make direct use of it within your applications. There is no guarantee made about either the behavior or future operation of this class."

Property Inventory

Method Inventory

Parameters

parameter EXCLUDEPROP;
A comma-delimited list of Properties to exclude from the PropertyList method for this Service.

Properties

property Enabled as %Boolean [ InitialExpression = 1 ];
Flag to enable/disable updates for a Service. This is accessed by a public API (%SYS.EManager.UpdateEnabled) so applications can manage when updates are allowed (users off the system).
Property methods: EnabledDisplayToLogical(), EnabledGet(), EnabledGetStored(), EnabledIsValid(), EnabledLogicalToDisplay(), EnabledNormalize(), EnabledSet()
property GroupName as %String;
The group that manages this service for this instance
Property methods: GroupNameDisplayToLogical(), GroupNameGet(), GroupNameGetStored(), GroupNameIsValid(), GroupNameLogicalToDisplay(), GroupNameLogicalToOdbc(), GroupNameNormalize(), GroupNameSet()
property Version as %Integer;
Sequential Version counter of the active version on the EMS manager for this instance's service.
Property methods: VersionDisplayToLogical(), VersionGet(), VersionGetStored(), VersionIsValid(), VersionLogicalToDisplay(), VersionNormalize(), VersionSet()

Methods

method CheckRequiredState(State As %String) as EMS.Error
Check any requirements before updating this Service. A 'state' string may be passed in EMS.ServiceMessageData.RequiredState. Normally none, mostly used by Mirror to check for Primary ('State'="Primary").
abstract classmethod GetLocalizedName() as %String
Get the localized name of the service This method must be overridden for each service

Indexes

index (IDKEY on ) [IdKey, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods

Storage

Storage Model: CacheStorage (EMS.Service.Base)

^SYS("EMS","ServiceD")(ID)
=
%%CLASSNAME
GroupName
Version
Enabled

Subclasses

FeedbackOpens in a new tab