Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [%SYS] >  [%iKnow] >  [Model] >  [metadataField]
Private  Storage   

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.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 7 1


Summary

Properties
caseSensitive dataType disabled metadata name
operators storage

Methods
%AddToSaveSet %BindExport %ClassIsLatestVersion %ClassName
%ConstructClone %DispatchClassMethod %DispatchGetModified %DispatchGetProperty
%DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty
%Extends %GetParameter %IsA %IsModified
%New %NormalizeObject %ObjectModified %OriginalNamespace
%PackageName %QuoteList %QuoteValue %QuoteValueL10N
%RemoveFromSaveSet %SerializeObject %SetModified %Validate
%ValidateObject XMLDTD XMLExport XMLExportToStream
XMLExportToString XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType


Parameters

• 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.

Properties

• 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)

Methods

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


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.