abstract class %IPM.General.ModuleInfo
extends %XML.Adaptor, %IPM.JSON.Adaptor
Most basic information that EVERY module must have.
• parameter NAMESPACE = "http://www.intersystems.com/PackageManager";
NAMESPACE specifies the XML namespace to be used when projecting the
class to XML. If NAMESPACE = "", the default namespace is used for the XML schema
is used as the namespace for his class.
• parameter XMLIGNOREINVALIDATTRIBUTE = 1;
The XMLIGNOREINVALIDATTRIBUTE parameter allows the programmer to control handling of unexpected
attributes in the XML input.
By default (XMLIGNOREINVALIDATTRIBUTE = 1), will ignore unexpected attributes.
If XMLIGNOREINVALIDATTRIBUTE is set = 0, then an unexpected attribute will be treated as an error.
• parameter XMLIGNOREINVALIDTAG = 1;
The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected
elements in the XML input.
The XMLIGNOREINVALIDTAG parameter will only take affect if XMLSEQUENCE = 0 (the default).
By default (XMLIGNOREINVALIDTAG = 0), will treat an unexpected element as an error.
If XMLIGNOREINVALIDTAG is set = 1 and XMLSEQUENCE = 0, then unexpected elements will be ignored.
• property AllVersions
as %String(%JSONINCLUDE="NONE",MAXLEN="",XMLPROJECTION="NONE") [ Transient ];
• property Deployed
as %Boolean(%JSONFIELDNAME="deployed",XMLNAME="Deployed");
• property Description
as %String(%JSONFIELDNAME="description",MAXLEN=1000);
• property DisplayName
as %IPM.DataType.ModuleName(%JSONFIELDNAME="name",XMLNAME="Name");
Case-sensitive display name of the module as it appears in the module manifest
• property Name
as %IPM.DataType.ModuleName(%JSONINCLUDE="NONE",XMLPROJECTION="NONE") [ Required ];
lowercase storage name of the module
• property Origin
as %String;
• property PlatformVersion
as %String(%JSONFIELDNAME="platform_version",MAXLEN=10,XMLNAME="PlatformVersion");
Version of IRIS for Deployed modules
• property Repository
as %String(MAXLEN="",XMLPROJECTION="NONE");
The repository from which this module was loaded.
Is "" if the module was loaded using the load command (i.e. directly from a file and not from a repository).
• property Version
as %IPM.General.SemanticVersion(%JSONINCLUDE="NONE",XMLPROJECTION="NONE") [ Required ];
• property VersionString
as %String(%JSONFIELDNAME="version",MAXLEN=100,XMLNAME="Version") [ Required ];
• method DisplayNameSet(val As %String)
as %Status
This is a Set accessor method for the DisplayName property.
• method NameSet(val As %String)
as %Status
This is a Set accessor method for the Name property.
• method VersionStringGet()
as %String
This is a Get accessor method for the VersionString property.
• method VersionStringSet(tValue)
as %Status
This is a Set accessor method for the VersionString property.
Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.
