This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRISOpens in a new window, see the InterSystems IRIS Migration Guide and Migrating to InterSystems IRIS, both available on the WRC Distributions pageOpens in a new window (login required).


abstract persistent class %Document.Persistent extends %Library.Persistent

SQL Table Name: %Document.Persistent

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties (Including Private)

property %Document as %Document.Object;
Property methods: %DocumentGet(), %DocumentGetObject(), %DocumentGetObjectId(), %DocumentGetSwizzled(), %DocumentIsValid(), %DocumentNewObject(), %DocumentSet(), %DocumentSetObject(), %DocumentSetObjectId(), %DocumentUnSwizzle()

Methods (Including Private)

method %DocumentGetObject(force As %Integer = 0) as %Library.ObjectIdentity
method %DocumentGetObjectId(force As %Integer = 0) as %Library.String
classmethod %Get(id As %Integer = "", pDocument As %Binary = "", pFieldExpr As %String(MAXLEN="")="") as %Binary [ SQLProc = Get ]
private method %OnNew(pDocument As %String(MAXLEN="")="") as %Status
This callback method is invoked by the %New() method to provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created.

It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:

Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.

Inherited Members

Inherited Methods (Including Private)


Storage Model: CacheStorage (%Document.Persistent)

FeedbackOpens in a new window