deprecatedclass %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.
• parameter XMLNAME = "field";
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.
• property caseSensitive
as %Boolean(XMLPROJECTION="attribute") [ InitialExpression = 0 ];
Whether or not this metadata fields content should be treated with case sensitivity.
• property dataType
as %String(MAXLEN=10,XMLPROJECTION="attribute") [ InitialExpression = $$$MDDTSTRING ];
The data type of this metadata field. Any of $$$MDDTSTRING, $$$MDDTNUMBER or $$$MDDTDATE
• property disabled
as %Boolean(XMLPROJECTION="attribute");
If set to 1, this element is ignored when compiling, validating and building the domain
• relationship metadata
as %iKnow.Model.metadata(XMLPROJECTION="none") [ Inverse = fields,Cardinality = one ];
The element this field belongs to.
• property name
as %String(MAXLEN=150,XMLPROJECTION="attribute");
The name of this metadata field, which should be unique within the domain.
• property operators
as %String(MAXLEN=250,XMLPROJECTION="attribute") [ InitialExpression = $$$MDOPEQUAL ];
Any operators this metadata field is to support at runtime for filtering purposes.
• 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)
Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.
