DocBook|Search
Class Reference
%Library.PackageDefinition
    
Server:basexml
Instance:SOAXML
User:UnknownUser
  
-
  [BASEXML] >  [%Library] >  [PackageDefinition]
Private  Storage  

persistent class %Library.PackageDefinition extends %AbstractDefinition

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

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
8 10 1


Summary

Properties
ClientName Description GlobalPrefix Name OwnerName
RtnPrefix SQLName list

Methods
%%OIDGet %AddToSaveSet %AddToSyncSet %BuildIndices
%CheckUnique %ClassIsLatestVersion %ClassName %ComposeOid
%ConstructClone %Delete %DeleteExtent %DeleteId
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Exists
%ExistsId %Extends %GUID %GUIDSet
%GetLock %GetParameter %GetSwizzleObject %Id
%IsA %IsModified %KillExtent %LockExtent
%LockId %New %NormalizeObject %ObjectModified
%Oid %OnBeforeAddToSync %OnDetermineClass %Open
%OpenId %OriginalNamespace %PackageName %PurgeIndices
%Reload %RemoveFromSaveSet %ResolveConcurrencyConflict %RollBack
%Save %SaveDirect %SerializeObject %SetModified
%SortBegin %SortEnd %SyncObjectIn %SyncTransport
%UnlockExtent %UnlockId %ValidateObject GetPackageList
GetTransientState SetTransientState SubPackageClose SubPackageExecute
SubPackageFetch SubPackageFetchRows lb li
ll


Properties

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

Methods

• method GetPackageList() as %ListOfDataTypes
• classmethod SubPackageClose(QHandle As %Binary) as %Status
• classmethod SubPackageExecute(ByRef QHandle As %Binary, SuperPackage As %String) as %Status
• classmethod SubPackageFetch(ByRef QHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
Fetch returns the next row in the query.
• classmethod SubPackageFetchRows(ByRef QHandle As %Binary, FetchCount As %Integer = 0, ByRef RowSet As %List, ByRef ReturnCount As %Integer, ByRef AtEnd As %Integer) as %Status
RoutineListFetchRows returns the next FetchCount rows in the query.

Queries

• query SubPackage()
Selects Name
The SumPackage query provides a list of sub-package names. This query works in a hierarchical way, it returns only one level of sub-package under a specified SuperPackage name.