Class Reference
IRIS for UNIX 2019.3
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [Ens] >  [DTL] >  [UI] >  [DTLDocument]
Private  Storage   

stream class Ens.DTL.UI.DTLDocument extends Ens.Util.AbstractDocument

Abstract Document used to load DTL diagrams into Studio.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 8


Summary

Properties
%Location AtEnd Attributes Code CompileTime
Generated Id LastModified LineTerminator Locked
Name Size TimeStamp UpToDate

Methods
%AddToSaveSet %CheckUnique %ClassIsLatestVersion %ClassName
%ConstructClone %Delete %DeleteExtent %DeleteId
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Exists
%ExistsId %Extends %GetParameter %GetSwizzleObject
%Id %IsA %IsModified %IsNull
%KillExtent %LOBPrefetch %LocationSet %LockStream
%New %NormalizeObject %ObjectIsNull %ObjectModified
%ObjectSize %Oid %Open %OpenId
%OriginalNamespace %PackageName %ReleaseLock %Reload
%RemoveFromSaveSet %RollBack %Save %SerializeObject
%SetModified %UnlockStream %ValidateObject AtEndGet
AtEndSet Clear Compile CompileDocument
CompileTime CompileTimeGet CopyFrom CopyFromAndSave
Delete DeleteAttribute DeleteStream Exists
ExportToXML FindAt Flush GetAttribute
GetAttributeList GetClassName GetDTLStream GetOther
GetPrevious GetStreamId GetTransform GetURL
HasExtension ImportFromXML InputFromDevice IsCharacter
IsDefinedAttribute IsEnabled IsGenerated IsMapped
IsNull IsUpToDate ItemList LastModifiedGet
LineTerminatorSet ListClose ListExecute ListFetch
Load LocalizeDescription Lock LockName
MoveTo MoveToEnd NextAttribute OpenStream
OutputToDevice OutputToDeviceAt Read ReadLine
ReadLineIntoStream ReadSQL Rewind Save
SaveAs SaveDTLToClass SaveStream Search
SearchRegex SerializeToSyncSet SetAttribute SetAttributeList
SizeGet StreamOIDIsNull SyncStreamIn TimeStamp
TimeStampGet TranslateExportName Unlock UnlockName
UpToDateGet Write WriteLine


Parameters

• parameter DOCUMENTCLASS = "Ens.DataTransformDTL";
If set, name of superclass used for documents of this type.
For example, Ens.DataTransformDTL
• parameter EDITORURL = "EnsPortal.DTLEditor.zen";
URL to use to get actual editor for Studio to display.
• parameter EXTENSION = ".dtl";
File extension used for this document (e.g., .dtl)

Methods

• classmethod Exists(name As %String) as %Boolean
Return 1 if the given DTL document exists and 0 if it does not.
• method ExportToXML(flags As %String) as %Status
Export this document to the current device in XML format
• classmethod GetDTLStream(Output pStream As %Stream.Object, pClassName As %String, ByRef pDesc As %String) as %Status
Find the DTL definition (as a stream) for the given DTL class; return "" if not found.
Also returns Description for this class
• classmethod GetTransform(Output pTransform As Ens.DTL.Transform, pClassName As %String) as %Status
Get DTL info for a class
• classmethod GetURL(pName As %String) as %String
• method ImportFromXML(stream As %RegisteredObject, flags As %String) as %Status
Passed a stream containing the XML document, this method should insert this into the current document. Once this is done the importer will call Save on the document. This default handler in assumes the export ExportToXML just wrote the data in a CDATA structure
• method Save() as %Status
Deserialize the DTL Diagram and save it as a DTL class.
• classmethod SaveDTLToClass(pClassName As %String, pDTL As %Stream.Object) as %Status
Save the given DTL document to the specified class' XDATA block. If class does not exist, create a new one


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.