InterSystems IRIS Data Platform 2020.4 > Class Reference > ENSLIB namespace > Ens.Config.SearchTableProp

Ens.Config.SearchTableProp

persistent class Ens.Config.SearchTableProp extends %Library.Persistent, Ens.Config.SearchTablePropAttrs

SQL Table Name: Ens_Config.SearchTableProp

Persistent SearchTable Property specifier object, stored for use in generating SearchTable code and queries

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter XMLIGNORENULL = 1;
parameter XMLNAME = Property;

Properties (Including Private)

property ClassDerivation as %String (MAXLEN = 1011, XMLPROJECTION = "NONE");
Full inheritance path for the class defining this property, down to Ens.VDoc.SearchTable This is used to identify which particular SearchTable subclass defined a particular property
Property methods: ClassDerivationDisplayToLogical(), ClassDerivationGet(), ClassDerivationGetStored(), ClassDerivationIsValid(), ClassDerivationLogicalToDisplay(), ClassDerivationLogicalToOdbc(), ClassDerivationNormalize(), ClassDerivationSet()
property ClassExtent as %String (MAXLEN = 128, XMLPROJECTION = "NONE") [ Required ];
Base class for the database extent of the class defining this property
Property methods: ClassExtentDisplayToLogical(), ClassExtentGet(), ClassExtentGetStored(), ClassExtentIsValid(), ClassExtentLogicalToDisplay(), ClassExtentLogicalToOdbc(), ClassExtentNormalize(), ClassExtentSet()
property IsImplicit as %Boolean (XMLPROJECTION = "NONE") [ InitialExpression = 0 ];
Was this property created by an explicit SearchTable property declaration or just by being referenced in a SearchTable item
Property methods: IsImplicitDisplayToLogical(), IsImplicitGet(), IsImplicitGetStored(), IsImplicitIsValid(), IsImplicitLogicalToDisplay(), IsImplicitNormalize(), IsImplicitSet()
property Name as %String (XMLPROJECTION = "ATTRIBUTE") [ Required ];
Property methods: NameDisplayToLogical(), NameGet(), NameGetStored(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()
property PropId as %Integer (XMLPROJECTION = "NONE");
Id of the property definition within its SearchTable class extent Storing the PropId instead of the property Name saves storage space in the SearchTable
Property methods: PropIdDisplayToLogical(), PropIdGet(), PropIdGetStored(), PropIdIsValid(), PropIdLogicalToDisplay(), PropIdNormalize(), PropIdSet()
property SourceClass as %String [ Calculated , Transient ];
Name of class from which this property is derived
Property methods: SourceClassDisplayToLogical(), SourceClassGet(), SourceClassIsValid(), SourceClassLogicalToDisplay(), SourceClassLogicalToOdbc(), SourceClassNormalize()

Methods (Including Private)

private method %OnAddToSaveSet(depth As %Integer = 3, insert As %Integer = 0, callcount As %Integer = 0) as %Status [ Language = objectscript ]
Inherited description: This callback method is invoked when the current object is added to the SaveSet, either because %Save() was invoked on this object or on an object that references this object. %OnAddToSaveSet can modify the current object. It can also add other objects to the current SaveSet by invoking %AddToSaveSet or remove objects by calling %RemoveFromSaveSet.

If this method returns an error status then %Save() will fail and the transaction will be rolled back.

method SourceClassGet() as %String [ Language = objectscript ]
classmethod UpdateOrCreate(pTemplate As Ens.Config.SearchTableProp, Output pProp As Ens.Config.SearchTableProp, pClassExtent As %String, pLockTimeout As %Numeric = 5) as %Status [ Language = objectscript ]

Indexes

index (indexClassProp on ClassExtent,Name) [IdKey, Type = key];
Index methods: indexClassPropCheck(), indexClassPropDelete(), indexClassPropExists(), indexClassPropOpen(), indexClassPropSQLCheckUnique(), indexClassPropSQLExists(), indexClassPropSQLFindPKeyByConstraint(), indexClassPropSQLFindRowIDByConstraint()
index (indexPropId on PropId);
Index methods: indexPropIdExists()

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

Storage

Storage Model: Storage (Ens.Config.SearchTableProp)

^Ens.Config.SearchTablePropD(ID)
=
%%CLASSNAME
ClassDerivation
IndexType
IsImplicit
PropId
PropType
StoreNulls
Unselective
Feedback