Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [%SYS] >  [%Dictionary] >  [PackageDefinition]
Private  Storage   

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

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

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
8 6


Summary

Properties
%Concurrency ClientName Description GlobalPrefix Name
OwnerName RtnPrefix SQLName list

Methods
%%OIDGet %1Check %AddJrnObjToSyncSet %AddToSaveSet
%AddToSyncSet %BMEBuilt %BindExport %BuildIndices
%BuildObjectGraph %CheckConstraints %CheckConstraintsForExtent %ClassIsLatestVersion
%ClassName %Close %ComposeOid %ConstructClone
%Delete %DeleteExtent %DeleteId %DispatchClassMethod
%DispatchGetModified %DispatchGetProperty %DispatchMethod %DispatchSetModified
%DispatchSetMultidimProperty %DispatchSetProperty %DowngradeConcurrency %ExecuteAfterTriggers
%ExecuteBeforeTriggers %Exists %ExistsId %Extends
%FileIndices %GUID %GUIDSet %GetLock
%GetParameter %GetSwizzleObject %Id %IncrementCount
%IsA %IsModified %IsNull %JournalObject
%KillExtent %LockExtent %LockId %New
%NormalizeObject %ObjectIsNull %ObjectModified %Oid
%OnBeforeAddToSync %OnDetermineClass %Open %OpenId
%OriginalNamespace %PackageName %PurgeIndices %Reload
%RemoveFromSaveSet %ResolveConcurrencyConflict %RollBack %SQLAcquireLock
%SQLAcquireTableLock %SQLAfterTriggers %SQLBeforeTriggers %SQLBuildIndices
%SQLBuildPurgeIndexForRow %SQLBuildPurgeIndices %SQLCheckUnique %SQLCheckUniqueIndices
%SQLCheckUniqueKeys %SQLCopyIcolIntoName %SQLCopyNameIntoIcol %SQLCreateInsDelTables
%SQLDefineiDjVars %SQLDelete %SQLDeleteChildren %SQLDeleteTempStreams
%SQLEExit %SQLExists %SQLFKeyDelLock %SQLFastInsert
%SQLFieldValidate %SQLGetLock %SQLGetOld %SQLGetOldAll
%SQLGetOldIndex %SQLInsert %SQLInsertComputes %SQLInsertStreams
%SQLInvalid %SQLInvalid2 %SQLMVDelete %SQLMVIndexDelete
%SQLMVIndexInsert %SQLMVIndexUpdate %SQLMVInsert %SQLMVUpdate
%SQLMissing %SQLNormalizeCompFields %SQLNormalizeFields %SQLPurgeIndices
%SQLQuickBulkInsert %SQLQuickBulkLoad %SQLQuickBulkSave %SQLQuickBulkUpdate
%SQLQuickDelete %SQLQuickDeleteChildren %SQLQuickFindPKeyByRowID %SQLQuickFindRowIDByPKey
%SQLQuickInsert %SQLQuickLoad %SQLQuickLoadChildren %SQLQuickLogicalToOdbc
%SQLQuickOdbcToLogical %SQLQuickUpdate %SQLReleaseLock %SQLReleaseTableLock
%SQLStorageValidation %SQLTrigDelTab %SQLTrigInsTab %SQLUnlock
%SQLUnlock2 %SQLUnlockError %SQLUnlockRef %SQLUpdate
%SQLUpdateComputes %SQLUpdateStreams %SQLValidateCompFields %SQLValidateFields
%SQLicompView %SQLnBuild %Save %SaveDirect
%SaveIndices %SerializeObject %SetModified %SortBegin
%SortEnd %SyncObjectIn %SyncTransport %UnlockExtent
%UnlockId %UpgradeConcurrency %ValidateIndices %ValidateObject
FlatPackageClose FlatPackageExecute FlatPackageFetch FlatPackageFetchRows
GetPackageList SubPackageClose SubPackageExecute SubPackageFetch
SubPackageFetchRows


Properties

• property ClientName as %RawString;
A string containing the client name for the package.
• property Description as %RawString;
A string containing the description of the package.
• property GlobalPrefix as %RawString;
A string containing the global prefix of the package, used for data, id, and index locations.
• property Name as %RawString;
A string containing the name of the package.
• property OwnerName as %RawString;
A string containing the Owner's name of the package.
• property RtnPrefix as %RawString;
A string containing the routine prefix of the package.
• property SQLName as %RawString;
A string containing the SQL name of the package.
• property list as %ListOfDataTypes [ Transient ];

Methods

• private classmethod %DeleteData(id As %String, concurrency As %Integer) as %Status
This method is normally generated by the storage class for persistent classes using %Storage.Persistent or %Storage.SQL. Persistent classes using some other storage class, such as %Library.CustomStorage must override this method.
• private method %LoadData(id As %String) as %Status
%LoadData() - loads an object from storage. This method is implemented by the storage class.
• private method %OnNew(initvalue As %String) as %Status
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
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
%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


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