This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see the InterSystems IRIS Migration Guide and Migrating to InterSystems IRIS, both available on the WRC Distributions page (login required).

%Atelier.v1.Utils.DocumentStreamAdapter

class %Atelier.v1.Utils.DocumentStreamAdapter extends %Library.RegisteredObject

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties

property Document as %ZEN.proxyObject;
Property methods: DocumentGet(), DocumentGetSwizzled(), DocumentIsValid(), DocumentNewObject(), DocumentSet()

Methods

private method %OnNew(pStream As %Stream = $$$NULLOREF, pName As %String, pDocStatus As %String, pTimeStamp As %String) as %Status
Inherited description: 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.

method %ToJSON(pLevel As %Integer = 0, pFormat As %String = "aelotws") as %Status
This method renders the document as a JSON object containing these fields :- { "content":"

Inherited Members

Inherited Methods (Including Private)

Feedback