IRISLIB database
AbstractDocument Class Reference

Base class for Zen data documents. More...

Inheritance diagram for AbstractDocument:
Collaboration diagram for AbstractDocument:

Static Public Attributes

 DOCUMENTCLASS = None
 Logical name of this document class. More...
 
- Static Public Attributes inherited from RegisteredObject
 CAPTION = None
 Optional name used by the Form Wizard for a class when generating forms. More...
 
 JAVATYPE = None
 The Java type to be used when exported.
 
 PROPERTYVALIDATION = None
 This parameter controls the default validation behavior for the object. More...
 

Private Member Functions

_.Library.Status OnGetDocument (_.Library.String pID, pParms, _.ZEN.proxyObject pDocument)
 Process a request for a data document. More...
 

Static Private Member Functions

_.Library.Status GetDocument (_.Library.String pID, pParms, _.ZEN.proxyObject pDocument)
 Retrieve a data document. More...
 
_.Library.String GetDocumentName ()
 Return the logical name of this document class.
 

Additional Inherited Members

- Public Member Functions inherited from RegisteredObject
_.Library.Status OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
 This callback method is invoked when the current object is added to the SaveSet,. More...
 
_.Library.Status OnClose ()
 This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
 
_.Library.Status OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
 This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
 
_.Library.Status OnNew ()
 This callback method is invoked by the <METHOD>New</METHOD> method to. More...
 
_.Library.Status OnValidateObject ()
 This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
 

Detailed Description

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.

Member Function Documentation

◆ GetDocument()

_.Library.Status GetDocument ( _.Library.String  pID,
  pParms,
_.ZEN.proxyObject  pDocument 
)
staticprivate

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()

_.Library.Status OnGetDocument ( _.Library.String  pID,
  pParms,
_.ZEN.proxyObject  pDocument 
)
private

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.

Member Data Documentation

◆ DOCUMENTCLASS

DOCUMENTCLASS = None
static

Logical name of this document class.

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