Home > Class Reference > %SYS namespace > %ZEN.DataModel.AbstractDocument

%ZEN.DataModel.AbstractDocument

abstract class %ZEN.DataModel.AbstractDocument extends %Library.RegisteredObject

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.

Method Inventory

Parameters

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

Methods

final classmethod %GetDocument(pID As %String, ByRef pParms, Output pDocument As %ZEN.proxyObject) as %Status [ Language = objectscript ]
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.
final classmethod %GetDocumentName() as %String [ Language = objectscript ]
Return the logical name of this document class.
method %OnGetDocument(pID As %String, ByRef pParms, Output pDocument As %ZEN.proxyObject) as %Status [ Language = objectscript ]
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.

Inherited Members

Inherited Methods