Home > Class Reference > %SYS namespace > %ZHSLIB.PackageManager.Developer.Utils

%ZHSLIB.PackageManager.Developer.Utils

class %ZHSLIB.PackageManager.Developer.Utils

Method Inventory

Methods

classmethod AddGlobalMapping(pNamespace As %String, pMapping As %String, pFrom As %String, pSetCollation As %Boolean = 0, pSkipActivation As %Boolean = 0, ByRef pChanged As %Boolean = 0) as %Status [ Language = objectscript ]
classmethod AddPackageMapping(pNamespace As %String, pMapping As %String, pFrom As %String, pSkipActivation As %Boolean = 0) as %Status [ Language = objectscript ]
classmethod AddRoutineMapping(pNamespace As %String, pMapping As %String, pType As %String = "ALL", pFrom As %String, pSkipActivation As %Boolean = 0) as %Status [ Language = objectscript ]
classmethod BeginCaptureOutput(Output pCookie As %String) as %Status [ Language = objectscript ]
This method enables I/O redirection (see EndCaptureOutput for retrieval). pCookie has the previous I/O redirection info.
classmethod CheckLicenseKey() as %Boolean [ Language = objectscript ]
classmethod CopyItems(itemspec, source, target, qspec) [ Language = objectscript ]
This method exports items (classes, routines, etc.) and reloads it into a different namespace The syntax for itemspec is the Name attribute in tag and tag
classmethod EndCaptureOutput(pCookie As %String, Output pText) as %Status [ Language = objectscript ]
This method captures the output from a program and delivers it as an array of lines
classmethod GetDatabaseDirectory(pDatabase As %String) as %String [ Language = objectscript ]
classmethod GetDependentsAsTree(Output pTree, Output pErrorList, pModuleName As %String, pModuleVersion As %String = "", pRepoNames As %List = "") as %Status [ Language = objectscript ]
Returns a tree of dependents, with dependent modules at the root, for a given module name (and optional version)
pRepoNames is a $ListBuild list of repositories in which to search for dependents; if blank, only currently-installed modules (and any missing dependencies) are considered.
Tree subscripts are $lb(Name,VersionString,ServerName).
@API.Method @Modifier Availability InterSystems
classmethod GetDependentsList(Output pList As %Library.ListOfObjects(ELEMENTTYPE="%ZHSLIB.PackageManager.Core.QualifiedModuleReference"), Output pErrorList, pModuleName As %String, pModuleVersion As %String = "", pRepoNames As %List = "") as %Status [ Language = objectscript ]
Returns a flat list of dependents for a given module name (and optional version)
pRepoNames is a $ListBuild list of repositories in which to search for dependents; if blank, only currently-installed modules (and any missing dependencies) are considered.
@API.Method @Modifier Availability InterSystems
classmethod GetGlobalDatabase(pNamespace As %String) as %String [ Language = objectscript ]
classmethod GetGlobalDatabaseDir(pNamespace As %String) as %String [ Language = objectscript ]
classmethod GetModuleListClose(ByRef qHandle As %Binary) as %Status [ Language = objectscript ]
classmethod GetModuleListExecute(ByRef qHandle As %Binary, pServer As %String) as %Status [ Language = objectscript ]
classmethod GetModuleListFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status [ Language = objectscript ]
classmethod GetRequiredVersionExpression(pModuleName As %String, pExcludeModules As %List = "", Output pExpression As %ZHSLIB.PackageManager.Core.SemanticVersionExpression, Output pSourceList As %List) as %Status [ Language = objectscript ]
Returns a semantic version expression capturing all version requirements for a given module name in the current namespace. A list of modules to exclude may be provided (for example, if these modules would be updated at the same time).
classmethod GetRoutineDatabase(pNamespace As %String) as %String [ Language = objectscript ]
classmethod GetRoutineDatabaseDir(pNamespace As %String) as %String [ Language = objectscript ]
classmethod LoadCompleted(pServerName As %String, pModuleName As %String, pVersion As %String, ByRef pParams, ByRef pDependencyGraph) as %Status [ Language = objectscript ]
Intended to be invoked only as a work queue callback (so %status and %workqueue will be defined) Signature must match LoadModuleReference() per work queue manager conventions.
classmethod LoadDependencies(ByRef pDependencyGraph, ByRef pParams, pWorkQueue As %ZHSLIB.PackageManager.Core.WorkMgr) [ Language = objectscript ]
Format of pDependencyGraph: pDependencyGraph("module name") = $ListBuild(,,) pDependencyGraph("module name"," ") =
classmethod LoadModuleFromArchive(pModuleName As %String, pModuleVersion As %String, pArchiveStream As %Stream.Object, ByRef pParams) as %Status [ Language = objectscript ]
classmethod LoadModuleFromDirectory(pDirectory As %String, ByRef pParams, pOverrideDeveloperMode As %Boolean = 0) as %Status [ Language = objectscript ]
classmethod LoadModuleReference(pServerName As %String, pModuleName As %String, pVersion As %String, ByRef pParams, ByRef pDependencyGraph) as %Status [ Language = objectscript ]
classmethod LoadNewModule(pDirectory As %String, ByRef pParams) as %Status [ Language = objectscript ]
classmethod LoadQualifiedReference(pReference As %ZHSLIB.PackageManager.Core.QualifiedModuleReference, ByRef pParams, ByRef pDependencyGraph) as %Status [ Language = objectscript ]
classmethod LockWithCurrentDependencies(pModuleName As %String) as %Status [ Language = objectscript ]
Short-term approach to lock a module's dependencies within the module manifest (rather than using a separate file).
classmethod NamespaceHasModule(pNamespace As %String, pModuleName As %String) as %Boolean [ Language = objectscript ]
Helper method to see if pNamespace has pModule (a module name) installed. Returns false if the module is not installed (which may be because the namespace does not exist).
classmethod OrphanedResourcesClose(ByRef qHandle As %Binary) as %Status [ Language = objectscript ]
classmethod OrphanedResourcesExecute(ByRef qHandle As %Binary, pNamespace As %String = $Namespace, pType As %String = "") as %Status [ Language = objectscript ]
classmethod OrphanedResourcesFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status [ Language = objectscript ]
classmethod RemoveGlobalMapping(pNamespace As %String, pMapping As %String = "", pSkipActivation As %Boolean = 0, ByRef pChanged As %Boolean = 0) as %Status [ Language = objectscript ]
classmethod RemovePackageMapping(pNamespace As %String, pMapping As %String, pSkipActivation As %Boolean = 0) as %Status [ Language = objectscript ]
classmethod RemoveRoutineMapping(pNamespace As %String, pMapping As %String, pType As %String = "ALL", pSkipActivation As %Boolean = 0) as %Status [ Language = objectscript ]
classmethod ResolveItems(itemlist, itemspec, namespace) as %Status [ Language = objectscript ]
This method resolves itemspec used by Name sttribute in and
classmethod UninstallAll(pForce As %Boolean, ByRef pParams) as %Status [ Language = objectscript ]
Uninstalls all modules from the current namespace

Queries

query GetModuleList(pServer As %String)
Selects Name As %String, Version As %String
query OrphanedResources(pNamespace As %String = $Namespace, pType As %String = "")
Selects Name As %String
FeedbackOpens in a new window