This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > %SYS namespace > %iKnow.Model.list

%iKnow.Model.list

class %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.

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties (Including Private)

property batchMode as %Boolean (XMLPROJECTION = "attribute") [ InitialExpression = 1 ];
Whether or not to load the data in this list in batch mode.
Property methods: batchModeDisplayToLogical(), batchModeGet(), batchModeIsValid(), batchModeLogicalToDisplay(), batchModeLogicalToXSD(), batchModeNormalize(), batchModeSet(), batchModeXSDToLogical()
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 methods: configurationDisplayToLogical(), configurationGet(), configurationIsValid(), configurationLogicalToDisplay(), configurationLogicalToOdbc(), configurationNormalize(), configurationSet()
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.
Property methods: converterGet(), converterGetSwizzled(), converterIsValid(), converterNewObject(), converterSet()
relationship data as %iKnow.Model.data (XMLPROJECTION = "none") [ Inverse = lists , Cardinality = one ];
The data wrapper this list belongs to
Property methods: dataGet(), dataGetObject(), dataGetObjectId(), dataGetSwizzled(), dataIsValid(), dataNewObject(), dataRClose(), dataRExec(), dataRFetch(), dataRelate(), dataSQLCompute(), dataSet(), dataUnRelate()
property disabled as %Boolean (XMLPROJECTION = "attribute") [ InitialExpression = 0 ];
If set to 1, this list is not included in the %Build() method.
Property methods: disabledDisplayToLogical(), disabledGet(), disabledIsValid(), disabledLogicalToDisplay(), disabledLogicalToXSD(), disabledNormalize(), disabledSet(), disabledXSDToLogical()
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 methods: listerClassDisplayToLogical(), listerClassGet(), listerClassIsValid(), listerClassLogicalToDisplay(), listerClassLogicalToOdbc(), listerClassNormalize(), listerClassSet()
property listname as %String (MAXLEN = 1000, XMLPROJECTION = "attribute");
Property methods: listnameDisplayToLogical(), listnameGet(), listnameIsValid(), listnameLogicalToDisplay(), listnameLogicalToOdbc(), listnameNormalize(), listnameSet()
relationship metadataValues as array of %iKnow.Model.metadataValue (XMLELEMENTREF = 1, XMLPROJECTION = "ELEMENT", XMLTYPECONSTRAINT = "CHOICE") [ InitialExpression = $listbuild("%iKnow.Model.metadataValue","list",+$this,"many",0,0) , Transient , Inverse = list , Cardinality = many ];
Any fixed metadata values to register for each source in the following list definitons
Property methods: metadataValuesGet(), metadataValuesGetObject(), metadataValuesGetObjectId(), metadataValuesGetSwizzled(), metadataValuesIsEmpty(), metadataValuesIsValid(), metadataValuesNewObject(), metadataValuesRClose(), metadataValuesRExec(), metadataValuesRFetch(), metadataValuesRelate(), metadataValuesSQLCompute(), metadataValuesSet(), metadataValuesUnRelate()
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.
Property methods: processorGet(), processorGetSwizzled(), processorIsValid(), processorNewObject(), processorSet()

Methods (Including Private)

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

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

Subclasses

Feedback