Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [Ens] >  [BPL] >  [UI] >  [BPLDocument]
Private  Storage   

stream class Ens.BPL.UI.BPLDocument extends Ens.Util.AbstractDocument

Abstract Document used to load BPL diagrams into Studio.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 9


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 GetOther GetPrevious
GetStreamId 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 SaveBPLToClass
SaveStream Search SearchRegex SerializeToSyncSet
SetAttribute SetAttributeList SizeGet StreamOIDIsNull
SyncStreamIn TimeStamp TimeStampGet TranslateExportName
Unlock UnlockName UpToDateGet Write
WriteLine


Parameters

• parameter DOCUMENTCLASS = "Ens.BusinessProcessBPL";
Name of superclass used for documents of this type.
• parameter EDITORURL = "EnsPortal.BPLEditor.zen";
URL to use to get actual editor for Studio to display.
• parameter EXTENSION = ".bpl";
File extension used for this document (e.g., .dtl)

Methods

• method CompileDocument(flags As %String) as %Status
Compile this document
• method CopyFrom(source As %Stream.Object) as %Status
Copies the contents of source into this Stream.

For example, you can copy oldstream into a new stream:

	Set newstream=##class(%GlobalCharacterStream).%New()
	Do newstream.CopyFrom(oldstream)

Returns a %Status value indicating success or failure.

• classmethod Exists(name As %String) as %Boolean
Return 1 if the given BPL 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 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 BPL Diagram and save it as a BPL class.
• method SaveBPLToClass()
This method saves BPL XML to the given class


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