InterSystems IRIS Data Platform 2020.4 > Class Reference > ENSLIB namespace > EnsLib.REST.DynamicObjVDoc


serial class EnsLib.REST.DynamicObjVDoc extends %Library.SerialObject, Ens.VDoc.Interface

Abstract persistent VDoc document wrapper class for arbitrary %DynamicObject instances

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties (Including Private)

property Obj as %DynamicAbstractObject [ Transient ];
The in-memory object that VDoc property paths will be evaluated against; may be a DynamicArray or a DynamicObject
Property methods: ObjGet(), ObjGetObject(), ObjGetObjectId(), ObjGetSwizzled(), ObjIsValid(), ObjNewObject(), ObjSet(), ObjSetObject(), ObjSetObjectId(), ObjUnSwizzle()

Methods (Including Private)

method %DispatchMethod(Method As %String, Args...) [ Language = objectscript ]
Inherited description: Is used to implement an unknown method call. It is also used to resolve an unknown multidimensional property reference (to get the value of a property) because that syntax is identical to a method call.
private method %OnAddToSaveSet(depth As %Integer = 3, insert As %Integer = 0, callcount As %Integer = 0) as %Status [ Language = objectscript ]
Serialize into JSON from Obj
method %OnNew(initvalue As %DynamicObject) as %Status [ Language = objectscript ]
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 GetValueAt(pPropertyPath As %Library.String, pFormat As %Library.String, Output pStatus As %Library.Status, pTreatEmptyFieldAsNull As %Library.Boolean = 0) as %String [ Language = objectscript ]
Return the value of the designated virtual property.
pPropertyPath contains a text expression representing the address within the document of the value of interest.
pFormat contains additional context that may be used to influence the form of the result value
If no value can be found matching pPropertyPath in the current document an empty string is returned and output argument pStatus returns status information explaining the failure
This is implemented by the document subclass.
method ObjGet() as %DynamicObject [ Language = objectscript ]
method ObjSet(pObj As %DynamicAbstractObject) as %Status [ Language = objectscript ]

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)