%Library.PackageDefinition
persistent class %Library.PackageDefinition extends %Library.AbstractDefinition
SQL Table Name: %Library.PackageDefinition
This class represents a specific package description contained within the Caché Dictionary.Property Inventory (Including Private)
Method Inventory (Including Private)
- %DeleteData()
- %LoadData()
- %OnNew()
- %OnValidateObject()
- %SaveData()
- GetPackageList()
- SubPackageClose()
- SubPackageExecute()
- SubPackageFetch()
- SubPackageFetchRows()
Properties
property ClientName as %CacheString;
A string containing the client name of 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
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.
Inherited description: %LoadData() - loads an object from storage. This method is
implemented by the storage class.
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.
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.
method GetPackageList() as %ListOfDataTypes
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.
Indices
index (IDKEY on ) [IdKey, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()
Inherited Members
Inherited Methods (Including Private)
- %AcquireLock()
- %AddToSaveSet()
- %AddToSyncSet()
- %BuildIndices()
- %CheckConstraints()
- %CheckConstraintsForExtent()
- %ClassIsLatestVersion()
- %ClassName()
- %ComposeOid()
- %ConstructClone()
- %ConstructCloneInit()
- %Delete()
- %DeleteExtent()
- %DeleteId()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Exists()
- %ExistsId()
- %Extends()
- %GUID()
- %GUIDSet()
- %GetLock()
- %GetParameter()
- %GetSwizzleObject()
- %Id()
- %IsA()
- %IsModified()
- %IsNull()
- %KillExtent()
- %KillExtentData()
- %LockExtent()
- %LockId()
- %New()
- %NormalizeObject()
- %ObjectIsNull()
- %ObjectModified()
- %Oid()
- %OnAddToSaveSet()
- %OnAfterBuildIndices()
- %OnAfterDelete()
- %OnAfterPurgeIndices()
- %OnAfterSave()
- %OnBeforeAddToSync()
- %OnBeforeBuildIndices()
- %OnBeforePurgeIndices()
- %OnBeforeSave()
- %OnClose()
- %OnConstructClone()
- %OnDelete()
- %OnDetermineClass()
- %OnJournalObject()
- %OnOpen()
- %OnReload()
- %OnRollBack()
- %Open()
- %OpenId()
- %OriginalNamespace()
- %PackageName()
- %PurgeIndices()
- %ReleaseLock()
- %Reload()
- %RemoveFromSaveSet()
- %ResolveConcurrencyConflict()
- %RollBack()
- %Save()
- %SaveDirect()
- %SerializeObject()
- %SetModified()
- %SortBegin()
- %SortEnd()
- %SyncObjectIn()
- %SyncTransport()
- %UnlockExtent()
- %UnlockId()
- %ValidateIndices()
- %ValidateObject()
- GetTransientState()
- SetTransientState()
- lb()
- li()
- ll()
Storage
Gray indicates storage defined by superclasses.
Storage Model: CacheStorage (%Library.AbstractDefinition)
^%Library.AbstractDefinitionD(ID) | = | %%CLASSNAME
|