Class Reference
Cache for UNIX 2018.1.3
InterSystems: The power behind what matters   
Documentation  Search
Private  Storage  

abstract class %Library.RegisteredObject extends %Library.Base

The %RegisteredObject class provides the core capabilities needed to manage the in-memory version of an object. Specifically, %RegisteredObject provides the ability to create and destroy object references (OREFs) as well as support for polymorphism. The %RegisteredObject class also provides the ability to swizzle other referenced objects (persistent or serial) into memory.

Classes derived directly from %RegisteredObject can be used as transient objects; objects that exist in memory-and can be used from client applications-but are not stored in the database.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 19


Summary

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%RemoveFromSaveSet %SerializeObject %SetModified %ValidateObject

Subclasses
%Activate.HandleEvents %Activate.Interface %Activate.RegisterEvents
%Activate.TLEnumerator %Activate.Unsupported %Activate.Variant
%Archive.Content %Archive.Session %Atelier.v1.Utils.DocumentStreamAdapter
%Atelier.v1.Utils.Extension %Atelier.v1.Utils.General %Atelier.v1.Utils.Indexer
%Atelier.v1.Utils.LazyCollection %Atelier.v1.Utils.LazyDocument %Atelier.v1.Utils.LazyIndex
%Atelier.v1.Utils.LazyModifiedDb %Atelier.v1.Utils.MetaData %Atelier.v2.Utils.General
%Atelier.v2.Utils.TextServices %BI.SiteConfig %BI.Utils
%CPT.COS.Analysis.API %CPT.COS.Analysis.BasicBlock.BasicBlock %CPT.COS.Analysis.BasicBlock.Builder
%CPT.COS.Analysis.BasicBlock.BuilderFrame %CPT.COS.Analysis.BasicBlock.CommandArray %CPT.COS.Analysis.BasicBlock.TreeReader.Abstract
%CPT.COS.Analysis.BlockDictionary %CPT.COS.Analysis.Condition.Abstract %CPT.COS.Analysis.Edge.Abstract
%CPT.COS.Analysis.Graph %CPT.COS.Analysis.SSA.Scanner %CPT.COS.Analysis.SSA.Symbol
%CPT.COS.Analysis.SSA.SymbolDef %CPT.COS.Analysis.SSA.SymbolTable %CPT.COS.Analysis.SSA.SymbolUse
%CPT.COS.Language.Abstract %CPT.COSCallout %CPT.CalloutCheckCptix
%CPT.CalloutCheckTree %CPT.CalloutDict %CPT.CalloutShell
%CPT.Coverage %CPT.GenerateCOS.Abstract %CPT.GlobalsToRoutine
%CPT.HPT.Loader %CPT.HPT.LoadingState %CPT.HPT.ParseNode
%CPT.HPT.ParseNodeClass %CPT.HPT.Reader %CPT.HPT.Stack
%CPT.HPT.StackFrame %CPT.ISQLCallout %CPT.JS.Analyse.Change.Assignment
%CPT.JS.Analyse.Function %CPT.JS.Analyse.ImplGraph %CPT.JS.Analyse.Indet
%CPT.JS.Analyse.IndetProperty %CPT.JS.Analyse.Manager %CPT.JS.Analyse.PlainValue
%CPT.JS.Analyse.SafeBuiltin %CPT.JS.Analyse.Scope %CPT.JS.Analyse.ScopeGroup
%CPT.JS.Analyse.Statement %CPT.JS.Analyse.Value %CPT.JS.Analyse.Variable
%CPT.JS.Analyse.World %CPT.JS.Code.CodeStream %CPT.JS.Code.Environment
%CPT.JS.Code.Symbol.Abstract %CPT.JS.Common.Globals %CPT.JS.Generate.CodeSection
%CPT.JS.Generate.CodeWriter %CPT.JS.Generate.Context %CPT.JS.Generate.Gen.Abstract
%CPT.JS.Generate.GenCF.Analyse %CPT.JS.Generate.GenCF.Dispatcher %CPT.JS.Generate.GenCF.Main
%CPT.JS.Generate.GenCF.ScopeInfo %CPT.JS.Generate.LoadHints %CPT.JS.Generate.Optimize.Scan
%CPT.JS.Generate.Scope %CPT.JS.Generate.Symbol %CPT.JS.Generate.SymbolReference
%CPT.JS.Generate.TempVar %CPT.JS.Generate.TraceScanTree %CPT.JS.Node.Abstract
%CPT.JS.NodeJS %CPT.JS.Pig.COSFormatter %CPT.JS.Pig.Core
%CPT.JS.Pig.NewCore %CPT.JS.Pig.NewNewCore %CPT.JS.Runtime.Bridge
%CPT.JS.Runtime.Builtin.CacheObject %CPT.JS.Runtime.Builtin.ClassObject %CPT.JS.Runtime.Builtin.Console
%CPT.JS.Runtime.Builtin.Null %CPT.JS.Runtime.Builtin.Undefined %CPT.JS.Runtime.Debug.LocalFrame
%CPT.JS.Runtime.Dictionary %CPT.JS.Runtime.Function %CPT.JS.Runtime.ObjectBase
%CPT.JS.Runtime.Regex %CPT.JS.Runtime.Shell %CPT.JSCallout
%CPT.LineBufferedStream %CPT.MakeDefsInclude %CPT.Measure
%CPT.OSQLCallout %CPT.Piecer %CPT.Refactor.ExtractMethod
%CPT.Refactor.LockClass %CPT.Refactor.TrackVar %CPT.Regen.RegenerateGloss
%CPT.Regen.RegenerateOutput %CPT.Regen.RegenerateSource %CPT.Regen.Stack
%CPT.Regen.State %CPT.SQLCallout %CPT.Shell.AbstractCommand
%CPT.Shell.AbstractShell %CPT.TimeScope %CPT.Tree.CompareLines
%CPT.Tree.Editor %CPT.Tree.EnumNodes %CPT.Tree.Extents
%CPT.Tree.Fragment %CPT.Tree.Pair %CPT.Tree.Path
%CPT.Tree.SimpleDigraph %CPT.Util.StreamTracker %CPT.Util.StudioDocWriter
%CPT.Warp.Element %CPT.Warp.Fragment %CPT.Warp.Instrument
%CPT.Warp.Main %CPT.Warp.Parser %CPT.Warp.Path
%CPT.Warp.PathMatch %CPT.Warp.PathMatchElement %CPT.Warp.PathMatches
%CSP.AbstractAtom %CSP.Apps %CSP.CompilerContext
%CSP.DwxQuery %CSP.Endpoint %CSP.HTMLEscape
%CSP.Mgr.GatewayInformation %CSP.Mgr.GatewayMgrImpl %CSP.Mgr.GatewayRegistryImpl
%CSP.Mgr.GatewaySystemStatus %CSP.Monitor.Matrix %CSP.PageBuilder
%CSP.PageSection %CSP.Portal.SourceControl.IO %CSP.Portal.Utils
%CSP.Request %CSP.Response %CSP.RuleMgr
%CSP.SessionEvents %CSP.TokenStream %CSP.UI.Portal.SQL.Utils
%CSP.UI.SQL.QueryForm %CSP.UI.SQL.TableForm %CSP.UI.System.AuditUtils
%CSP.UI.System.BackgroundTask %CSP.UI.System.Index %CSP.UserAgent
%CSP.Util.AutoFormDynamic %CSP.Util.AutoFormGenerator %CSP.Util.FieldDefinition
%CSP.Util.HTMLMeter %CSP.Util.PageInstance %CSP.Util.Pane
%CSP.Util.TableForm %CSP.WebSocket %Collection.Super
%Compiler.JS.COS %Compiler.LG.CPP %Compiler.LG.ChildTableResultSet
%Compiler.LG.ClassAttributes %Compiler.LG.ClassTestShorthand %Compiler.LG.CodeStreamColn
%Compiler.LG.DeployDescriptor %Compiler.LG.EJBDeployJBossJaws %Compiler.LG.EJBDeployScript
%Compiler.LG.EJBFlags %Compiler.LG.EJBGenerator %Compiler.LG.EJBImports
%Compiler.LG.EJBPair %Compiler.LG.EJBProperty %Compiler.LG.EJBSerial
%Compiler.LG.EJBTestHtml %Compiler.LG.JavaBlock %Compiler.LG.JavaBlockNameSet
%Compiler.LG.JavaRoot %Compiler.LG.LanguageGeneratorTemplate %Compiler.LG.MethWrapper
%Compiler.LG.Output %Compiler.LG.PropWrapper %Compiler.LG.QueryHelper
%Compiler.LG.Util %Compiler.LG.WrapperClassDef %Compiler.LG.WrapperElem
%Compiler.LG.WrapperMethodDef %Compiler.LG.WrapperMtdArgDef %Compiler.LG.WrapperQueryDef
%Compiler.PEPP.Callin %Compiler.UDL.TextServices %Compiler.Util.Flo
%Compiler.Util.ParseTree %Compiler.Util.Visitor %Debugger.Stack
%Debugger.System %DeepSee.ClassQueries %DeepSee.ComputedDimension.Base
%DeepSee.Connector.Generator %DeepSee.Connector.abstractNode %DeepSee.CubeDefinition
%DeepSee.CubeManager.RegistryDefinitionSuper %DeepSee.CubeManager.RegistryMap %DeepSee.CubeManager.RegistryMapCube
%DeepSee.CubeManager.RegistryMapGroup %DeepSee.CubeManager.RegistryMapSubjectArea %DeepSee.CubeManager.Utils
%DeepSee.CubeVersion.Utils %DeepSee.Dashboard.Element %DeepSee.Dashboard.Utils
%DeepSee.DataConnector %DeepSee.Generator %DeepSee.ListingGroup
%DeepSee.ListingGroupDefinition %DeepSee.Model.SubjectArea.abstractNode %DeepSee.Model.abstractNode
%DeepSee.PMML.Dataset %DeepSee.PMML.Definition.abstractNode %DeepSee.PMML.Model.AbstractModel
%DeepSee.PMML.ModelOutput %DeepSee.PMML.UI.ModelBuilderData %DeepSee.PMML.Utils.Result
%DeepSee.PMML.Utils.TreeBuilder %DeepSee.QualityMeasure.QualityMeasure %DeepSee.QualityMeasure.Utils
%DeepSee.Query.Engine %DeepSee.Query.Engine2 %DeepSee.Query.Parser
%DeepSee.Query.member %DeepSee.Query.node %DeepSee.Query.scalarFunction
%DeepSee.QueryTest %DeepSee.Report.Config.configData %DeepSee.Report.Model.Document
%DeepSee.Report.Model.Node %DeepSee.Report.Utils %DeepSee.SQL.Parser
%DeepSee.Session %DeepSee.SetBuilder.Builder %DeepSee.SetBuilder.CustomOperator
%DeepSee.SetBuilder.Definition %DeepSee.Sets.Set %DeepSee.Sets.SetOperations
%DeepSee.Shell %DeepSee.SubjectArea %DeepSee.TaskMaster
%DeepSee.TermList %DeepSee.TestSpec %DeepSee.Time.AbstractLevel
%DeepSee.UserLibrary.Container %DeepSee.UserLibrary.TermList %DeepSee.UserLibrary.Utils
%DeepSee.UserPortal.Utils %DeepSee.UserPortal.WorkList %DeepSee.Utils
%DeepSee.WorksheetEngine %DeepSee.XMLA.DataSourcesRestrictions %DeepSee.XMLA.EnumerationsRestrictions
%DeepSee.XMLA.ExecuteCommand %DeepSee.XMLA.KeywordsRestrictions %DeepSee.XMLA.LiteralsRestrictions
%DeepSee.XMLA.Properties %DeepSee.XMLA.PropertiesRestrictions %DeepSee.XMLA.PropertyList
%DeepSee.XMLA.SchemasRestrictions %DeepSee.extensions.StudentDistribution %DeepSee.extensions.clusters.ASW
%DeepSee.extensions.clusters.AbstractModel %DeepSee.extensions.clusters.CalinskiHarabasz %DeepSee.extensions.clusters.Ordered
%DeepSee.extensions.clusters.PearsonGamma %DeepSee.extensions.clusters.opt.D1D %DeepSee.extensions.iKnow.ClassifierAnalysis
%DeepSee.extensions.iKnow.ClassifierBuilder %DeepSee.extensions.iKnow.ClassifierOptimizer %DeepSee.extensions.iKnow.ClassifierReport
%DeepSee.extensions.iKnow.DistanceTools %DeepSee.extensions.modelling.Call %DeepSee.extensions.modelling.ContributionReport
%DeepSee.extensions.modelling.LDA %DeepSee.extensions.modelling.NaiveBayes %DeepSee.extensions.modelling.NaiveBayes2
%DeepSee.extensions.modelling.PCA %DeepSee.extensions.modelling.PMML %DeepSee.extensions.modelling.Processor
%DeepSee.extensions.modelling.conf.Model %DeepSee.extensions.modelling.iKnow.LoadMetric %DeepSee.extensions.stat.ExpDistribution
%DeepSee.extensions.stat.MixedDistribution %DeepSee.extensions.stat.NormalDistribution %DeepSee.extensions.stat.Simple1DD
%DeepSee.extensions.stat.SubDistribution %DeepSee.extensions.utils.Jacobi %DeepSee.extensions.utils.MatrixArithmetics
%DeepSee.extensions.utils.OLS %DeepSee.extensions.utils.OptimizationModel %DeepSee.extensions.utils.Optimizer
%DeepSee.extensions.utils.SimpleRegression %DeepSee.extensions.utils.StringMatchUtils %Dictionary.RoseLinkUtility
%Document.CollectionDefinition %Document.Model.Schema.abstractNode %DotNet.Utils
%HadoopGateway.Base %IO.I.Stream %IO.IParts.ByteIO
%ISQL.CompileInfo %ISQL.Matcher %ISQL.SPContext
%ISQL.SimpleStreamLexer %ISQL.Transformer %Installer.AbstractLogger
%Installer.Component %Installer.Installer %Library.COSCallout
%Library.CPPStoredProc %Library.Compiler.Basic %Library.Destroyer
%Library.DynamicCollection %Library.Function %Library.GTWConnection
%Library.IResultSet %Library.JavaDoc %Library.MessageDictionary
%Library.RoutineMgr %Library.SQLAPI %Library.SQLCatalog
%Library.SQLExportMgr %Library.SQLGatewayConnection %Library.SQLImportMgr
%Library.SwizzleObject %Library.SyntaxColor %Library.SyntaxColorReader
%Library.Transaction %MV.EnumClass %MV.File
%MV.SelectList %MV.Verbs %Monitor.Adaptor
%Monitor.Manager %Monitor.SampleAgent %Monitor.System.LineByLine
%Monitor.View %Net.Authenticator %Net.Bonjour
%Net.BonjourLibrary %Net.BonjourServiceReference %Net.BonjourTXTRecord
%Net.FetchMailProtocol %Net.FtpCallback %Net.FtpSession
%Net.HttpRequest %Net.HttpResponse %Net.LDAP.Client.EditEntry
%Net.LDAP.Client.Entries %Net.LDAP.Client.Entry %Net.LDAP.Client.PropList
%Net.LDAP.Client.Session %Net.LDAP.Client.StringList %Net.LDAP.Client.ValueList
%Net.MIMEPart %Net.MIMEReader %Net.MIMEWriter
%Net.OpenAM.tns.AccessDenied %Net.OpenAM.tns.DuplicateObject %Net.OpenAM.tns.GeneralFailure
%Net.OpenAM.tns.InvalidCredentials %Net.OpenAM.tns.InvalidPassword %Net.OpenAM.tns.InvalidToken
%Net.OpenAM.tns.NeedMoreCredentials %Net.OpenAM.tns.ObjectNotFound %Net.OpenAM.tns.TokenExpired
%Net.OpenAM.tns.UserNotFound %Net.OpenAM.tns.attribute %Net.OpenAM.tns.identityDetails
%Net.OpenAM.tns.token %Net.OpenAM.tns.userDetails %Net.Provision.Configure
%Net.Provision.EMManage %Net.PushNotifications.APNS %Net.PushNotifications.GCM
%Net.Remote.DotNet.Test %Net.Remote.Gateway %Net.Remote.ImportHelper
%Net.Remote.Java.JDBCGateway %Net.Remote.Java.JavaGatewayService %Net.Remote.Java.Test
%Net.Remote.Java.XSLTGatewayRequest %Net.Remote.Proxy %Net.Remote.Service
%Net.Remote.Utility %Net.RemoteConnection %Net.SASL.Base
%Net.SMTP %Net.SSH.SFTP %Net.SSH.Session
%Net.UDP %Net.URLParser %Net.abstractMQ
%OAuth2.JWK %OAuth2.JWKS %OAuth2.JWT
%OAuth2.Server.Generate %OAuth2.Server.JWT %OAuth2.Server.Validate
%OAuth2.Utils %Regex.Matcher %ResultSet.MetaData
%SAML.Action %SAML.AssertionReference %SAML.Attribute
%SAML.AttributeValue %SAML.AttributeValueAbstract %SAML.AttributeValueElement
%SAML.AuthnContext %SAML.AuthnContextDecl %SAML.AuthnContextDeclRef
%SAML.BaseID %SAML.Condition %SAML.Conditions
%SAML.EncryptedElement %SAML.Evidence %SAML.Statement
%SAML.Subject %SAML.SubjectConfirmation %SAML.SubjectConfirmationData
%SAML.SubjectLocality %SOAP.Addressing.MetaData %SOAP.Addressing.Policy
%SOAP.Addressing.Properties %SOAP.BufferedStream %SOAP.Configuration
%SOAP.ConfigurationDefinition %SOAP.Descriptor %SOAP.Fault
%SOAP.Fault12 %SOAP.Fault12.Code %SOAP.Fault12.Text
%SOAP.Header %SOAP.MTOMPolicy %SOAP.Policy
%SOAP.PolicyReference %SOAP.RM.Accept %SOAP.RM.AcknowledgementRange
%SOAP.RM.CloseSequenceResponse %SOAP.RM.CreateSequenceResponse %SOAP.RM.Offer
%SOAP.RM.Policy %SOAP.RM.TerminateSequenceResponse %SOAP.RequestMessage
%SOAP.Security.Element %SOAP.Security.IssuerSerial %SOAP.Security.KeyIdentifier
%SOAP.Security.Policy %SOAP.Security.Reference %SOAP.Security.TransformationParameters
%SOAP.WSDL.Reader %SOAP.WSSC.Properties %SOAP.WST.AbstractToken
%SOAP.WST.Claims %SOAP.WST.Entropy %SOAP.WST.Lifetime
%SOAP.WST.Participants %SOAP.WST.Renewing %SOAP.WST.RequestSecurityTokenResponse
%SOAP.WST.RequestSecurityTokenResponseCollection %SOAP.WST.RequestedProofToken %SOAP.WST.RequestedSecurityToken
%SOAP.WST.Status %SOAP.WST.Target %SOAP.WebBase
%SOAP.WebParameters %SQL.AbstractFind %SQL.Engine.Objects.AggMap
%SQL.Engine.Objects.AggMapSubscript %SQL.Engine.Objects.Alg %SQL.Engine.Objects.AlgBsl
%SQL.Engine.Objects.AlgJoin %SQL.Engine.Objects.Asl %SQL.Engine.Objects.AslAction
%SQL.Engine.Objects.AslActionBuildNode %SQL.Engine.Objects.AslKey %SQL.Engine.Objects.AslKeyId
%SQL.Engine.Objects.AslKeyNext %SQL.Engine.Objects.AslMod %SQL.Engine.Objects.AslPk
%SQL.Engine.Objects.AslPkBitChunk %SQL.Engine.Objects.AslPkFilter %SQL.Engine.Objects.AslPkInit
%SQL.Engine.Objects.AslPkTemp %SQL.Engine.Objects.Mt %SQL.Engine.Objects.MtMask
%SQL.Engine.Objects.MtOutput %SQL.Engine.Objects.MtProperties %SQL.Engine.Objects.MtQuery
%SQL.Engine.Objects.MtRelations %SQL.Engine.Objects.MtStream %SQL.Engine.Objects.MtTempFile
%SQL.Engine.Objects.MtVal %SQL.Engine.Objects.Mts %SQL.Engine.Objects.MtsAtt
%SQL.Engine.Objects.MtsMap %SQL.Engine.Objects.MtsMapSubscript %SQL.Engine.Objects.MtsQuery
%SQL.Engine.Objects.MtsStream %SQL.Export.Mgr %SQL.Import.Mgr
%SQL.Manager.API %SQL.Manager.Catalog %SQL.Manager.Wizard.Util
%SQL.Migration.Import %SQL.Migration.Util %SQL.Shell
%SQL.Statement %SQL.StatementMetadata %SQL.StatementResult
%SQL.Util.Import %SQL.Util.RowType %SQL.Util.TuneTableStats
%SQL.Util.TuneTableStatsFields %SQL.Util.TuneTableStatsMaps %SYNC.ObjectLog
%SYNC.SyncSet %SYNC.SyncSetObject %SYNC.Transporter
%SYNC.Utils %SYS.ClusterInfo %SYS.Date.SlidingWindow
%SYS.EMS %SYS.Journal.History %SYS.Journal.System
%SYS.Monitor %SYS.Monitor.AbstractNotification %SYS.Monitor.AbstractNotificationFilter
%SYS.Monitor.AbstractSensor %SYS.Monitor.AbstractSubscriber %SYS.Monitor.Control
%SYS.Monitor.Email %SYS.NLS.Device %SYS.NLS.Format
%SYS.NLS.Locale %SYS.NLS.Table %SYS.OAuth2.AccessToken
%SYS.OAuth2.Authorization %SYS.OAuth2.Registration %SYS.OAuth2.Validation
%SYS.RMSession %SYS.SecurityContextToken %SYS.Studio.DocumentHistory
%SYS.Task.Definition %SYS.Task.Init %SYSTEM.CPU
%SYSTEM.Context.DeviceRedirect %SYSTEM.Context.iFind %SYSTEM.Error
%SYSTEM.JSObj %SYSTEM.Java %Service.BonjourAdvertiser
%Service.GenericAdvertisement %Standards.AU.eHealth.HI.Headers %Standards.AU.eHealth.HI.QualifiedId
%Standards.AU.eHealth.PCEHR.PCEHRHeaders %Standards.AU.eHealth.PCEHR.User %Standards.AU.eHealth.PCEHR.accessingOrganisation
%Standards.AU.eHealth.PCEHR.productType %Standards.AU.eHealth.SMD.BaseDataType %Standards.AU.eHealth.SMD.EncryptedPayloadDataType
%Standards.AU.eHealth.SMD.EncryptedPayloadType %Standards.AU.eHealth.SMD.KeyListType %Standards.AU.eHealth.SMD.SignatureListType
%Standards.AU.eHealth.SMD.SignedPayloadDataType %Standards.AU.eHealth.SMD.SignedPayloadType %Stream.Interface
%Stream.Object %Studio.Debugger %Studio.Extension.Base
%Studio.Global %Studio.SASchemaUtil %Studio.SourceControl.CCREventHandler
%TSQL.Impl %TSQL.LineBuffer %TSQL.SysFunc
%TSQL.Transformer %TSQL.sys.log %UMLS.DefaultMappings
%UMLS.Install.CBuilder %UMLS.Install.SystemUtils %UMLS.Install.Utils
%UMLS.TFIDF %UMLS.Utils %UnitTest.DSQL
%UnitTest.ESQL %UnitTest.JDBCSQL %UnitTest.Manager
%UnitTest.ODBCSQL %UnitTest.TestCase %UnitTest.Utility
%WebStress.Control.ValidData.Request %WebStress.HttpResponse %WebStress.Results.Parameters
%XEP.SQLQuery %XGEN.AbstractElement %XML.CatalogParser
%XML.CatalogResolver %XML.Element %XML.ElementExtension
%XML.Exchange %XML.Exchange.ChangeControlBase %XML.Exchange.Metadata
%XML.Implementation %XML.Namespaces %XML.Node
%XML.Reader %XML.SAX.ContentHandler %XML.SAX.EntityResolver
%XML.SAX.Parser %XML.SAX.StreamAdapter %XML.SAX.Utils.Replayer
%XML.Schema %XML.Security.CipherData %XML.Security.CipherDataStream
%XML.Security.CipherReference %XML.Security.DSAKeyValue %XML.Security.DataReference
%XML.Security.EncryptionMethod %XML.Security.EncryptionProperties %XML.Security.EncryptionProperty
%XML.Security.InclusiveNamespaces %XML.Security.KeyInfo %XML.Security.KeyInfoClause
%XML.Security.KeyReference %XML.Security.Object %XML.Security.RSAKeyValue
%XML.Security.Reference %XML.Security.SignedInfo %XML.Security.Transform
%XML.Security.X509DataElement %XML.TextReader %XML.Utils.SchemaReader
%XML.Utils.SchemaResult %XML.Writer %XML.XPATH.Document
%XML.XPATH.Reader %XML.XPATH.ResultHandler %XML.XSLT.CallbackHandler
%XML.XSLT.CompiledStyleSheet %XML.XSLT.ErrorHandler %XML.XSLT.StreamAdapter
%XML.XSLT.Transformer %XML.XSLT2.CompiledStyleSheet %XML.XSLT2.Transformer
%XSQL.Compile %XSQL.DLLInterfaceUtil %XSQL.DS.Statement
%XSQL.Dictionary %XSQL.Format %XSQL.Log
%XSQL.Reporting %XSQL.StatementBatch %ZEN.Auxiliary.NodeInfo
%ZEN.Auxiliary.QueryInfo %ZEN.Component.object %ZEN.DataModel.AbstractDocument
%ZEN.DataModel.DataModel %ZEN.DataModel.DocumentUtils %ZEN.DataModelUtils
%ZEN.FinderUtils %ZEN.Generator %ZEN.Mobile.RSS.API
%ZEN.Mojo.ActivityLog.Summarizer %ZEN.Mojo.ActivityLog.Utils %ZEN.Mojo.Utils
%ZEN.Portal.ContextSearch %ZEN.Portal.Utils %ZEN.Report.DataCache
%ZEN.Report.Display.COSChart.CellInfo %ZEN.Report.Display.COSChart.Date %ZEN.Report.Display.COSChart.Helpers.IndexedEvent
%ZEN.Report.Display.COSChart.Helpers.SortedEvents %ZEN.Report.Display.COSChart.Helpers.TimeEvent %ZEN.Report.Display.COSChart.bbox
%ZEN.Report.Display.COSChart.dataBag %ZEN.Report.Display.COSChart.dataItem %ZEN.Report.Display.COSChart.dataItemBullsEye
%ZEN.Report.Display.COSChart.dsFormulaEngine %ZEN.Report.Display.COSChart.dsFormulaParser %ZEN.Report.Display.COSChart.extent
%ZEN.Report.Display.COSChart.function %ZEN.Report.Display.COSChart.node %ZEN.Report.Display.COSChart.parseTreeNode
%ZEN.Report.Display.COSChart.range %ZEN.Report.Display.COSChart.stack %ZEN.Report.Display.COSChart.styleNVP
%ZEN.Report.Display.COSChart.token %ZEN.Report.Display.Chart.chartUtil %ZEN.Report.Display.Chart.plot
%ZEN.Report.Display.common %ZEN.Report.Display.reportTemplate %ZEN.Report.Display.version86
%ZEN.Report.Models.Group.Document %ZEN.Report.Models.Group.Group %ZEN.Report.Models.Group.Report
%ZEN.Report.Models.Group.Utils %ZEN.Report.Ping %ZEN.Report.RecordCounter
%ZEN.Report.RenderController %ZEN.Report.Semaphore %ZEN.Report.SplitAndMerge
%ZEN.Report.defaultApplication %ZEN.Report.hotPrint %ZEN.Report.parameter
%ZEN.Report.pivotTableGenerator %ZEN.Report.reportDataClasses %ZEN.Report.reportGenerator
%ZEN.Report.reportNode %ZEN.Report.reportPage %ZEN.Report.streamTransformer
%ZEN.SVGComponent.svgPage %ZEN.Submit %ZEN.Template.PageGeneratorInfo
%ZEN.Template.ZENPageList %ZEN.TreeUtils %ZEN.Utils
%ZEN.application %ZEN.proxyObject %ZEN.proxyObjectEnumeratee
%iFind.DirectInput %iFind.Rank.Abstract %iFind.Transformation.Abstract
%iKnow.Classification.Builder %iKnow.Classification.Classifier %iKnow.Classification.Definition.node
%iKnow.Classification.Methods.Base %iKnow.Classification.Optimizer %iKnow.Compiler.FailureFunction
%iKnow.Compiler.GotoFunction %iKnow.Compiler.InlParser %iKnow.Compiler.InlReader
%iKnow.Compiler.Knowledgebase %iKnow.Compiler.Languagebase %iKnow.Compiler.MetadataTable
%iKnow.Compiler.OutputFunction %iKnow.Compiler.Predicate %iKnow.Compiler.RegexDictionary
%iKnow.Compiler.StateOutputFunction %iKnow.Compiler.Util %iKnow.DeepSee.CubeUtils
%iKnow.DeepSee.Utils %iKnow.DirectInput %iKnow.DirectInputDO
%iKnow.DirectInputOne %iKnow.DomainDefinition %iKnow.Filters.Filter
%iKnow.Indexer %iKnow.Matching.Formats.Format %iKnow.Matching.MatchFilter
%iKnow.Metrics.MetricBuilder %iKnow.Metrics.MetricDefinition %iKnow.Native.HunspellInterface
%iKnow.Native.NativeIndexer %iKnow.Native.NativeKnowledgebase %iKnow.Native.NativeLanguagebase
%iKnow.Objects.Utils %iKnow.Queries.AbstractAPI %iKnow.Queries.AbstractQAPI
%iKnow.Queries.MetadataI %iKnow.Queries.Utils %iKnow.Semantics.EquivAPI
%iKnow.Semantics.ProximityAPI %iKnow.Shell %iKnow.Shell.Command
%iKnow.Shell.RunState %iKnow.Source.Converter %iKnow.Source.Lister
%iKnow.Source.Loader %iKnow.Source.Processor %iKnow.Stemmer
%iKnow.TextTransformation.Definition %iKnow.TextTransformation.FileToTextArray %iKnow.TextTransformation.HK
%iKnow.TextTransformation.HKExportSet %iKnow.TextTransformation.Insert %iKnow.TextTransformation.InsertParsed
%iKnow.TextTransformation.Model.node %iKnow.TextTransformation.ModelData %iKnow.TextTransformation.Output
%iKnow.TextTransformation.StringToTextArray %iKnow.TextTransformation.TextArrayToFile %iKnow.TextTransformation.TextArrayToString
%iKnow.TextTransformation.XMLArrayBase %iKnow.TextTransformation.conf.CreateTables %iKnow.TextTransformation.conf.Insert
%iKnow.TextTransformation.conf.Model %iKnow.TextTransformation.conf.RSLoop %iKnow.TextTransformation.conf.TTModel
%iKnow.TextTransformation.modeling.RSLoop %iKnow.TextTransformation.utils.ClassGenerator %iKnow.Utils.CopyUtils
%iKnow.Utils.GeneratorUtils %iKnow.Utils.QueryTester %iKnow.Utils.UpgradeUtils
%zDocBookUtils.Common %zDocBookUtils.HTML CSPX.Dashboard.ChartSeries
CSPX.Dashboard.GridDimension CSPX.Dashboard.GridSeries CSPX.Dashboard.Meter
CSPX.Dashboard.Renderer CSPX.EnsBPInstanceFilterForm CSPX.EnsBPLPlugin
CSPX.EnsDTLInfoPaneForm CSPX.EnsLogFilterForm CSPX.EnsMAHomeForm
CSPX.EnsMAPurgeForm CSPX.EnsMsgSearchForm CSPX.EnsMsgTraceFilterForm
CSPX.EnsPurgeForm CSPX.EnsRuleLogFilterForm CSPX.EnsSuspendedMsgForm
CSPX.LoginForm CSPX.SQLQueryForm Ens.AbstractDelegate
Ens.Activity.Utils Ens.Adapter Ens.Alerting.Context.CreateAlert
Ens.Alerting.Context.OverdueAlert Ens.Alerting.NotificationTarget Ens.BPL.Compiler
Ens.BPL.CompilerThread Ens.BPL.Counter Ens.BPL.LabelScope
Ens.BPL.Node Ens.BPL.Parser Ens.BPL.Stack
Ens.BPL.UI.Connector Ens.BPL.UI.Diagram Ens.BPL.UI.Parser
Ens.BPL.UI.Shape Ens.BPL.ValidationContext Ens.BusinessServiceHost
Ens.CallStructure Ens.Config.CredentialsList Ens.Config.MessageMap
Ens.Config.SearchTableItem Ens.DTL.Compiler Ens.DTL.Node
Ens.DTL.Parser Ens.DTL.Utils Ens.DTL.ValidationContext
Ens.DataTransform Ens.Enterprise.MsgBank.Handshake Ens.Enterprise.Portal.MsgFilter.LegacyFilter
Ens.Host Ens.Job Ens.Production
Ens.Rule.Compiler Ens.Rule.ExpressionParser Ens.Rule.Model.base
Ens.Rule.Model.expression Ens.Rule.Upgrade Ens.Rule.VirtualProperty
Ens.Schema.BPL Ens.Schema.DTL Ens.Schema.Production
Ens.Schema.Rule Ens.ServiceRegistry.External.API Ens.ServiceRegistry.Public.API
Ens.Util.BPL Ens.Util.DTL Ens.Util.File
Ens.Util.HTML.Parser Ens.Util.HTML.TokenClassifier Ens.Util.Pipe
Ens.Util.Statistics Ens.Util.URLStream Ens.Util.XML.SecuritySignature
Ens.VDoc.SearchTableGenerator Ens.VDoc.Utils EnsLib.DICOM.DataSetInterface
EnsLib.DICOM.File EnsLib.DICOM.UnitTest.Main EnsLib.DICOM.Util.ContentHandler
EnsLib.DICOM.Util.Encoding EnsLib.DICOM.Util.Importer EnsLib.DICOM.Util.InputStreamAdapter
EnsLib.DICOM.Util.OutputStreamAdapter EnsLib.DICOM.Util.Reporting EnsLib.DICOM.Util.Stack
EnsLib.DICOM.Util.TempData EnsLib.DICOM.Util.UID EnsLib.DICOM.Util.ULP
EnsLib.DICOM.Util.UnreliableStream EnsLib.EDI.ASTM.Parser EnsLib.EDI.ASTM.Segment
EnsLib.EDI.EDIFACT.Parser EnsLib.EDI.EDIFACT.Segment EnsLib.EDI.SEF.Importer
EnsLib.EDI.SEF.MaskNavigator EnsLib.EDI.SEF.Node EnsLib.EDI.SEF.Parser
EnsLib.EDI.SEF.Util.Stack EnsLib.EDI.SEF.Util.TokenClassifier EnsLib.EDI.SEF.Util.X12DataImporter
EnsLib.EDI.Segmented EnsLib.EDI.X12.Parser EnsLib.EDI.X12.SchemaConvert
EnsLib.EDI.X12.Segment EnsLib.EDI.XML.DOMUpgrader EnsLib.EDI.XML.NamespaceHelper
EnsLib.EDI.XML.Schema EnsLib.EDI.XML.SchemaXSD EnsLib.FTP.CommonSSH
EnsLib.HL7.Annotation.Data EnsLib.HL7.Parser EnsLib.HL7.Segment
EnsLib.HL7.Util.Generator EnsLib.ITK.Framework.Fault EnsLib.ITK.Framework.SOAPCommon
EnsLib.ITK.UI.RegistryColumn EnsLib.ITK.Util.UtilityMethods EnsLib.ITK.Util.XML
EnsLib.ITK.Validation.TKWLog EnsLib.ITK.Validation.TestManager EnsLib.IWay.Error
EnsLib.IWay.ErrorData EnsLib.IWay.IBO.CncResult EnsLib.IWay.IBO.Col
EnsLib.IWay.IBO.Result EnsLib.IWay.IBO.ResultSet EnsLib.IWay.IBO.Row
EnsLib.IWay.IBO.Status EnsLib.JMS.Common EnsLib.JMSTest
EnsLib.JavaGateway.Common EnsLib.JavaGateway.SAPTest EnsLib.MQSeries.Message
EnsLib.PubSub.SubscriberForm EnsLib.PubSub.SubscriptionForm EnsLib.PubSub.Utils
EnsLib.RecordMap.Model.BatchElement EnsLib.RecordMap.Model.ComplexBatch EnsLib.RecordMap.Model.HeaderTrailer
EnsLib.RecordMap.Model.Record EnsLib.RecordMap.Model.RecordProperty EnsLib.RecordMap.RecordMap
EnsLib.SAP.Utils EnsLib.SOAP.CST.Common EnsLib.SOAP.CST.Fault
EnsLib.SQL.GatewayResultSet EnsLib.TCP.Common EnsLib.TCP.FramedCommon
EnsLib.TCP.TextLineCommon EnsLib.UDDI.Base EnsLib.UDDI.Connection
EnsLib.UDDI.URLResolutionPolicy EnsLib.UDDI.UnitTest EnsLib.UDDI.dsig.CanonicalizationMethodType
EnsLib.UDDI.dsig.DSAKeyValueType EnsLib.UDDI.dsig.DigestMethodType EnsLib.UDDI.dsig.KeyInfoType
EnsLib.UDDI.dsig.KeyValueType EnsLib.UDDI.dsig.ManifestType EnsLib.UDDI.dsig.ObjectType
EnsLib.UDDI.dsig.PGPDataType EnsLib.UDDI.dsig.RSAKeyValueType EnsLib.UDDI.dsig.ReferenceType
EnsLib.UDDI.dsig.RetrievalMethodType EnsLib.UDDI.dsig.SPKIDataType EnsLib.UDDI.dsig.SignatureMethodType
EnsLib.UDDI.dsig.SignaturePropertiesType EnsLib.UDDI.dsig.SignaturePropertyType EnsLib.UDDI.dsig.SignatureType
EnsLib.UDDI.dsig.SignedInfoType EnsLib.UDDI.dsig.TransformType EnsLib.UDDI.dsig.TransformsType
EnsLib.UDDI.dsig.X509DataType EnsLib.UDDI.dsig.X509IssuerSerialType EnsLib.UDDI.uddi.addpublisherAssertions
EnsLib.UDDI.uddi.address EnsLib.UDDI.uddi.assertionStatusItem EnsLib.UDDI.uddi.assertionStatusReport
EnsLib.UDDI.uddi.authToken EnsLib.UDDI.uddi.bindingDetail EnsLib.UDDI.uddi.bindingTemplate
EnsLib.UDDI.uddi.bindingTemplates EnsLib.UDDI.uddi.businessDetail EnsLib.UDDI.uddi.businessEntity
EnsLib.UDDI.uddi.businessInfo EnsLib.UDDI.uddi.businessInfos EnsLib.UDDI.uddi.businessList
EnsLib.UDDI.uddi.businessService EnsLib.UDDI.uddi.businessServices EnsLib.UDDI.uddi.categoryBag
EnsLib.UDDI.uddi.contact EnsLib.UDDI.uddi.contacts EnsLib.UDDI.uddi.deletebinding
EnsLib.UDDI.uddi.deletebusiness EnsLib.UDDI.uddi.deletepublisherAssertions EnsLib.UDDI.uddi.deleteservice
EnsLib.UDDI.uddi.deletetModel EnsLib.UDDI.uddi.discardauthToken EnsLib.UDDI.uddi.discoveryURLs
EnsLib.UDDI.uddi.dispositionReport EnsLib.UDDI.uddi.findQualifiers EnsLib.UDDI.uddi.findbinding
EnsLib.UDDI.uddi.findbusiness EnsLib.UDDI.uddi.findrelatedBusinesses EnsLib.UDDI.uddi.findservice
EnsLib.UDDI.uddi.findtModel EnsLib.UDDI.uddi.getassertionStatusReport EnsLib.UDDI.uddi.getauthToken
EnsLib.UDDI.uddi.getbindingDetail EnsLib.UDDI.uddi.getbusinessDetail EnsLib.UDDI.uddi.getoperationalInfo
EnsLib.UDDI.uddi.getpublisherAssertions EnsLib.UDDI.uddi.getregisteredInfo EnsLib.UDDI.uddi.getserviceDetail
EnsLib.UDDI.uddi.gettModelDetail EnsLib.UDDI.uddi.hostingRedirector EnsLib.UDDI.uddi.identifierBag
EnsLib.UDDI.uddi.instanceDetails EnsLib.UDDI.uddi.keyedReference EnsLib.UDDI.uddi.keyedReferenceGroup
EnsLib.UDDI.uddi.keysOwned EnsLib.UDDI.uddi.listDescription EnsLib.UDDI.uddi.operationalInfo
EnsLib.UDDI.uddi.operationalInfos EnsLib.UDDI.uddi.overviewDoc EnsLib.UDDI.uddi.publisherAssertion
EnsLib.UDDI.uddi.publisherAssertions EnsLib.UDDI.uddi.registeredInfo EnsLib.UDDI.uddi.relatedBusinessInfo
EnsLib.UDDI.uddi.relatedBusinessInfos EnsLib.UDDI.uddi.relatedBusinessesList EnsLib.UDDI.uddi.result
EnsLib.UDDI.uddi.savebinding EnsLib.UDDI.uddi.savebusiness EnsLib.UDDI.uddi.saveservice
EnsLib.UDDI.uddi.savetModel EnsLib.UDDI.uddi.serviceDetail EnsLib.UDDI.uddi.serviceInfo
EnsLib.UDDI.uddi.serviceInfos EnsLib.UDDI.uddi.serviceList EnsLib.UDDI.uddi.setpublisherAssertions
EnsLib.UDDI.uddi.sharedRelationships EnsLib.UDDI.uddi.tModel EnsLib.UDDI.uddi.tModelBag
EnsLib.UDDI.uddi.tModelDetail EnsLib.UDDI.uddi.tModelInfo EnsLib.UDDI.uddi.tModelInfos
EnsLib.UDDI.uddi.tModelInstanceDetails EnsLib.UDDI.uddi.tModelInstanceInfo EnsLib.UDDI.uddi.tModelList
EnsLib.UDP.Common EnsLib.Workflow.Engine EnsLib.Workflow.FormEngine
EnsLib.Workflow.UI.TaskAssignForm EnsLib.XPATH.MessageAdaptor EnsLib.XSLT.Common
EnsPortal.HL7.Utils EnsPortal.MsgFilter.AbstractAssistant EnsPortal.Utils
EnsPortal.UtilsMonitor

Parameters

• parameter CAPTION;
Optional name used by the Caché Form Wizard for a class when generating forms.
• parameter JAVATYPE;
The Java type to be used when exported.
• parameter PROPERTYVALIDATION = 2;
This parameter controls the default validation behavior for the object.

It can take one of the following values:
0: NoValidate Perform no automatic property validation.
1: ValidateOnSet Perform validation (call the property's ..IsValid method) every time an attribute value is set.
2: ValidateOnSave Perform property validation (in the %ValidateObject method)) when the object is saved. This is only applicable to persistent objects.

Note: The use of ValidateOnSet is not recommended-it can cause excessive communication between client and server in distributed applications. It is provided for compatability with previous versions.


Methods

• method %AddToSaveSet(depth As %Integer = 3, refresh As %Integer = 0) as %Status

This method adds the current object to the SaveSet containing objects that are part of the current %Save() for persistent classes or %GetSwizzleObject for serial classes. A queue of objects to be saved or serialized is also constructed. Only modified objects are included in the save queue. The value (OID or serial value in OID form) of each object is also placed in the SaveSet.

This method will invoke the %OnAddToSaveSet method if it is implemented. See that method for more information.

%AddToSaveSet should not ever be invoked directly except from %OnAddToSaveSet.

This method takes these parameters: depth, with these values:
1: Include this object in the SaveSet and, if it has not been serialized put it in the save queue and invoke %AddToSaveSet on any objects referenced by this object to the SaveSet with a depth of 1.
2: Include this object in the SaveSet and save queue. Also invoke %AddToSaveSet on any referenced objects in the SaveSet with a depth of 1.
3: Include this object in the SaveSet and, if modified, the save queue. Also invoke %AddToSaveSet on any referenced objects in the SaveSet with a depth of 3.
refresh, with these values:
0: Add this object to the save set only if it isn't already included.
1: Add this object to the SaveSet even if it already exists. This causes object dependencies to be rebuilt. Typically, this value is only passed by %OnAddToSaveSet when it modifies objects other than the current one.

Note: Swizzled serial objects always have an empty serial value and will always be placed in the save queue and the SaveSet. the value of depth simply gets passed on to its referenced objects.

• method %ConstructClone(deep As %Integer = 0, ByRef cloned As %String, location As %String) as %RegisteredObject
Clone the current object to a new object. If deep is 1 then this does a deep copy which will also copy any subobjects and if deep is 0 then it will create another reference to any subobjects and increment the reference count appropriately. It returns the new cloned object.

Note that even if deep=0 when you clone a parent object in a parent child relationship or a one object of a one to many relationship then it will construct clones of all the child/many objects. This is because a child/many object can only point at a single parent and so if we did not create a clone of these then you would have a relationship with zero items in it. If you really just want to clone the object without these child/many objects then pass deep=-1 to this method.

After the clone is constructed it will call %OnConstructClone(object,deep,.cloned) on the clone if it is defined so that you can perform any additional steps e.g. taking out a lock. This works just the same way as %OnNew() does.

The object is the oref of the original object that was cloned. The cloned array is just used internally when doing a deep clone to prevent recursive loops, do not pass anything in at all for this parameter on the initial call. If you write a %OnConstructClone and from here you wish to call %ConstructClone on another object pass in the cloned array, e.g. 'Do oref.%ConstructClone(1,.cloned)' so that it can prevent recursive loops.

The location is used internally to pass the new location for stream objects.

• method %IsModified() as %Integer
Returns true (1) if a property of this instance has been modified, otherwise false (0). A TRUE result does not necessarily mean that any property has actually been changed. If %IsModified() returns false then the object has not been modified. There are some situations where we simply cannot efficiently detect a change in value. In these cases we will set the modified status of the property.
• method %NormalizeObject() as %Status
Normalizes all of an object's property values by invoking the data type Normalize methods. Many data types may allow many different representations of the same value. Normalization converts a value to its cannonical, or normalized, form.
• method %ObjectModified() as %Integer
This method is somewhat similar to %IsModified but it also checks to see if swizzled references would cause the object to become modified should they be serialized. This works on the assumption that a reference to a persistent object will never be modified if the ID has already been assigned. For references to serial objects, a call to %ObjectModified indicates whether or not the serialized value is different. If the reference to a swizzled object is different from the initial object state then the $$$objModAll macro will already return true. Reference the Set code. Returns true (1) if this instance has been modified, otherwise false (0).
• method %RemoveFromSaveSet() as %Status

This method removes the current object from the SaveSet. If this object is also in the save queue it is removed from there as well.

• method %SerializeObject(ByRef serial As %Binary, partial As %Integer = 0) as %Status
This method retrieves all of the serial values for referenced objects and places them into the instance variables, Validates, Normalizes, and serializes the object (with a save of the persistent image if persistent).
This method is not meant to be called directly. It is called by %Save and by %GetSwizzleObject.
• method %ValidateObject(force As %Integer = 0, checkserial As %Boolean = 1) as %Status
This method validates an object. The %Save method of a persistent class calls it before filing any objects in the database. The %ValidateObject method of a referencing object can call it. You can also call it explicitly at any time.

%ValidateObject does the following:

  1. It tests if any required property values are missing.
  2. If the PROPERTYVALIDATION class parameter is set to ValidateOnSave, it validates each non-null property value by calling the property method IsValid on each literal property and the object's %ValidateObject method for object-valued properties.
  3. If present, it will call a user-supplied %OnValidateObject method.

If any of these tests fail, %ValidateObject immediately returns an error value. It is up to the caller of %ValidateObject to process the error value.

Returns a %Status value indicating success or failure.



Copyright © 1997-2020, InterSystems Corporation