Skip to main content

HS.HC.ClientAPI.InstanceConfig.NamespaceInfo

class HS.HC.ClientAPI.InstanceConfig.NamespaceInfo extends HS.REST.Model.ISerializable

Model to represent namespace-specific information.

Property Inventory

Parameters

parameter TYPE;
Type is set in the sub-classes, and used here as default for the Type property

Properties

property Activated as %Boolean [ InitialExpression = 0 ];
Whether this namespace has been activated.
Property methods: ActivatedDisplayToLogical(), ActivatedGet(), ActivatedIsValid(), ActivatedLogicalToDisplay(), ActivatedNormalize(), ActivatedSet()
property AdditionalConfigParams as array of HS.HC.ClientAPI.InstanceConfig.NamespaceInfo.AdditionalConfigParam;
Additional config parameters.
Property methods: AdditionalConfigParamsBuildValueArray(), AdditionalConfigParamsCollectionToDisplay(), AdditionalConfigParamsCollectionToOdbc(), AdditionalConfigParamsDisplayToCollection(), AdditionalConfigParamsGet(), AdditionalConfigParamsGetObject(), AdditionalConfigParamsGetObjectId(), AdditionalConfigParamsGetSwizzled(), AdditionalConfigParamsIsValid(), AdditionalConfigParamsOdbcToCollection(), AdditionalConfigParamsSet(), AdditionalConfigParamsSetObject(), AdditionalConfigParamsSetObjectId()
property AdditionalInfo as list of HS.HC.ClientAPI.InstanceConfig.NamespaceInfo.AdditionalInfo [ Transient ];
Additional namespace-specific info. Never to be stored since would want fresh information each time so mark as transient.
Property methods: AdditionalInfoBuildValueArray(), AdditionalInfoCollectionToDisplay(), AdditionalInfoCollectionToOdbc(), AdditionalInfoDisplayToCollection(), AdditionalInfoGet(), AdditionalInfoGetObject(), AdditionalInfoGetObjectId(), AdditionalInfoGetSwizzled(), AdditionalInfoIsValid(), AdditionalInfoOdbcToCollection(), AdditionalInfoSet(), AdditionalInfoSetObject(), AdditionalInfoSetObjectId()
property AuditProduction as %Boolean;
One production in the federation, either the registry (default) or an edge, is designated as the controller for the audit database. The audit consolidation service runs there for alerts, and external ATNA inbound and outbound services and operations run there. TODO: Should move this to a specific audit type only for edge and hub to inherit from since those are the only supported audit namespace types.
Property methods: AuditProductionDisplayToLogical(), AuditProductionGet(), AuditProductionIsValid(), AuditProductionLogicalToDisplay(), AuditProductionNormalize(), AuditProductionSet()
property CreatedAt as %TimeStamp [ InitialExpression = ##class(%UTC).NowLocal() ];
Time this config item was created
Property methods: CreatedAtDisplayToLogical(), CreatedAtGet(), CreatedAtIsValid(), CreatedAtLogicalToDisplay(), CreatedAtLogicalToXSD(), CreatedAtNormalize(), CreatedAtOdbcToLogical(), CreatedAtSet(), CreatedAtXSDToLogical()
property DatabaseLocation as %String);
When not set, the database will be placed in the manager directory.
Property methods: DatabaseLocationDisplayToLogical(), DatabaseLocationGet(), DatabaseLocationIsValid(), DatabaseLocationLogicalToDisplay(), DatabaseLocationLogicalToOdbc(), DatabaseLocationNormalize(), DatabaseLocationSet()
property Description as %String);
Description of this item.
Property methods: DescriptionDisplayToLogical(), DescriptionGet(), DescriptionIsValid(), DescriptionLogicalToDisplay(), DescriptionLogicalToOdbc(), DescriptionNormalize(), DescriptionSet()
property Disabled as %Boolean [ InitialExpression = 0 ];
Whether this namespace is disabled.
Property methods: DisabledDisplayToLogical(), DisabledGet(), DisabledIsValid(), DisabledLogicalToDisplay(), DisabledNormalize(), DisabledSet()
property LastActivated as %TimeStamp;
Time at which namespace was last activated.
Property methods: LastActivatedDisplayToLogical(), LastActivatedGet(), LastActivatedIsValid(), LastActivatedLogicalToDisplay(), LastActivatedLogicalToXSD(), LastActivatedNormalize(), LastActivatedOdbcToLogical(), LastActivatedSet(), LastActivatedXSDToLogical()
property Name as HS.HC.DataType.NamespaceName;
Name of namespace.
Property methods: NameDisplayToLogical(), NameGet(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()
property Production as %Dictionary.Classname (%JSONFIELDNAME = "productionName");
Production name. JSON output provided by ProductionInfo so use custom JSON name.
Property methods: ProductionGet(), ProductionIsValid(), ProductionSet()
property ProductionInfo as HS.HC.ClientAPI.InstanceConfig.NamespaceInfo.ProductionInfo (%JSONFIELDNAME = "production") [ Transient ];
Info about production for this namespace. Never to be stored since would want fresh information each time so mark as transient. Has JSON field name of "production" for backwards compatability.
Property methods: ProductionInfoGet(), ProductionInfoGetSwizzled(), ProductionInfoIsValid(), ProductionInfoNewObject(), ProductionInfoSet()
property Template as %Dictionary.Classname;
Production template.
Property methods: TemplateGet(), TemplateIsValid(), TemplateSet()
property Type as HS.HC.DataType.NamespaceType [ InitialExpression = ..#TYPE ];
Namespace type.
Property methods: TypeDisplayToLogical(), TypeGet(), TypeIsValid(), TypeLogicalToDisplay(), TypeLogicalToOdbc(), TypeNormalize(), TypeSet()

Inherited Members

Inherited Methods

Subclasses

FeedbackOpens in a new tab