Class %ZEN.DataModel.AbstractDocument

deprecatedabstract class %ZEN.DataModel.AbstractDocument extends %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.

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
1		3

Summary

Methods
%AddToSaveSet	%ClassIsLatestVersion	%ClassName	%ConstructClone
%DispatchClassMethod	%DispatchGetModified	%DispatchGetProperty	%DispatchMethod
%DispatchSetModified	%DispatchSetMultidimProperty	%DispatchSetProperty	%Extends
%GetDocument	%GetDocumentName	%GetParameter	%IsA
%IsModified	%New	%NormalizeObject	%ObjectModified
%OnGetDocument	%OriginalNamespace	%PackageName	%RemoveFromSaveSet
%SerializeObject	%SetModified	%ValidateObject

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

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

Return the logical name of this document class.

• 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.

Class Reference IRIS for UNIX 2024.1.2
Documentation Search