abstract persistent class %IPM.Repo.Definition
extends %Persistent, %ZEN.DataModel.Adaptor, %IPM.CLI.Commands
• parameter DEFAULTGLOBAL = "^IPM.Repo.Definition";
If a persistent class uses %Storage.Persistent then the DEFAULTGLOBAL parameter is used as the
default global root for the values of the storage keywords COUNTERLOCATION, DATALOCATION, IDLOCATION,
INDEXLOCATION and STREAMLOCATION in the active storage definition. DEFAULTGLOBAL is only used
to generate location keyword values that are not already defined. The location value is constructed by adding
a location type to the end of DEFAULTGLOBAL. For example, if DEFAULTGLOBAL = "^GL.Account"
the compiler will generate DATALOCATION = ^GL.AccountD.
If USEEXTENTSET is true, then DEFAULTGLOBAL is used as the default extent location.
The location types are:
| Location | Type |
|---|
| COUNTERLOCATION | C |
| DATALOCATION | D |
| IDLOCATION | D |
| INDEXLOCATION | I |
| STREAMLOCATION | S |
• parameter DISPLAYNAME;
Display name for this type of repository, shown in the UI and package manager shell.
• parameter DOMAIN = "ZPM";
Localization domain.
DataModel classes that wish to support localization must provide a value for this
within subclasses.
• parameter MONIKER;
Short/logical name for this type of repository, used in the package manager shell as an alternative to the full class name.
• parameter MONIKERALIAS;
• property Details
as %String(MAXLEN="");
• property Enabled
as %Boolean [ InitialExpression = 1 ];
• property Name
as %String(MAXLEN=100) [ Required ];
• property Prereleases
as %Boolean [ InitialExpression = 0 ];
• property ReadOnly
as %Boolean [ InitialExpression = 0 ];
Boolean flag indicating that modules installed from this repository
are ALWAYS installed in non-developer mode.
• property Snapshots
as %Boolean [ InitialExpression = 0 ];
• classmethod %GetCommandStructure(Output pCommandStructure)
• classmethod CatalogClose(ByRef qHandle As %Binary)
as %Status
• classmethod CatalogExecute(ByRef qHandle As %Binary)
as %Status
• classmethod CatalogFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0)
as %Status
• classmethod CollectServerTypes(Output types)
as %Status
• final classmethod Configure(pInteractive As %Boolean = 1, ByRef pModifiers, ByRef pData, pExpectedType As %Dictionary.Classname = "")
as %Status
Called from package manager shell to create or update an instance of this class.
Acceptable values in pModifiers and pData may vary between classes, but
some (such as "name", "enabled", "snapshots", and "prereleases") are common to all.
For a full list of modifiers, see the Commands XDATA block in %IPM.Main.
If specified, pExpectedType will be compared against the full classname of the existing
instance matched by pModifiers("name"); an error will be returned if they do not match.
• method Display()
Outputs information about this server to the current device.
Subclasses may override to show additional information, but should typically call ##super() at the beginning.
• abstract method GetPackageService()
as %IPM.Repo.IPackageService
Returns a client to interact with this server.
• abstract method GetPublishService()
as %IPM.Repo.IPublishService
Returns a client to publish modules/applications to this server.
If publishing modules/applications is not supported, returns $$$NULLOREF.
Errors are thrown as exceptions.
• abstract classmethod OnConfigure(pInstance As %IPM.Repo.Definition, pInteractive As %Boolean = 1, ByRef pModifiers, ByRef pData)
as %Status
Subclasses must override. Allows handling of any custom modifiers/data attributes provided from the package manager shell.
• classmethod SortOrder(pID As %String)
as %Integer
[ SQLProc = ]
• query Catalog()
Selects
Classname As %String, Moniker As %String, Description As %String
• query List()
SQL Query
:
SELECT Name FROM %IPM_Repo.Definition
ORDER BY %IPM_Repo.Definition_SortOrder(ID) DESC
•index (ServerDefinitionKey on Name) [Unique];
