Skip to main content

%ZEN.DataModel.AbstractDocument

Class %ZEN.DataModel.AbstractDocument Extends %RegisteredObject [ Abstract, Deprecated, System = 3 ]

Base class for Zen data documents. A data document presents a document (object graph) that can be served to a web page (via a jsonProvider) and consumed by various visual components.

Parameters​

DOCUMENTCLASS​

Parameter DOCUMENTCLASS As STRING;

Logical name of this document class. If not provided, the document class name is used. Names are case-sensitive.

Methods​

%GetDocumentName​

ClassMethod %GetDocumentName() As %String [ CodeMode = objectgenerator, Final ]

Return the logical name of this document class.

%GetDocument​

ClassMethod %GetDocument(pID As %String, ByRef pParms, Output pDocument As %ZEN.proxyObject) As %Status [ Final ]

Retrieve a data document.
pID is the document instance id.
pParms is an optional set of additional parameters (passed in from a jsonProvider).
pDocument is the data document.

%OnGetDocument​

Method %OnGetDocument(pID As %String, ByRef pParms, Output pDocument As %ZEN.proxyObject) As %Status

Process a request for a data document. This is implemented by subclasses.
pID is the document instance id.
pParms is an optional set of additional parameters (passed in from a jsonProvider).
pDocument is the data document.