Class Reference
Cache for UNIX 2018.1.3
InterSystems: The power behind what matters   
Documentation  Search
Private  Storage  

persistent class %Dictionary.CompiledXData extends %Persistent, %Dictionary.CompiledXDataQuery

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 14 9 1 2


Summary

Properties
Data Deprecated Description Internal
KeywordError KeywordModified MimeType Name
Object Origin SchemaSpec SequenceNumber
XMLNamespace parent

Methods
%AddToSaveSet %AddToSyncSet %BuildIndices %CheckConstraints
%CheckConstraintsForExtent %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 %IsNull %KillExtent
%LockExtent %LockId %New %NormalizeObject
%ObjectIsNull %ObjectModified %Oid %OnBeforeAddToSync
%OnDetermineClass %Open %OpenId %OriginalNamespace
%PackageName %PurgeIndices %Reload %RemoveFromSaveSet
%ResolveConcurrencyConflict %RollBack %Save %SaveDirect
%SerializeObject %SetModified %SortBegin %SortEnd
%SyncObjectIn %SyncTransport %UnlockExtent %UnlockId
%ValidateIndices %ValidateObject ObjectGet SummaryClose
SummaryExecute SummaryFetch parentOnDelete


Parameters

• parameter SQLENABLED = 1;

Properties

• property Data as %Stream.TmpCharacter;
The data stream.
• property Deprecated as %Boolean;
True if this XDATA is deprecated.
• property Description as %CacheString;
Specifies a description of the XData.
• property Internal as %Boolean;
If true, then do not display this item in automatic documentation.
• property KeywordError as %Boolean;
KeywordError
• property KeywordModified as %Boolean;
KeywordModified
• property MimeType as %CacheString;
Mime type of XData block.
• property Name as %Dictionary.CacheIdentifier [ Required ];
The name of the xData block.
• property Object as %RegisteredObject [ Calculated ];
The object representation of this XData block after correlating the XML and importing it
• property Origin as %CacheString;
Origin
• property SchemaSpec as %CacheString;
The schema definition of the data.
• property SequenceNumber as %Integer;
SequenceNumber
• property XMLNamespace as %CacheString;
The default XML NameSpace for the XDATA.
• relationship parent as %Dictionary.CompiledClass [ Inverse = XDatas,Cardinality = parent ];
Pointer to the containing parent object

Methods

• classmethod %Exists(oid As %ObjectIdentity) as %Boolean
Checks to see if the object identified by the OID oid exists in the extent.

Returns %Boolean TRUE if it exists, FALSE if it does not.

• classmethod %LockId(id As %String, shared As %Boolean = 0, timeout As %Integer) as %Status
Obtain an exclusive or shared lock on the object identified by id. The type of lock obtained is determined by shared. This method is normally generated by the storage class for persistent classes using %Library.CacheStorage or %Library.CacheSQLStorage.
• classmethod %UnlockId(id As %String, shared As %Boolean = 0, immediate As %Boolean = 0) as %Status
Release an exclusive or shared lock on the object identified by id. The type of lock released is determined by shared. If this method is not overridden then the default implementation returns an error. This method is normally generated by the storage class for persistent classes using %Library.CacheStorage or %Library.CacheSQLStorage.
• method ObjectGet() as %RegisteredObject
This is a Get accessor method for the Object property.
• classmethod parentOnDelete(id As %String, concurrency As %Integer) as %Status

Indices

• index (IDKEY on Name) [IdKey];

Triggers

• trigger OnDelete (BEFORE event DELETE)
• trigger OnInsertUpdate (BEFORE event INSERT/UPDATE)


Copyright © 1997-2020, InterSystems Corporation