This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?


class %iKnow.Model.userDictionary extends %iKnow.Model.node

Model representation of a specific %iKnow.UserDictionary, which can be referred from %iKnow.Model.configuration entries.

Property Inventory

Method Inventory


property description as %String (MAXLEN = 2000, XMLPROJECTION = "ATTRIBUTE");
Optional description
Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
relationship domain as %iKnow.Model.domain (XMLPROJECTION = "none") [ Inverse = userDictionaries , Cardinality = one ];
Property methods: domainGet(), domainGetObject(), domainGetObjectId(), domainGetSwizzled(), domainIsValid(), domainNewObject(), domainRClose(), domainRExec(), domainRFetch(), domainRelate(), domainSQLCompute(), domainSet(), domainUnRelate()
relationship entries as array of %iKnow.Model.userDictionaryEntry (XMLELEMENTREF = 1, XMLNAME = "entry", XMLPROJECTION = "ELEMENT", XMLTYPECONSTRAINT = "CHOICE") [ InitialExpression = $listbuild("%iKnow.Model.userDictionaryEntry","userDictionary",+$this,"many",0,0) , Transient , Inverse = userDictionary , Cardinality = many ];
Property methods: entriesGet(), entriesGetObject(), entriesGetObjectId(), entriesGetSwizzled(), entriesIsEmpty(), entriesIsValid(), entriesNewObject(), entriesRClose(), entriesRExec(), entriesRFetch(), entriesRelate(), entriesSQLCompute(), entriesSet(), entriesUnRelate()
property name as %String (MAXLEN = 150, XMLPROJECTION = "ATTRIBUTE") [ Required ];
Name of this User Dictionary
Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()


method %Validate(pDomainId As %Integer, pDomainDefinition As %iKnow.Model.domain) as %Status

Inherited Members

Inherited Methods