Class Reference
%iKnow.Model.list
Server:appadmin-00044-deployment-6bf4cbc86d-9f4xc
Instance:IRIS
User:SuperUser
 
-
  [USER] >  [%iKnow] >  [Model] >  [list]
Private  Storage

deprecatedclass %iKnow.Model.list extends %iKnow.Model.nodeWithParameters

Model representation of a given "location" where data to be loaded can be found. The structure of these list objects adheres to what's required to configure and run %iKnow.Source.Lister objects.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
9 1


Summary

Properties
batchMode configuration converter data disabled
listerClass listname metadataValues parameters processor

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

Subclasses
%iKnow.Model.listFiles %iKnow.Model.listGlobal %iKnow.Model.listQuery %iKnow.Model.listRSS
%iKnow.Model.listTable

Properties

• property batchMode as %Boolean(XMLPROJECTION="attribute") [ InitialExpression = 1 ];
Whether or not to load the data in this list in batch mode.
• property configuration as %String(MAXLEN=150,XMLPROJECTION="attribute");
The name of the %iKnow.Configuration object to use when loading data from this list. This can be a configuration that's registered in the configurations property of the domain definition this list belongs to, or another configuration that exists on the system. If left empty, the default configuration is used.
• property converter as %iKnow.Model.converter(XMLPROJECTION="element");
The converter to be used when loading data from this list. If not set, no conversions are applied.
• relationship data as %iKnow.Model.data(XMLPROJECTION="none") [ Inverse = lists,Cardinality = one ];
The data wrapper this list belongs to
• property disabled as %Boolean(XMLPROJECTION="attribute") [ InitialExpression = 0 ];
If set to 1, this list is not included in the %Build() method.
• property listerClass as %String(MAXLEN=250,XMLPROJECTION="attribute");
The Lister class to use for loading data defined in this list element. This class should extend %iKnow.Source.Lister. The Lister class defined here dictates the contents of the parameters property.
• property listname as %String(MAXLEN=1000,XMLPROJECTION="attribute");
• relationship metadataValues as %iKnow.Model.metadataValue(XMLELEMENTREF=1,XMLPROJECTION="ELEMENT",XMLTYPECONSTRAINT="CHOICE") [ Inverse = list,Cardinality = many ];
Any fixed metadata values to register for each source in the following list definitons
• property processor as %iKnow.Model.processor(XMLPROJECTION="element");
The processor to be used when loading data from this list. If not set, the default for this lister class is used.

Methods

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


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