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

class %iKnow.Model.domain extends nodeWithParameters

Model representation of an iKnow domain object. See also %iKnow.Domain

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
13 5


Summary

Properties
allowCustomUpdates blacklists configurations data
disabled expressions matching metadata
metrics name objectsPackage parameters
userDictionaries

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 %SaveToClass %SerializeObject %SetModified
%ToString %Validate %ValidateContent %ValidateObject
%ValidateStatic XMLDTD XMLExport XMLExportToStream
XMLExportToString XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType


Properties

• property allowCustomUpdates as %Boolean(XMLPROJECTION="attribute") [ InitialExpression = 0 ];
Whether or not to allow custom code to manually create domain objects, add sources, etc, outside of any updates applied by this Domain Definition itself. If set to false (default), only select operations remain available for custom code, such as setting individual metadata values and building metrics.
• relationship blacklists as list of %iKnow.Model.blacklist(XMLELEMENTREF=1,XMLNAME="blacklist",XMLPROJECTION="ELEMENT",XMLTYPECONSTRAINT="CHOICE") [ Inverse = domain,Cardinality = many ];
Blacklists for use in this domain
• relationship configurations as %iKnow.Model.configuration(XMLELEMENTREF=1,XMLPROJECTION="ELEMENT",XMLTYPECONSTRAINT="CHOICE") [ Inverse = domain,Cardinality = many ];
The configurations used by this domain
• property data as %iKnow.Model.data(XMLPROJECTION="element");
Wrapper object for all source data locations that should be loaded into this domain.
• property disabled as %Boolean(XMLPROJECTION="attribute");
If set to 0, no domain is generated for this definition, nor is the contents of this >domain< element validated.
• relationship expressions as %iKnow.Model.expression(XMLELEMENTREF=1,XMLNAME="expression",XMLPROJECTION="ELEMENT",XMLTYPECONSTRAINT="CHOICE") [ Inverse = domain,Cardinality = many ];
Expression elements for use in this domain definition
• property matching as %iKnow.Model.matching(XMLPROJECTION="element");
Wrapper object for all dictionary data that should be loaded into this domain.
• property metadata as %iKnow.Model.metadata(XMLPROJECTION="element");
Metadata info for this domain
• property metrics as %iKnow.Model.metrics(XMLPROJECTION="element");
Metrics for this domain
• property name as %String(MAXLEN=150,XMLPROJECTION="attribute");
The name of the domain, which should be unique within the namespace
• property objectsPackage as %String(MAXLEN=150,XMLPROJECTION="attribute");
If nonempty, objects will be generated representing the various elements in iKnow indexing results in the package named in this attribute. Existing objects will be replaced.
• relationship userDictionaries as list of %iKnow.Model.userDictionary(XMLELEMENTREF=1,XMLNAME="userDictionary",XMLPROJECTION="ELEMENT",XMLTYPECONSTRAINT="CHOICE") [ Inverse = domain,Cardinality = many ];
User Dictionaries for use in any configuration objects declared in this definition

Methods

• method %SaveToClass(pClassName As %String, pOverwriteExisting As %Boolean = 1, pVerbose As %Boolean = 0, pCompile As %Boolean = 1, pSuper As %String = "%iKnow.DomainDefinition") as %Status
Saves this Domain Definition to a class
• method %ToString(Output pString As %String, pFormatted As %Boolean = 1) as %Status
Outputs this Domain Definition as a %String
• method %Validate() as %Status
Validates the domain name and its primary parameters, essential to the creation of the domain. %ValidateContent will be called after the domain is instantiated to perform further validation on <domain> contents, being passed the domains ID
• method %ValidateContent(pDomainId As %Integer) as %Status
Valiates the child elements of this domain, including <list> and its descendants. This method gets passed in the domain ID of the domain being validated, which could be required for some (nested) checks.
• method %ValidateStatic(pDomainId As %Integer) as %Status
This method validates all static elements of the domain, such as metadata field definitions, metrics and any configuration and/or user dictionary objects embedded in this domain definition.


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