%ZEN.StudioDocument.AbstractDocument

abstract stream class %ZEN.StudioDocument.AbstractDocument extends %Studio.AbstractDocument

• A class Projection named RegisterExtension.
  For example:
  Projection RegisterExtension As %Projection.StudioDocument(DocumentExtension = "BPL");
• A value for the EDITORURL parameter.
  This is the URL of the page that provides the actual editor UI.
• If needed, a value for the DOCUMENTCLASS parameter.
• An override of the Save() method.
• An override of the Exists() method.

Method Inventory (Including Private)

• Compile()
• Delete()
• Exists()
• GetClassName()
• GetOther()
• ListClose()
• ListExecute()
• ListFetch()
• Load()
• LocalizeDescription()
• TimeStamp()

Copy link to this sectionParameters

Copy link to this section parameter DESCRIPTION;

Description Studio will display for this document.
If DOMAIN is defined this will be localized.

Copy link to this section parameter DOCUMENTCLASS;

If set, name of superclass used for documents of this type.
For example, "Ens.DataTransformDTL"

Copy link to this section parameter EDITORURL;

URL of the editor Studio will display within its HTML pane.

Copy link to this section parameter EXTENSION;

File extension used for this document (e.g., ".dtl")

Copy link to this section parameter LISTABSTRACT = 0;

If true, the built-in document list logic will include abstract classes otherwise they are ignored.

Copy link to this sectionMethods

Copy link to this section method Compile(flags As %String) as %Status [ Language = objectscript ]

Compile this document

Copy link to this section classmethod Delete(name As %String) as %Status [ Language = objectscript ]

Delete the class that corresponds to document name. Subclass should override this behavior for non-class based editors.

Copy link to this section classmethod Exists(pName As %String) as %Boolean [ Language = objectscript ]

Return 1 if the given document exists and 0 if it does not.
Subclass can override this behavior.

Copy link to this section classmethod GetClassName(pName As %String) as %String [ Language = objectscript ]

Return the corresponding class name for this document

Copy link to this section classmethod GetOther(Name As %String) as %String [ Language = objectscript ]

Return other document types that this is related to. Passed a name and you return a comma separated list of the other documents it is related to or "" if it is not related to anything
Subclass should override this behavior for non-class based editors.

Copy link to this section classmethod ListClose(ByRef qHandle As %Binary) as %Status [ Language = objectscript ]

Copy link to this section classmethod ListExecute(ByRef qHandle As %Binary, Directory As %String, Flat As %Boolean, System As %Boolean) as %Status [ Language = objectscript ]

Copy link to this section classmethod ListFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status [ Language = objectscript ]

Copy link to this section method Load() as %Status [ Language = objectscript ]

Return URL for Studio to use to load editor.

Copy link to this section classmethod LocalizeDescription(ext As %String, ByRef Description As %String(MAXLEN=500)) as %Status [ Language = objectscript ]

Copy link to this section classmethod TimeStamp(name As %String) as %TimeStamp [ Language = objectscript ]

Return the timestamp of routine 'name' in %TimeStamp format. This is used to determine if the routine has been updated on the server and so needs reloading from Studio. So the format should be $zdatetime($horolog,3), or "" if the routine does not exist.
Subclass should override this behavior for non-class based editors.

Copy link to this sectionQueries

Copy link to this section query List(Directory As %String, Flat As %Boolean, System As %Boolean)

Selects name As %String, modified As %TimeStamp, size As %Integer, directory As %String

Subclass should override this query for non-class based editors.