Skip to main content


class %iKnow.Model.dictionaryItem extends %iKnow.Model.node

Model representation of a Dictionary Item. See also %iKnow.Matching.DictionaryAPI

Property Inventory

Method Inventory


parameter XMLNAME = item;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.


relationship dictionary as %iKnow.Model.dictionary (XMLPROJECTION = "none") [ Inverse = items , Cardinality = one ];
The Dictionary this item belongs to.
Property methods: dictionaryGet(), dictionaryGetObject(), dictionaryGetObjectId(), dictionaryGetSwizzled(), dictionaryIsValid(), dictionaryNewObject(), dictionaryRClose(), dictionaryRExec(), dictionaryRFetch(), dictionaryRelate(), dictionarySQLCompute(), dictionarySet(), dictionaryUnRelate()
property disabled as %Boolean (XMLPROJECTION = "attribute");
If set to 1, this element is ignored when compiling, validating and building the domain
Property methods: disabledDisplayToLogical(), disabledGet(), disabledIsValid(), disabledLogicalToDisplay(), disabledLogicalToXSD(), disabledNormalize(), disabledSet(), disabledXSDToLogical()
relationship formats as array of %iKnow.Model.dictionaryFormat (XMLELEMENTREF = 1, XMLPROJECTION = "ELEMENT", XMLTYPECONSTRAINT = "CHOICE") [ InitialExpression = $listbuild("%iKnow.Model.dictionaryFormat","item",+$this,"many",0,0) , Transient , Inverse = item , Cardinality = many ];
The Dictionary Formats this item contains.
Property methods: formatsGet(), formatsGetObject(), formatsGetObjectId(), formatsGetSwizzled(), formatsIsEmpty(), formatsIsValid(), formatsNewObject(), formatsRClose(), formatsRExec(), formatsRFetch(), formatsRelate(), formatsSQLCompute(), formatsSet(), formatsUnRelate()
property language as %String (MAXLEN = 10, XMLPROJECTION = "ATTRIBUTE");
The default language to use for any terms in this item.
Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
property name as %String (MAXLEN = 150, XMLPROJECTION = "ATTRIBUTE");
The name of this Dictionary Item.
Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
relationship terms as array of %iKnow.Model.dictionaryTerm (XMLELEMENTREF = 1, XMLPROJECTION = "ELEMENT", XMLTYPECONSTRAINT = "CHOICE") [ InitialExpression = $listbuild("%iKnow.Model.dictionaryTerm","item",+$this,"many",0,0) , Transient , Inverse = item , Cardinality = many ];
The Dictionary Terms this item contains.
Property methods: termsGet(), termsGetObject(), termsGetObjectId(), termsGetSwizzled(), termsIsEmpty(), termsIsValid(), termsNewObject(), termsRClose(), termsRExec(), termsRFetch(), termsRelate(), termsSQLCompute(), termsSet(), termsUnRelate()
property uri as %String (MAXLEN = 150, XMLPROJECTION = "ATTRIBUTE");
A URI for this Dictionary Item. This URI should be unique within the Domain (across dictionaries)
Property methods: uriDisplayToLogical(), uriGet(), uriIsValid(), uriLogicalToDisplay(), uriLogicalToOdbc(), uriNormalize(), uriSet()


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

Inherited Members

Inherited Methods

FeedbackOpens in a new tab