This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRISOpens in a new window, see the InterSystems IRIS Migration Guide and Migrating to InterSystems IRIS, both available on the WRC Distributions pageOpens in a new window (login required).

Config.CommonMapProperties

class Config.CommonMapProperties

This class contains properties which are included by classes which manipulate namespace mappings in the CPF file.

Property Inventory (Including Private)

Parameters

parameter DOMAIN = %Utility;
Default Localization Domain

Properties (Including Private)

property CPFFile as %String (MAXLEN = 255, MINLEN = 1) [ InitialExpression = $p($zu(86),"*") , Transient ];
CPF file which the object maps to.
Property methods: CPFFileDisplayToLogical(), CPFFileGet(), CPFFileIsValid(), CPFFileLogicalToDisplay(), CPFFileLogicalToOdbc(), CPFFileNormalize(), CPFFileSet()
property Comments as list of CommentList;
Embedded comments in the CPF file.
Property methods: CommentsBuildValueArray(), CommentsCollectionToDisplay(), CommentsCollectionToOdbc(), CommentsDisplayToCollection(), CommentsDisplayToLogical(), CommentsGet(), CommentsGetObject(), CommentsGetObjectId(), CommentsGetSwizzled(), CommentsIsValid(), CommentsLogicalToDisplay(), CommentsLogicalToOdbc(), CommentsNormalize(), CommentsOdbcToCollection(), CommentsSet(), CommentsSetObject(), CommentsSetObjectId()
property Flags as %Integer [ InitialExpression = 7 , Transient ];
Flags governing how the object is processed when %Save() is called.
For normal operations, all bits should be set.
Bit $$$CPFSave - Save object to disk.
Bit $$$CPFWrite - Write CPF file from object.
Bit $$$CPFActivate - Activate object into memory if CPFFile is the same as what is currently active.
Property methods: FlagsDisplayToLogical(), FlagsGet(), FlagsIsValid(), FlagsLogicalToDisplay(), FlagsNormalize(), FlagsSet()
property Name as %String (MAXLEN = 128, MINLEN = 1) [ Required ];
Name of the mapping.
Property methods: NameDisplayToLogical(), NameGet(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet(), NamespaceDisplayToLogical(), NamespaceGet(), NamespaceIsValid(), NamespaceLogicalToDisplay(), NamespaceLogicalToOdbc(), NamespaceNormalize(), NamespaceSet()
property Namespace as %String (MAXLEN = 64, MINLEN = 1) [ Required ];
Namespace where the mapping is.
Property methods: NamespaceDisplayToLogical(), NamespaceGet(), NamespaceIsValid(), NamespaceLogicalToDisplay(), NamespaceLogicalToOdbc(), NamespaceNormalize(), NamespaceSet()

Indexes

index (CPFNameSectionHeaderNspName on CPFName,SectionHeader,Namespace,Name) [IdKey, Type = key, Unique];

Subclasses

FeedbackOpens in a new window