This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > %SYS namespace > %Dictionary.PackageDefinition

%Dictionary.PackageDefinition

persistent class %Dictionary.PackageDefinition extends %Library.Persistent, %Dictionary.PackageDefinitionQuery

SQL Table Name: %Dictionary.PackageDefinition

This class represents a specific package description contained within the Caché Dictionary.

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties (Including Private)

property ClientName as %CacheString;
A string containing the client name for the package.
Property methods: ClientNameGet(), ClientNameIsValid(), ClientNameSet()
property Description as %CacheString;
A string containing the description of the package.
Property methods: DescriptionGet(), DescriptionIsValid(), DescriptionSet()
property GlobalPrefix as %CacheString;
A string containing the global prefix of the package, used for data, id, and index locations.
Property methods: GlobalPrefixGet(), GlobalPrefixIsValid(), GlobalPrefixSet()
property Name as %CacheString;
A string containing the name of the package.
Property methods: NameGet(), NameIsValid(), NameSet()
property OwnerName as %CacheString;
A string containing the Owner's name of the package.
Property methods: OwnerNameGet(), OwnerNameIsValid(), OwnerNameSet()
property RtnPrefix as %CacheString;
A string containing the routine prefix of the package.
Property methods: RtnPrefixGet(), RtnPrefixIsValid(), RtnPrefixSet()
property SQLName as %CacheString;
A string containing the SQL name of the package.
Property methods: SQLNameGet(), SQLNameIsValid(), SQLNameSet()
property list as %ListOfDataTypes [ Transient ];
Property methods: listGet(), listGetObject(), listGetObjectId(), listGetSwizzled(), listIsEmpty(), listIsValid(), listNewObject(), listSet(), listSetObject(), listSetObjectId(), listUnSwizzle()

Methods (Including Private)

private classmethod %DeleteData(id As %String, concurrency As %Integer) as %Status
Inherited description: This method is normally generated by the storage class for persistent classes using %Library.CacheStorage or %Library.CacheSQLStorage. Persistent classes using some other storage class, such as %Library.CustomStorage must override this method.
private method %LoadData(id As %String) as %Status
Inherited description: %LoadData() - loads an object from storage. This method is implemented by the storage class.
private method %OnNew(initvalue As %String) as %Status
Inherited description: This callback method is invoked by the %New() method to provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created.

It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:

Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.

private method %OnValidateObject() as %Status
Inherited description: This callback method is invoked by the %ValidateObject() method to provide notification that the current object is being validated.

If this method returns an error then %ValidateObject() will fail.

private method %SaveData(id As %String) as %Status
Inherited description: %SaveData() - saves an object to disk, checks uniqueness and referential integrity constraints, and maintains index structures. This method is implemented by the storage class.
classmethod GetPackageList() as %ListOfDataTypes

Inherited Members

Inherited Methods (Including Private)