This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > ENSLIB namespace > %Dictionary.XDataDefinition

%Dictionary.XDataDefinition

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

SQL Table Name: %Dictionary.XDataDefinition

Property Inventory

Method Inventory

Parameters

parameter SQLENABLED = 1;

Properties

property Data as %Stream.TmpCharacter;
The data stream.
Property methods: DataDelete(), DataGet(), DataGetObject(), DataGetObjectId(), DataGetSwizzled(), DataIsValid(), DataNewObject(), DataOid(), DataOpen(), DataSet(), DataSetObject(), DataSetObjectId(), DataUnSwizzle()
property Deprecated as %Boolean [ InitialExpression = 0 ];
True if this XDATA is deprecated.
Property methods: DeprecatedDisplayToLogical(), DeprecatedGet(), DeprecatedIsValid(), DeprecatedLogicalToDisplay(), DeprecatedNormalize(), DeprecatedSet()
property Description as %CacheString;
Specifies a description of the XData.
Property methods: DescriptionGet(), DescriptionIsValid(), DescriptionSet()
property Internal as %Boolean [ InitialExpression = 0 ];
If true, then do not display this item in automatic documentation.
Property methods: InternalDisplayToLogical(), InternalGet(), InternalIsValid(), InternalLogicalToDisplay(), InternalNormalize(), InternalSet()
property MimeType as %CacheString [ InitialExpression = "text/xml" ];
Mime type of XData block.
Property methods: MimeTypeGet(), MimeTypeIsValid(), MimeTypeSet()
property Name as %Dictionary.CacheIdentifier [ Required ];
The name of the xData block.
Property methods: NameGet(), NameIsValid(), NameSet()
property Object as %RegisteredObject [ Calculated ];
The object representation of this XData block after correlating the XML and importing it
Property methods: ObjectGet()
property SchemaSpec as %CacheString;
The schema definition of the data.
Property methods: SchemaSpecGet(), SchemaSpecIsValid(), SchemaSpecSet()
property SequenceNumber as %Integer [ InitialExpression = 0 ];
SequenceNumber
Property methods: SequenceNumberDisplayToLogical(), SequenceNumberGet(), SequenceNumberIsValid(), SequenceNumberLogicalToDisplay(), SequenceNumberNormalize(), SequenceNumberSet()
property XMLNamespace as %CacheString;
The default XML NameSpace for the XDATA.
Property methods: XMLNamespaceGet(), XMLNamespaceIsValid(), XMLNamespaceSet()
relationship parent as %Dictionary.ClassDefinition [ Required , Inverse = XDatas , Cardinality = parent ];
Pointer to the containing parent object
Property methods: parentCheck(), parentDelete(), parentGet(), parentGetObject(), parentGetObjectId(), parentGetSwizzled(), parentIsValid(), parentNewObject(), parentOnDelete(), parentRClose(), parentRExec(), parentRFetch(), parentRelate(), parentSQLCompute(), parentSet(), parentSetObject(), parentSetObjectId(), parentUnRelate(), parentUnSwizzle()

Methods

classmethod %Exists(oid As %ObjectIdentity) as %Boolean
Inherited description: 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
Inherited description: 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
Inherited description: 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
classmethod parentOnDelete(id As %String, concurrency As %Integer) as %Status

Indexes

index (IDKEY on Name) [IdKey, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()

Triggers

trigger OnDelete (AFTER event DELETE);
trigger OnInsertUpdate (BEFORE event INSERT/UPDATE);

Inherited Members

Inherited Methods

FeedbackOpens in a new window