Class %Dictionary.XDataDefinition

persistent class %Dictionary.XDataDefinition extends %Persistent, %Dictionary.XDataDefinitionQuery

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

Summary

Properties
Data	Description	Internal	Name	Object
SchemaSpec	SequenceNumber	XMLNamespace	parent

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	ObjectGet
SummaryClose	SummaryExecute	SummaryFetch

Parameters

• parameter SQLENABLED = 1;

Properties

• property Data as %Stream.TmpCharacter;

The data stream.

• property Description as %CacheString;

Specifies a description of the XData.

• property Internal as %Boolean [ InitialExpression = 0 ];

If true, then do not display this item in automatic documentation.

• property Name as %Dictionary.CacheIdentifier;

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 SchemaSpec as %CacheString;

The schema definition of the data.

• property SequenceNumber as %Integer [ InitialExpression = 0 ];

SequenceNumber

• property XMLNamespace as %CacheString;

The default XML NameSpace for the XDATA.

• relationship parent as %Dictionary.ClassDefinition [ 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) as %Status

%LockId() 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

%UnlockId() 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.

Indices

• index (IDKEY on Name) [IdKey];

Triggers

• trigger OnDelete (AFTER event DELETE)

• trigger OnInsertUpdate (BEFORE event INSERT/UPDATE)


[BASEXML] > [%Dictionary] > [XDataDefinition]		Private Storage