Skip to main content

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.Opens in a new tab

For information on migrating to InterSystems IRISOpens in a new tab, see Why Migrate to InterSystems IRIS?

%DeepSee.SetBuilder.Model.set

Property Inventory

Method Inventory

Properties

property defaultDomain as %String (XMLPROJECTION = "ATTRIBUTE");
Default iKnow domain to use for fetching iKnow elements.
Property methods: defaultDomainDisplayToLogical(), defaultDomainGet(), defaultDomainIsValid(), defaultDomainLogicalToDisplay(), defaultDomainLogicalToOdbc(), defaultDomainNormalize(), defaultDomainSet()
property defaultListing as %String (XMLPROJECTION = "ATTRIBUTE");
Property methods: defaultListingDisplayToLogical(), defaultListingGet(), defaultListingIsValid(), defaultListingLogicalToDisplay(), defaultListingLogicalToOdbc(), defaultListingNormalize(), defaultListingSet()
property idProperty as %String (XMLPROJECTION = "ATTRIBUTE");
The property name of the target class' identifier, whose values are being selected by this set definition. Defaults to '%ID' if not set explicitly.
Property methods: idPropertyDisplayToLogical(), idPropertyGet(), idPropertyIsValid(), idPropertyLogicalToDisplay(), idPropertyLogicalToOdbc(), idPropertyNormalize(), idPropertySet()
relationship listings as array of listing (XMLNAME = "listing", XMLPROJECTION = "ELEMENT") [ InitialExpression = $listbuild("%DeepSee.SetBuilder.Model.listing","set",+$this,"many",0,0) , Transient , Inverse = set , Cardinality = many ];
Property methods: listingsGet(), listingsGetObject(), listingsGetObjectId(), listingsGetSwizzled(), listingsIsEmpty(), listingsIsValid(), listingsNewObject(), listingsRClose(), listingsRExec(), listingsRFetch(), listingsRelate(), listingsSQLCompute(), listingsSet(), listingsUnRelate()
property name as %String (XMLPROJECTION = "ATTRIBUTE") [ Required ];
The logical name of this set, which must be unique for this namespace.
Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
relationship operators as array of operator (XMLELEMENTREF = 1, XMLPROJECTION = "WRAPPED", XMLTYPECONSTRAINT = "CHOICE") [ InitialExpression = $listbuild("%DeepSee.SetBuilder.Model.operator","set",+$this,"many",0,0) , Transient , Inverse = set , Cardinality = many ];
Property methods: operatorsGet(), operatorsGetObject(), operatorsGetObjectId(), operatorsGetSwizzled(), operatorsIsEmpty(), operatorsIsValid(), operatorsNewObject(), operatorsRClose(), operatorsRExec(), operatorsRFetch(), operatorsRelate(), operatorsSQLCompute(), operatorsSet(), operatorsUnRelate()
property output as %String (XMLPROJECTION = "ATTRIBUTE");
The logical name of the operator to be used as the output for this set. If not set, the operator named name is selected.
Property methods: outputDisplayToLogical(), outputGet(), outputIsValid(), outputLogicalToDisplay(), outputLogicalToOdbc(), outputNormalize(), outputSet()
relationship parameters as array of setParameter (XMLNAME = "parameter", XMLPROJECTION = "ELEMENT") [ InitialExpression = $listbuild("%DeepSee.SetBuilder.Model.setParameter","set",+$this,"many",0,0) , Transient , Inverse = set , Cardinality = many ];
Parameter names are case insensitive
Property methods: parametersGet(), parametersGetObject(), parametersGetObjectId(), parametersGetSwizzled(), parametersIsEmpty(), parametersIsValid(), parametersNewObject(), parametersRClose(), parametersRExec(), parametersRFetch(), parametersRelate(), parametersSQLCompute(), parametersSet(), parametersUnRelate()
property properties as list of property (XMLNAME = "property", XMLPROJECTION = "ELEMENT");
Any properties retrieved by the output operator that need to be exposed for listings and other set definitions.
Property methods: propertiesBuildValueArray(), propertiesCollectionToDisplay(), propertiesCollectionToOdbc(), propertiesDisplayToCollection(), propertiesGet(), propertiesGetObject(), propertiesGetObjectId(), propertiesGetSwizzled(), propertiesIsValid(), propertiesOdbcToCollection(), propertiesSet(), propertiesSetObject(), propertiesSetObjectId()
property resource as %String (XMLPROJECTION = "ATTRIBUTE");
Security resource to be held by the user invoking this set (USE privilege)
Property methods: resourceDisplayToLogical(), resourceGet(), resourceIsValid(), resourceLogicalToDisplay(), resourceLogicalToOdbc(), resourceNormalize(), resourceSet()
property target as %String (XMLPROJECTION = "ATTRIBUTE");
The class name of the records being returned by this set. If not set, this defaults to the target of the operator referred by output
Property methods: targetDisplayToLogical(), targetGet(), targetIsValid(), targetLogicalToDisplay(), targetLogicalToOdbc(), targetNormalize(), targetSet()

Methods

method %GetOperator(pName As %String) as operator
classmethod %LoadFromClass(pClassName As %String, Output pSetDefinition As %DeepSee.SetBuilder.Model.set) as %Status
method %SaveToClass(pClassName As %String, pOverwriteExisting As %Boolean = 1, pVerbose As %Boolean = 0, pCompile As %Boolean = 1) as %Status
method %Validate(pClassName As %String = "") as %Status

Inherited Members

Inherited Methods

FeedbackOpens in a new tab