InterSystems IRIS Data Platform 2020.4 > Class Reference > ENSLIB namespace > %iKnow.Model.metadataField


class %iKnow.Model.metadataField extends %iKnow.Model.node

Model representation for metadata fields registered for a specific domain. See also %iKnow.Queries.MetadataI for more information about any specific properties.

Property Inventory (Including Private)

Method Inventory (Including Private)


parameter XMLNAME = field;
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.

Properties (Including Private)

property caseSensitive as %Boolean (XMLPROJECTION = "attribute") [ InitialExpression = 0 ];
Whether or not this metadata fields content should be treated with case sensitivity.
Property methods: caseSensitiveDisplayToLogical(), caseSensitiveGet(), caseSensitiveIsValid(), caseSensitiveLogicalToDisplay(), caseSensitiveLogicalToXSD(), caseSensitiveNormalize(), caseSensitiveSet(), caseSensitiveXSDToLogical()
property dataType as %String (MAXLEN = 10, XMLPROJECTION = "attribute") [ InitialExpression = $$$MDDTSTRING ];
The data type of this metadata field. Any of $$$MDDTSTRING, $$$MDDTNUMBER or $$$MDDTDATE
Property methods: dataTypeDisplayToLogical(), dataTypeGet(), dataTypeIsValid(), dataTypeLogicalToDisplay(), dataTypeLogicalToOdbc(), dataTypeNormalize(), dataTypeSet()
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 metadata as %iKnow.Model.metadata (XMLPROJECTION = "none") [ Inverse = fields , Cardinality = one ];
The element this field belongs to.
Property methods: metadataGet(), metadataGetObject(), metadataGetObjectId(), metadataGetSwizzled(), metadataIsValid(), metadataNewObject(), metadataRClose(), metadataRExec(), metadataRFetch(), metadataRelate(), metadataSQLCompute(), metadataSet(), metadataUnRelate()
property name as %String (MAXLEN = 150, XMLPROJECTION = "attribute");
The name of this metadata field, which should be unique within the domain.
Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
property operators as %String (MAXLEN = 250, XMLPROJECTION = "attribute") [ InitialExpression = $$$MDOPEQUAL ];
Any operators this metadata field is to support at runtime for filtering purposes.
Property methods: operatorsDisplayToLogical(), operatorsGet(), operatorsIsValid(), operatorsLogicalToDisplay(), operatorsLogicalToOdbc(), operatorsNormalize(), operatorsSet()
property storage as %Integer (XMLPROJECTION = "attribute") [ InitialExpression = 0 ];
Storage type for this metadata field: either $$$MDSTNORMAL for cases where you would use a normal index, $$$MDSTBITMAP where you would use a bitmap index (few different metadata values compared to total # of records)
Property methods: storageDisplayToLogical(), storageGet(), storageIsValid(), storageLogicalToDisplay(), storageNormalize(), storageSet(), storageXSDToLogical()

Methods (Including Private)

method %Validate(pDomainId As %Integer, pDomainDefinition As %iKnow.Model.domain) as %Status [ Language = objectscript ]

Inherited Members

Inherited Methods (Including Private)