Skip to main content


class Config.CommonProperties

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

Property Inventory


parameter DOMAIN = %Utility;
Default Localization Domain


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()
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.
Bit $$$CPFAvoidBackupDB - Don't Add/Remove the Database to Backup DB list.
Property methods: FlagsDisplayToLogical(), FlagsGet(), FlagsIsValid(), FlagsLogicalToDisplay(), FlagsNormalize(), FlagsSet()
property Name as %String (MAXLEN = 64, MINLEN = 1) [ Required ];
Name of the object instance.
Property methods: NameDisplayToLogical(), NameGet(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()


FeedbackOpens in a new tab