Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%IPM] >  [StudioDocument] >  [LocalizedMessages]
Private  Storage   

stream class %IPM.StudioDocument.LocalizedMessages extends %IPM.StudioDocument.Abstract

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 4 1


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 %ValidateName %ValidateObject
AtEndGet AtEndSet Clear Compile
CompileDocument CompileTime CompileTimeGet CopyFrom
CopyFromAndSave Delete DeleteAttribute DeleteStream
Exists ExportToXML FindAt Flush
GetAttribute GetAttributeList GetIncludeFileName GetOther
GetPrevious GetStreamId ImportFromXML ImportStream
InputFromDevice IsCharacter IsDefinedAttribute IsEnabled
IsGenerated IsMapped IsNull IsUpToDate
ItemList LastModifiedGet LineTerminatorSet ListClose
ListExecute ListFetch Load LocalizeDescription
Lock LockName MoveTo MoveToEnd
NextAttribute OnCompileDocument OnDelete OpenStream
OutputToDevice OutputToDeviceAt Read ReadLine
ReadLineIntoStream ReadSQL Rewind Save
SaveAs SaveStream Search SearchRegex
SerializeToSyncSet SetAttribute SetAttributeList SizeGet
StreamOIDIsNull SyncStreamIn TimeStamp TimeStampGet
TranslateExportName Unlock UnlockName UpToDateGet
Write WriteLine


Parameters

• parameter EXTENSION = ".LOC";
• parameter INFOGLOBAL = "^IPM.StuDoc.LocalizedMessages";
• parameter STREAMCLASS = "%IPM.StudioDocument.LocalizedMessageStream";
Optional subclass of %IPM.StudioDocument.AbstractStream that stores code in a character stream.

Methods

• classmethod GetIncludeFileName(pDocumentName As %String) as %String
Given a full error message document name (with .LOC extension), returns the full name (with extension) of the associated .INC file.
• classmethod GetOther(Name As %String) as %String
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. Note that this can be passed a document of another type for example if your 'test.XXX' document creates a 'test.INT' routine then it will also be called with 'test.INT' so you can return 'test.XXX' to complete the cycle.
• method OnCompileDocument(ByRef qstruct As %String) as %Status
• classmethod OnDelete(name As %String) as %Status
Deletes the include file associated with this document.

Queries

• query ItemList()
Selects name As %String, modified As %TimeStamp
SQL Query :
select Name, LastModifiedTimestamp from %IPM_StudioDocument.LocalizedMessageStream
Subclasses must override


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