Ens.Util.AbstractDocument
abstract stream class Ens.Util.AbstractDocument extends %Studio.AbstractDocument
Abstract Document used to server SVG-editor documents into StudioSubclasses need to provide:
RegisterExtension Projection
Save method
Exists method
EDITORURL parameter
DOCUMENTCLASS parameter
Method Inventory
- CompileDocument()
- Delete()
- Exists()
- GetClassName()
- GetOther()
- GetURL()
- HasExtension()
- ListClose()
- ListExecute()
- ListFetch()
- Load()
- Lock()
- LockName()
- TimeStamp()
- TranslateExportName()
- Unlock()
- UnlockName()
Parameters
parameter DOCUMENTCLASS;
If set, name of superclass used for documents of this type.
For example, Ens.DataTransformDTL
For example, Ens.DataTransformDTL
parameter DOMAIN = Ensemble;
Use Ensemble domain for localization
parameter EDITORURL;
URL to use to get actual editor for Studio to display.
parameter EXTENSION;
File extension used for this document (e.g., .dtl)
Methods
Compile this document
Delete the class that corresponds to document name.
Subclass should override this behavior for non-class based editors.
Return 1 if the given document exists and 0 if it does not.
Subclass should override this behavior.
Subclass should override this behavior.
Return the corresponding class name for this document
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.
Subclass should override this behavior for non-class based editors.
Check to see that the file type matches
classmethod ListExecute(ByRef qHandle As %Binary, Directory As %String, Flat As %Boolean, System As %Boolean) as %Status
classmethod ListFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
method Load() as %Status
Return URL for Studio to use to load editor.
Lock the class definition for the document.
Lock the class definition for a document by name.
classmethod TimeStamp(name As %String) as %TimeStamp
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.
Subclass should override this behavior for non-class based editors.
Make the XML export export the class instead of this studio document which is only the XData.
Unlock the class definition for the document.
Unlock the class definition for a document by name.
Queries
Subclass should override this query for non-class based editors.
Inherited Members
Inherited Properties
- %Location
- AtEnd
- Attributes
- Code
- CompileTime
- Generated
- Id
- LastModified
- LineTerminator
- Locked
- Name
- Size
- TimeStamp
- UpToDate
Inherited 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()
- CompileTime()
- CompileTimeGet()
- CopyFrom()
- CopyFromAndSave()
- DeleteAttribute()
- DeleteStream()
- ExportToXML()
- FindAt()
- Flush()
- GetAttribute()
- GetAttributeList()
- GetPrevious()
- GetStreamId()
- ImportFromXML()
- InputFromDevice()
- IsCharacter()
- IsDefinedAttribute()
- IsEnabled()
- IsGenerated()
- IsMapped()
- IsNull()
- IsUpToDate()
- ItemList()
- LastModifiedGet()
- LineTerminatorSet()
- LocalizeDescription()
- MoveTo()
- MoveToEnd()
- NextAttribute()
- OpenStream()
- OutputToDevice()
- OutputToDeviceAt()
- Read()
- ReadLine()
- ReadLineIntoStream()
- ReadSQL()
- Rewind()
- Save()
- SaveAs()
- SaveStream()
- Search()
- SearchRegex()
- SerializeToSyncSet()
- SetAttribute()
- SetAttributeList()
- SizeGet()
- StreamOIDIsNull()
- SyncStreamIn()
- TimeStampGet()
- UpToDateGet()
- Write()
- WriteLine()