Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [%SYSTEM] >  [OBJ]
Private  Storage   

abstract class %SYSTEM.OBJ extends Help

The %SYSTEM.OBJ class provides an interface for managing objects.

You can use it via the special $system object:

	Do $system.OBJ.Load("MyFile.xml","ck")

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
73 2


Summary

Methods
CloseObjects Compile CompileAll CompileAllNamespaces
CompileInfoClass CompileInfoClose CompileInfoExecute CompileInfoFetch
CompileInfoFetchRows CompileList CompilePackage CompileProject
Delete DeleteAll DeletePackage DeleteProject
DisplayError Dump Export ExportAllClasses
ExportAllClassesIndividual ExportAllClassesToStream ExportCPP ExportDynCPP
ExportJava ExportJavaPackage ExportODL ExportPackage
ExportPackageToStream ExportPattern ExportPatternToStream ExportToStream
ExportUDL GetClassList GetConcurrencyMode GetDependencies
GetPackageList GetQualifiers GetTransactionMode Help
ImportDir IsUpToDate IsValidClassname Load
LoadDir LoadLanguage LoadStream MakeClassDeployed
New ObjectListClose ObjectListExecute ObjectListFetch
Open OpenId RebuildExtentIndex RebuildExtentIndexOne
RedirectBindSrvUserOutput SaveObjects SetConcurrencyMode SetFlags
SetQualifiers SetTransactionMode ShowClasses ShowFlags
ShowMacros ShowObjects ShowQualifiers ShowReferences
UnCompile UpdateConfigParam Upgrade UpgradeAll
ValidateIndices Version


Methods

• classmethod CloseObjects() as %Status
Deprecated function, to close objects let them go out of scope.
• classmethod Compile(ByRef classes As %String = "", qspec As %String = "", ByRef errorlog As %String, recurse As %Boolean = 0) as %Status
Compile a class.

Compiles the class classes, which can be a single class, a comma separated list, a subscripted array of class names. You can also use ? or * wild cards and if you wish to exclude items pass ' before the item name which also supports wild card, e.g. "User.*,'User.T*". If recurse is true then do not output the intial 'compiling' message or the compile report as this is being called inside another compile loop.
qspec is a list of flags or qualifiers which can be displayed with 'Do $system.OBJ.ShowQualifiers()' and 'Do $system.OBJ.ShowFlags()'.

• classmethod CompileAll(qspec As %String = "", ByRef errorlog As %String) as %Status
Compile all classes within this namespace. By default it will not compile classes mapped from another database unless the qualifier '/mapped=1' is provided.
qspec is a list of flags or qualifiers which can be displayed with 'Do $system.OBJ.ShowQualifiers()' and 'Do $system.OBJ.ShowFlags()'.
• classmethod CompileAllNamespaces(qspec As %String = "", ByRef errorlog As %String) as %Status
Invoke $system.OBJ.CompileAll for all the namespaces.

Parameters

NameDescription
qspec

qspec is a list of flags and qualifiers that can be displayed with 'Do $system.OBJ.ShowQualifiers()' and 'Do $system.OBJ.ShowFlags()'.

errorlog

errorlog is an array of the %Status error values encountered during the execution of this method. Each status value is in the format returned by $system.Status.DecomposeStatus.

The return value is a %Status value indicating success or failure.

• classmethod CompileInfoClass(class As %String, Output version As %String, Output compiletime As %String) as %Status
Given a class this returns the version of InterSystems IRIS this was compiled on and the compiletime of this class.
• classmethod CompileInfoClose(QHandle As %Binary) as %Status
• classmethod CompileInfoExecute(ByRef QHandle As %Binary, sortorder As %Integer = 0) as %Status
• classmethod CompileInfoFetch(ByRef QHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
• classmethod CompileInfoFetchRows(ByRef QHandle As %Binary, FetchCount As %Integer = 0, ByRef RowSet As %List, ByRef ReturnCount As %Integer, ByRef AtEnd As %Integer) as %Status
• classmethod CompileList(ByRef list As %String = "", qspec As %String = "", ByRef errorlog As %String, ByRef updatedlist As %String) as %Status
Compile a list of items specified in 'list' and separated by commas, or an array list("item.MAC")="". You can also use ? or * wild cards and if you wish to exclude items pass ' before the item name which also supports wild card, e.g. "User.*.cls,'User.T*.cls". Each item on the list is sufixed by the type of item it is so to compile a class and a routine you could specify 'class.cls,routine.mac' The order of compilation is INT, CLS, MAC, CSR, CSP.
qspec is a list of flags or qualifiers which can be displayed with 'Do $system.OBJ.ShowQualifiers()' and 'Do $system.OBJ.ShowFlags()'.
• classmethod CompilePackage(package As %String = "", qspec As %String = "", ByRef errorlog As %String) as %Status
Compile all classes within the specified package.

Parameters

NameDescription
package

You can pass one or more comma separated packages in package argument.

qspec

qspec is a list of flags and qualifiers that can be displayed with 'Do $system.OBJ.ShowQualifiers()' and 'Do $system.OBJ.ShowFlags()'.

errorlog

errorlog is an array of the %Status error values encountered during the execution of this method. Each status value is in the format returned by $system.Status.DecomposeStatus.

The return value is a %Status value indicating success or failure.

• classmethod CompileProject(project As %String = "", qspec As %String = "", ByRef errorlog As %String) as %Status
Compile all entries in this project.

Parameters

NameDescription
project

The name of the package to be compiled.

qspec

qspec is a list of flags and qualifiers that can be displayed with 'Do $system.OBJ.ShowQualifiers()' and 'Do $system.OBJ.ShowFlags()'.

errorlog

errorlog is an array of the %Status error values encountered during the execution of this method. Each status value is in the format returned by $system.Status.DecomposeStatus.

The return value is a %Status value indicating success or failure.

• classmethod Delete(ByRef classes As %String = "", qspec As %String = "", ByRef errorlog As %String) as %Status
Delete a class.

Delete the definition of class classes from this namespace which can be a single class, a comma separated list, a subscripted array of class names. You can also use ? or * wild cards and if you wish to exclude items pass ' before the item name which also supports wild card, e.g. "User.*,'User.T*". If the class to delete is persistent include the 'e' flag or '/deleteextent' qualifier to delete the extent data and extent metadata. Refer to %ExtentMgr.Util for more information on extent metadata.

Parameters

NameDescription
classes

The class, a comma separated list of classes or a subscripted array of class names. Wild cards may be specified.

qspec

qspec is a list of flags and qualifiers that can be displayed with 'Do $system.OBJ.ShowQualifiers()' and 'Do $system.OBJ.ShowFlags()'.

errorlog

errorlog is an array of the %Status error values encountered during the execution of this method. Each status value is in the format returned by $system.Status.DecomposeStatus.

The return value is a %Status value indicating success or failure.

• classmethod DeleteAll(qspec As %String = "") as %Status
Delete all the classes in this namespace.

Parameters

NameDescription
qspec

qspec is a list of flags and qualifiers that can be displayed with 'Do $system.OBJ.ShowQualifiers()' and 'Do $system.OBJ.ShowFlags()'.

The return value is a %Status value indicating success or failure.

• classmethod DeletePackage(package As %String = "", qspec As %String = "") as %Status
Delete all the classes within the specified package. Note that this ignores the '/mapped' qualifier as if you know the exact package name it is assumed you wish to delete it even if the package is mapped from another database.

Parameters

NameDescription
package

You can pass one or more comma separated packages in package argument. If package is '*' then all classes are deleted.

qspec

qspec is a list of flags and qualifiers that can be displayed with 'Do $system.OBJ.ShowQualifiers()' and 'Do $system.OBJ.ShowFlags()'.

The return value is a %Status value indicating success or failure.

• classmethod DeleteProject(project As %String = "", qspec As %String = "") as %Status
Delete the named project from this namespace.

Parameters

NameDescription
project

The name of the project to delete.

qspec

qspec is a list of flags and qualifiers that can be displayed with 'Do $system.OBJ.ShowQualifiers()' and 'Do $system.OBJ.ShowFlags()'.

The return value is a %Status value indicating success or failure.

• classmethod DisplayError(err As %Status = $get(%objlasterror)) as %Status
Decode and display an object error message to the console. If err is omitted, display the last generated object error.
• classmethod Dump(oref As %String = "") as %Status
Dump an object to the console.

Write the in-memory state of a object referred to by oref to the console (the current device).

	Set person = ##class(Person).%OpenId(22)
	Do $system.OBJ.Dump(person)
• classmethod Export(ByRef items As %String = "", ByRef filename As %String = "", qspec As %String = "", ByRef errorlog As %String, Charset As %String = "") as %Status
Export items as an XML file

Parameters

NameDescription
items

The items to export.

Each of the items must have a type determined by an extension selected from the following list of basic types, additional types are supported under the abstract routine interface so this list is not exhaustive.

  • CLS - Classes
  • CSP - Server Pages
  • CSR - Rule files
  • MAC - Macro routines
  • INT - Non-macro routines
  • BAS - Basic routines
  • INC - Include files
  • GBL - Globals
  • PRJ - Projects
  • OBJ - Compiled object code
  • PKG - Package definitions
If exporting multiple items, separate them with commas, pass the items("item")="" as an array. You can also use ? or * wild cards and if you wish to exclude items pass ' before the item name which also supports wild card, e.g. "User.*.cls,'User.T*.cls".

filename

If the output filename is empty, matching items will be exported to the current device.

qspec

qspec is a list of flags and qualifiers that can be displayed with 'Do $system.OBJ.ShowQualifiers()' and 'Do $system.OBJ.ShowFlags()'.


If you pass qualifier '/recursive=1' then it will also export any related, e.g. include files included by a class or a superclass, the idea being that this will be a compilable set of items. If the filename ends in .gz or .gzip then it will automatically gzip the file.

errorlog

errorlog is an array of the %Status error values encountered during the execution of this method. Each status value is in the format returned by $system.Status.DecomposeStatus.

Charset

The character set to use for this export. If not specified then the default is 'utf-8'.

The return value is a %Status value indicating success or failure.

• classmethod ExportAllClasses(ByRef filename As %String = "", qspec As %String = "", ByRef errorlog As %String, Charset As %String = "") as %Status
Export all the classes in this namespace as one large XML file.

This function will loop through all the classes exporting them to the file filename. It will restrict which classes are exported based on the qspec

Parameters

NameDescription
filename

The file where exported data will be placed.

qspec

qspec is a list of flags and qualifiers that can be displayed with 'Do $system.OBJ.ShowQualifiers()' and 'Do $system.OBJ.ShowFlags()'.


If you pass qualifier '/recursive=1' then it will also export any related, e.g. include files included by a class or a superclass, the idea being that this will be a compilable set of items. If the filename ends in .gz or .gzip then it will automatically gzip the file.

errorlog

errorlog is an array of the %Status error values encountered during the execution of this method. Each status value is in the format returned by $system.Status.DecomposeStatus.

Charset

The character set to use for this export. If not specified then the default is 'utf-8'.

The return value is a %Status value indicating success or failure.

• classmethod ExportAllClassesIndividual(dirname As %String = "", qspec As %String = "", ByRef errorlog As %String, Charset As %String = "", Package As %String = "*", SubDir As %Boolean = 0) as %Status
Export all the classes as individual XML files to a directory.

This function will loop through all the classes exporting each one as an individual XML file named after the classname to the directory dirname. If you specify a Package then it will only export this package. If SubDir is true then it will export sub-packages as subdirectories.

Parameters

NameDescription
dirname

The directory where exported files will be placed.

qspec

qspec is a list of flags and qualifiers that can be displayed with 'Do $system.OBJ.ShowQualifiers()' and 'Do $system.OBJ.ShowFlags()'.


If you pass qualifier '/recursive=1' then it will also export any related, e.g. include files included by a class or a superclass, the idea being that this will be a compilable set of items. If the filename ends in .gz or .gzip then it will automatically gzip the file.

errorlog

errorlog is an array of the %Status error values encountered during the execution of this method. Each status value is in the format returned by $system.Status.DecomposeStatus.

Charset

The character set to use for this export. If not specified then the default is 'utf-8'.

Package

If you specify a Package then it will only export this package.

Subdir

If SubDir is true then it will export sub-packages as subdirectories.

The return value is a %Status value indicating success or failure.

• classmethod ExportAllClassesToStream(ByRef stream As %Stream.Object = "", qspec As %String = "", ByRef errorlog As %String, Charset As %String = "") as %Status
Export all the classes in this namespace to a stream.

This function will loop through all the classes exporting them to a stream. It will restrict which classes are exported based on the qspec


Parameters

NameDescription
stream

If stream is passed in then the data is appended to this stream. If it is null when called it will create a stream and return this.

qspec

qspec is a list of flags and qualifiers that can be displayed with 'Do $system.OBJ.ShowQualifiers()' and 'Do $system.OBJ.ShowFlags()'.


If you pass qualifier '/recursive=1' then it will also export any related, e.g. include files included by a class or a superclass, the idea being that this will be a compilable set of items. If the filename ends in .gz or .gzip then it will automatically gzip the file.

errorlog

errorlog is an array of the %Status error values encountered during the execution of this method. Each status value is in the format returned by $system.Status.DecomposeStatus.

Charset

The character set to use for this export. If not specified then the default is 'utf-8'.

The return value is a %Status value indicating success or failure.

• classmethod ExportCPP(classname As %String = "", dirname As %String = "", qspec As %String = "", ByRef errorlog As %String) as %Status
Export a class to C++ files.

Export class classname to C++ files in directory dirname.

• classmethod ExportDynCPP(classname As %String = "", dirname As %String = "", proplist As %String = "", methodlist As %String = "", qspec As %String, ByRef errorlog As %String) as %Status
• classmethod ExportJava(classname As %String = "", dirname As %String = "", qspec As %String = "", ByRef errorlog As %String, ByRef paths="", ByRef Seen) as %Status
Export a class to a Java file.

Export class classname to a JAVA file in directory dirname.

• classmethod ExportJavaPackage(Package As %String = "", dirname As %String = "", qspec As %String = "", ByRef errorlog As %String, ByRef paths="") as %Status
Export classes in this package to Java.

Search for classes in the package and export them. The search for classes respects the qspec passed. If the package is "*" then it will search for all classes in this namespace.

Export class package to a JAVA file in directory dirname.

• classmethod ExportODL(classname As %String = "", filename As %String = "", qspec As %String = "", ByRef errorlog As %String) as %Status
Export a class to ODL file.

Export class classname to ODL file with file name filename.

• classmethod ExportPackage(package As %String = "", ByRef filename As %String = "", qspec As %String = "", ByRef errorlog As %String, Charset As %String = "") as %Status
Export a set of classes in a package as an XML file.

Export package package to an XML file with name filename.

• classmethod ExportPackageToStream(package As %String = "", ByRef stream As %Stream.Object = "", qspec As %String = "", ByRef errorlog As %String, Charset As %String = "") as %Status
Export a set of classes in a package in XML format to a stream.

Export package package to an XML file with name filename. If stream is passed in then the data is appended to this stream. If it is "" when called it will create a stream and return this.

• classmethod ExportPattern(pattern As %String = "", ByRef filename As %String = "", qspec As %String = "", ByRef errorlog As %String, Charset As %String = "") as %Status
Export all items matching a pattern to an XML file

If you pass a pattern of '*.cls' then all classes in this namespace will be exported, or a pattern of 'a*.mac' will export all MAC routines that start with the letter 'a' to be exported. If the filename ends in .gz or .gzip it will automatically gzip the file.

Parameters

NameDescription
pattern

The pattern used to construct a list of items to be exported.

filename

If the output filename is empty, matching items will be exported to the current device.

qspec

qspec is a list of flags and qualifiers that can be displayed with 'Do $system.OBJ.ShowQualifiers()' and 'Do $system.OBJ.ShowFlags()'.


If you pass qualifier '/recursive=1' then it will also export any related, e.g. include files included by a class or a superclass, the idea being that this will be a compilable set of items. If the filename ends in .gz or .gzip then it will automatically gzip the file.

errorlog

errorlog is an array of the %Status error values encountered during the execution of this method. Each status value is in the format returned by $system.Status.DecomposeStatus.

Charset

The character set to use for this export. If not specified then the default is 'utf-8'.

The return value is a %Status value indicating success or failure.

• classmethod ExportPatternToStream(pattern As %String = "", ByRef stream As %Stream.Object = "", qspec As %String = "", ByRef errorlog As %String, Charset As %String = "") as %Status
Export all items matching a pattern in XML format to a stream

If you pass a pattern of '*.cls' then all classes in this namespace will be exported, or a pattern of 'a*.mac' will export all MAC routines that start with the letter 'a' to be exported.

Parameters

NameDescription
pattern

The pattern used to construct a list of items to be exported.

stream

If stream is passed in then the data is appended to this stream. If it is "" when called it will create a stream and return this.

qspec

qspec is a list of flags and qualifiers that can be displayed with 'Do $system.OBJ.ShowQualifiers()' and 'Do $system.OBJ.ShowFlags()'.


If you pass qualifier '/recursive=1' then it will also export any related, e.g. include files included by a class or a superclass, the idea being that this will be a compilable set of items. If the filename ends in .gz or .gzip then it will automatically gzip the file.

errorlog

errorlog is an array of the %Status error values encountered during the execution of this method. Each status value is in the format returned by $system.Status.DecomposeStatus.

Charset

The character set to use for this export. If not specified then the default is 'utf-8'.

The return value is a %Status value indicating success or failure.

• classmethod ExportToStream(items As %String = "", ByRef stream As %Stream.Object = "", qspec As %String = "", ByRef errorlog As %String, Charset As %String = "") as %Status
Export items in XML format to a stream

Parameters

NameDescription
items

The items to export.

Each of the items must have a type determined by an extension selected from the following list of basic types, additional types are supported under the abstract routine interface so this list is not exhaustive.

  • CLS - Classes
  • CSP - Cache Server Pages
  • CSR - Cache Rule files
  • MAC - Macro routines
  • INT - Non-macro routines
  • BAS - Basic routines
  • INC - Include files
  • GBL - Globals
  • PRJ - Studio projects
  • OBJ - Compiled object code
  • PKG - Package definitions
If exporting multiple items, separate them with commas, pass the items("item")="" as an array. You can also use ? or * wild cards and if you wish to exclude items pass ' before the item name which also supports wild card, e.g. "User.*.cls,'User.T*.cls".

stream

The stream in which to place exported items.

qspec

qspec is a list of flags and qualifiers that can be displayed with 'Do $system.OBJ.ShowQualifiers()' and 'Do $system.OBJ.ShowFlags()'.


If you pass qualifier '/recursive=1' then it will also export any related, e.g. include files included by a class or a superclass, the idea being that this will be a compilable set of items. If the filename ends in .gz or .gzip then it will automatically gzip the file.

errorlog

errorlog is an array of the %Status error values encountered during the execution of this method. Each status value is in the format returned by $system.Status.DecomposeStatus.

Charset

The character set to use for this export. Note that if you pass in a Charset and also pass in a character stream we will not use the Charset unless the stream is a file character stream. The reason for this is a character stream deals with characters so Charset is only about binary representations of character data. In this specific case of a file character stream we will set the TranslateTable on the file stream to the Charset.

The return value is a %Status value indicating success or failure.

• classmethod ExportUDL(itemname As %String = "", filename As %String = "", qspec As %String = "", ByRef errorlog As %String, Charset As %String = "") as %Status
Export a class or routine in UDL format.

Export document itemname to file filename in UDL format.

• classmethod GetClassList(ByRef items As %String, qspec As %String = "") as %Status
Return an array of classes in this namespace.

Search for classes in this namespace and put their names into the local array items. qspec is a list of flags or qualifiers which can be displayed with 'Do $system.OBJ.ShowQualifiers()' and 'Do $system.OBJ.ShowFlags()'. The search for classes respects the qspec passed. It uses the following qualifiers

  • /application=1/0 - Include application classes
  • /system=1/0 - Include system classes (ones with class attribute 'system' set to something other than zero)
  • /percent=1/0 - Include percent classes
  • /mapped=1/0 - Include classes mapped from other databases or just classes in default databases
• classmethod GetConcurrencyMode() as %Integer
Return the current Object Concurrency mode.
• classmethod GetDependencies(ByRef class As %String, Output included As %String, qspec As %String) as %Status
This will return a list of classes the class compiler will include if the listed classes are compiled. The class can be a single class, a comma separated list, a subscripted array of class names. You can also use ? or * wild cards and if you wish to exclude items pass ' before the item name which also supports wild card, e.g. "User.*,'User.T*". It returns the list of classes that will be compiled in included based on the compile qspec.
• classmethod GetPackageList(ByRef items As %String, package As %String, qspec As %String = "") as %Status
Return an array of classes in this package.

Search for classes in the package and put their names into the local array items. If the package is "*" then it will return for all classes in this namespace. It uses the qualfier in qspec /includesubpackages to determine if it searches inside a package to subpackages or not. qspec is a list of flags or qualifiers which can be displayed with 'Do $system.OBJ.ShowQualifiers()' and 'Do $system.OBJ.ShowFlags()'.

• classmethod GetQualifiers(system As %Boolean = 0) as %String
Get the default qualifiers for this namespace or this system. If system is true then this gets the default qualifiers for this system, otherwise it sets the default qualifiers for this namespace.
• classmethod GetTransactionMode() as %Integer
Return the current Object transaction mode.
• classmethod ImportDir(dir As %String = "", wildcards As %String, qspec As %String = "", ByRef errorlog As %String, recurse As %Boolean = 0, ByRef imported As %String, listonly As %Boolean, ByRef selectedlist As %String)
Import and optionally compile all items in a directory.

This will import all files found in a directory using the Load method so it should be able to detect most common formats. If you pass it the compile flag ('c'), after loading it will also compile all these items. The other flags are the same as found in Load except for the dir which is the directory to load and the recurse which determines if this will look into subdirectories or not.
You can limit the items it will import by specifying a wildcards value. For example '*.xml' will only import files that end in XML.
qspec is a list of flags or qualifiers which can be displayed with 'Do $system.OBJ.ShowQualifiers()' and 'Do $system.OBJ.ShowFlags()'.

• classmethod IsUpToDate(class As %String, log As %Boolean = 0, type As %Integer = 1) as %Boolean
Return if this class is up to date or not. If log is true then it will display a log of what it is checking in order to show if it is up to date or not. The type determines what it looks at to see if this class is up to date:
  • 0 - Check timestamps on class, so even if a description was modified this will show the class as out of date
  • 1 - Ignore changes to descriptions in checking up to date status, this is the default and is what the class compiler typically uses.
  • 2 - Ignore changes to descriptions and method code in checking up to date status, this is useful to see if the class has 'structurally' changed in a way that would require a class referencing this via SQL to be recompiled
• classmethod IsValidClassname(class As %String) as %Status
Return $$OK if this class name is valid, or an error message if it is not. If it is invalid it is typically because it contains characters that are not allowed in a class name or because it clashes with a class that already exists (different case in package say).
• classmethod Load(file As %String = "", qspec As %String = "", ByRef errorlog As %String, ByRef loadedlist As %String, listonly As %Boolean, selecteditems As %String, displayname As %String, charset As %String = "", ByRef description As %String) as %Status
Load a file from disk.

Load, and optionally compile (if 'c' flag is present), class definitions, CSP pages, routines, or globals from the file file. file may be a list of files to load separated with '*' symbols.
You can import files exported in XML format, %RO format, CDL format, UDL format, %GOF, and CSR/CSP files.
A comma separated list of the items it loaded is returned in loadedlist. If the list is too long to fit in the variable, it is terminated with '...'. Items loaded are always returned as subscripts of the loadedlist array.
If you pass listonly as true then it will not import anything but just list the items that exist in file.
If selecteditems is defined then this will contain either a comma separated list of items to import or a single subscripted array. It will only import items that are in this list from the file provided, so this provides a way to limit which items get imported.
qspec is a list of flags or qualifiers which can be displayed with 'Do $system.OBJ.ShowQualifiers()' and 'Do $system.OBJ.ShowFlags()'.
When loading a %RO file the description variable will be filled in with the description from the %RO file if there is one present.
errorlog is an array of the %Status return values from this call, in the format returned by $system.Status.DecomposeStatus.
The displayname is normally not provided. If present it changes the 'load file XYZ' name from the filename to the displayname. This is useful when loading a stream where the stream filename is not the name of the file the user knows from a client system and we want to present a meaningful name.
If the filename ends in .gzip or .gz then we ungzip this file before loading it.

• classmethod LoadDir(dir As %String = "", qspec As %String = "", ByRef errorlog As %String, recurse As %Boolean, ByRef loadedlist As %String) as %Status
Load all class definitions in a directory.

Load and optionally compile (if 'c' flag is present) all class definitions within directory dir, this includes all .XML files. If the recurse is true then it will include subdirectories. Returns a comma separated list of the items it loaded in loadedlist and the same data also as loadedlist(name)="" in case the comma list is more than 32k. Note that this will only compile classes found in these XML files and no other types. If you want to be able to compile anything use the ImportDir.
qspec is a list of flags or qualifiers which can be displayed with 'Do $system.OBJ.ShowQualifiers()' and 'Do $system.OBJ.ShowFlags()'.

• classmethod LoadLanguage(language As %String = "", qspec As %String = "") as %Status
Import the system messages for the specified language from ...\mgr\Locale\allmessages_[language].xml and make this the current language. If language is not specified, then Upgrade the Object locale and import the current language.
• classmethod LoadStream(stream As %AbstractStream, qspec As %String = "", ByRef errorlog As %String, ByRef loadedlist As %String, listonly As %Boolean, selecteditems As %String, displayname As %String, charset As %String = "") as %Status
Load a stream.

Load and, optionally compile (if 'c' flag is present), class definitions, CSP pages, routines or globals from the stream stream. Returns an array of the items it loaded in loadedlist. If you pass listonly as true then it will not import anything but just list the items that exist in the stream that you supply.
If selecteditems is defined then this will contain a comma separated list of items to import (or a single subscripted array). It will only import items that are in this list from the stream provided, so this provides a way to limit which items get imported.
qspec is a list of flags or qualifiers which can be displayed with 'Do $system.OBJ.ShowQualifiers()' and 'Do $system.OBJ.ShowFlags()'.

• classmethod MakeClassDeployed(ByRef classes As %String = "", qspec As %String = "", fulldeploy As %Boolean = 0) as %Status
Make a class or classes deployed. classes can be a single class, a comma separated list, a subscripted array of class names. You can also use ? or * wild cards and if you wish to exclude items pass ' before the item name which also supports wild card, e.g. "User.*,'User.T*". This will delete all the source code of the class from the disk. Once a class is in deployed mode, it can not be edited or exported or recompiled. You can still create subclasses of a deployed class and compile these. qspec is a list of flags or qualifiers which can be displayed with 'Do $system.OBJ.ShowQualifiers()' and 'Do $system.OBJ.ShowFlags()'. If fulldeploy is true it will attempt to remove pretty much the entire class definition leaving just the minimum so the class is runnable, this will not work on persistent, serial, datatype, or XML enabled classes as these require access to the class definition at runtime in order to function. Note that for a class to be deployed it must be compiled, if you try to deploy a class which is not compiled it will report an error.
• classmethod New(ClassName As %String = "") as %ObjectHandle
Create a new object instance.

Create a new object instance of type ClassName and return a reference (OREF) to it.

Using this method, you can dynamically create objects, that is you can determine what type of object to create at run-time.

For example:

	Set obj = $System.OBJ.New("Person")
• classmethod ObjectListClose(QHandle As %Binary) as %Status
• classmethod ObjectListExecute(ByRef QHandle As %Binary) as %Status
• classmethod ObjectListFetch(ByRef QHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
• classmethod Open(ClassName As %String = "", oid As %String = "") as %ObjectHandle
Open a persistent object instance.

Load persistent object instance of type ClassName and with OID value oid from disk and return a reference (OREF) to it.

For example:

	Set person = $System.OBJ.Open("Person",oid)
• classmethod OpenId(ClassName As %String = "", id As %String = "") as %ObjectHandle
Open a persistent object instance.

Load persistent object instance of type ClassName and with ID value id from disk and return a reference (OREF) to it.

For example:

	Set person = $System.OBJ.OpenId("Person",22)
• classmethod RebuildExtentIndex(updateMode As %Boolean = 0, lockMode As %Integer = 1) as %Status

The Extent Index is an index on all persistent classes that are runnable in the current namespace. It is currently used by %BuildIndices, %KillExtent, and the %FindGUID utility function in %Library.GUID. Other uses may be added at a later time.

The index is maintained in the globals database in the current namespace. If the globals database in the current namespace is readonly then an error will be returned. The class compiler automatically maintains this index for classes compiled in the namespace. Classes mapped from other namespaces are not automatically added to or removed from the index when mapping changes or changes to the class runtime occur in the original namespace. Such changes must be updated in the local namespace's extent index by running a utility function. There are two functions, this function will rebuild the index completely and RebuildExtentIndexOne will rebuild the index entries for only the specified class.

This function returns a status value indicating success or failure.

Parameters

NameDescription
updateMode

If zero then the extent index is purged and rebuilt completely. Otherwise, the existing index is checked against existing defintions and only changed classes are rebuilt.

lockMode

Specifies the type of locking to be used while modifying the index. If the requested locks cannot be obtained then an error is reported to the caller.

0No locking;
1Exclusive lock on the entire extent index, released immediately on completion;
2The nodes for each class in the extent index are locked during update, released immediately when class's index entries are built;
3Shared lock on the entire extent index, released immediately on completion.

The return value is a %Status value indicating success or failure.

• classmethod RebuildExtentIndexOne(className, lockMode As %Integer = 1) as %Status

This function updates the extent index for the specified class in the current namespace. If the globals database in the current namespace is readonly then an error will be returned. Call this function to rebuild the extent index for a single class in the current namespace. Refer to RebuildExtentIndex for more information.

This function returns a status value indicating success or failure.

Parameters

NameDescription
className

The name of the class to be indexed.

lockMode

Specifies the type of locking to be used. If the requested locks cannot be obtained then an error is reported to the caller.

0No locking;
1The nodes for each class in the extent index are locked during update, released immediately when class's index entries are built;
2The nodes for each class in the extent index are locked during update, released immediately when class's index entries are built;
3Shared lock on the class nodes in the extent index, released immediately on completion.

The return value is a %Status value indicating success or failure.

• classmethod RedirectBindSrvUserOutput(val As %Boolean)
Turn output redirection on and off in the binding server.
• classmethod SaveObjects() as %Status
Save all instances of %Library.Persistent in the process. Returns a status value.
• classmethod SetConcurrencyMode(value As %Integer = 1, ByRef pStatus As %Library.Status) as %Integer
Set the Object concurrency mode for the current process to a new value. Valid values are:

0No concurrency controls
1Atomic
2Shared
3Shared retained
4Exclusive
If a valid value is passed in then the concurrency mode for the current process will be set to that value and the previous concurrency mode value is returned. Otherwise the concurrency mode setting is left unchanged and pStatus will contain a %Status value describing the error and the current concurrency mode value is returned.

• classmethod SetFlags(flags As %String, system As %Boolean = 0) as %String
Set the default flags for this namespace or this system. If system is true then this sets the default flags for this system, otherwise it sets the default flags for this namespace. If flags are set for this namespace these override any set for the system. These flags are combined with the built in defaults to create the defaults used. This method returns the new defaults after this change.
• classmethod SetQualifiers(qspec As %String = "", system As %Boolean = 0, group As %String) as %Status
Set the default qualifiers for this namespace or this system. If system is true then this sets the default qualifiers for this system, otherwise it sets the default qualifiers for this namespace. If qualifiers are set for this namespace these override any set for the system. These qualifiers are combined with the built in defaults to create the defaults used. The argument group has been deprecated.
• classmethod SetTransactionMode(value As %Integer = 1, ByRef pStatus As %Library.Status) as %Integer
Set the object transaction mode for the current process to a new value. Valid values are:

0No transactions used for Object filing
1Use transactions for Object filing
If a valid value is passed in then the transaction mode for the current process will be set to that value and the previous transaction mode value is returned. Otherwise the transaction mode setting is left unchanged and pStatus will contain a %Status value describing the error and the current transaction mode value is returned.

• classmethod ShowClasses(qspec As %String = "") as %Status
Write all classes defined in this namespace to the console.

The optional qspec argument is a qualifier string containing any of the following options:
/detailShow details.
/hiddenShow hidden classes.
/mappedShow mapped classes.

For example:

	Do $System.OBJ.ShowClasses("/detail")
• classmethod ShowFlags()
Display the list of flags used by the compiler. Should use ShowQualifiers as flags have been superseded by qualifiers.
• classmethod ShowMacros()
Display the list of supported macros defined in the system.
• classmethod ShowObjects(qspec As %String = "") as %Status
Write all object instances in this process to the console.

The optional qspec argument is a string containing any of the following characters:
/detail=1Show details.

For example:

	Do $System.OBJ.ShowObjects("/detail=1")
• classmethod ShowQualifiers(group As %String = "")
Display the list of qualifiers defined in the system. It also shows the default qualifiers defined at system level and at namespace levels. The argument group has been deprecated.
• classmethod ShowReferences(oref As %String, chkObj As %Boolean = 0)
Display a list of all variables that contain a reference to this oref. If chkObj is set to 1, the properties of any varibles that contain an object reference will also be searched and displayed. Otherwise only non-object variables will be searched.
The list has the base $STACK level of the variable, the internal stack level (as shown by the %STACK utility), and the variable name.
• classmethod UnCompile(ByRef classes As %String = "", qspec As %String = "") as %Status
Uncompile a class or classes. classes can be a single class, a comma separated list, a subscripted array of class names. You can also use ? or * wild cards and if you wish to exclude items pass ' before the item name which also supports wild card, e.g. "User.*,'User.T*". qspec is a list of flags or qualifiers which can be displayed with 'Do $system.OBJ.ShowQualifiers()' and 'Do $system.OBJ.ShowFlags()'.
• classmethod UpdateConfigParam(classname As %String, parameter As %String, value As %String) as %Status
Allows updating a CONFIGVALUE parameter type. If you have defined a parameter in the classname which is specified as 'CONFIGVALUE' in the type keyword then this function allows this to be updated from the original value to a new value. Note that this should be a rare event and not be used for any value that needs to be updated a lot, a global should be used for a rapidly updating value. The advantage of using a class parameter for a configuration value is that a very large number of processes can access this value using 'Set val=##class(ClassName).#ParamName' faster than access to a global.
• classmethod Upgrade(qspec As %String = "", ByRef errorlog As %String) as %Status
Upgrade the class definition database in one namespace.
• classmethod UpgradeAll(qspec As %String = "", ByRef errorlog As %String) as %Status
Upgrade the class definition database in all the namespaces.
• classmethod ValidateIndices(classname As %Library.String, idxList As %String = "", autoCorrect As %Boolean = 0, lockOption As %Integer = 1, multiProcess As %Boolean = 0) as %Library.Status
Validate indices for a class

Parameters:
classname
Name of the persistent class to validate indices for.
idxList
Optional. "" to check all indices, or specify a $list of index names to check. Default=""
autoCorrect
Optional. If true, correct any errors found. Default=0
lockOption
Optional. Default = 1 0 - No locking is performed at all 1 - Shared locking as each row is checked 2 - exclusive lock on entire table for duration of the run
multiProcess
Optional. If true, parts of %ValidateIndices will use parallel processing when possible. Default=0

Returns:

Status Code

Example:

  • Do $SYSTEM.OBJ.ValidateIndices("Sample.Person","",1,2)
  • Do $SYSTEM.OBJ.ValidateIndices("Sample.Company",$lb("NameIdx"),1,1)
  • Note::
    Indices may also be validated by calling the class method ##class(classname).%ValidateIndices(idxList,autoCorrect,lockOption).
    There is one main difference between validating indices through $SYSTEM.OBJ.ValidateIndices() and ##class(classname).%ValidateIndices().
    $SYSTEM.OBJ.ValidateIndices() will validate the indices for a table, and it will also validate any indices in collection child tables for that table.
    When using ##class(classname).%ValidateIndices(), collection child table indices must be checked with separate calls.
    Also, when calling $SYSTEM.OBJ.ValidateIndices(), multiProcess default is 0. When calling ##class(classname).%ValidateIndices(), multiProcess default is 1.

    • classmethod Version() as %String
    Return the version number of the current object library.

    Queries

    • query CompileInfo(sortorder As %Integer = 0)
    Selects Name As %String, Version As %String, Time As %TimeStamp
    Query to return version and time when classes were compiled. This only returns compiled classes, so classes not compiled are skipped. The sortorder can be one of:
    • 0 - Time class was compiled (default)
    • 1 - Classname
    • 2 - InterSystems IRIS version
    • query ObjectList()
    Selects OREF As %Integer, ClassName As %String
    This query returns a list of all object instances currently in memory within the current process.


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