Class Reference
IRIS for UNIX 2019.3
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [%Dictionary] >  [XDataDefinition]
Private  Storage   

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

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 12 33 1 2


Summary

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

Methods
%AddToSaveSet %AddToSyncSet %BuildIndices %BuildIndicesAsync
%BuildIndicesAsyncResponse %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
DeprecatedIsDefined DeprecatedReset DeprecatedSet DescriptionIsDefined
DescriptionReset DescriptionSet InternalIsDefined InternalReset
InternalSet MimeTypeIsDefined MimeTypeReset MimeTypeSet
NameIsDefined NameReset NameSet ObjectGet
SchemaSpecIsDefined SchemaSpecReset SchemaSpecSet SequenceNumberIsDefined
SequenceNumberReset SequenceNumberSet SummaryClose SummaryExecute
SummaryFetch XMLNamespaceIsDefined XMLNamespaceReset XMLNamespaceSet
parentOnDelete


Parameters

• parameter SQLENABLED = 1;

Properties

• property Data as %Stream.TmpCharacter;
The data stream.
• property Deprecated as %Boolean [ InitialExpression = 0 ];
True if this XDATA is deprecated.
• property Description as %RawString;
Specifies a description of the XData.
• property Internal as %Boolean [ InitialExpression = 0 ];
If true, then do not display this item in automatic documentation.
• property MimeType as %RawString [ InitialExpression = "text/xml" ];
Mime type of XData block.
• property Name as %Dictionary.Identifier [ 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 SchemaSpec as %RawString;
The schema definition of the data.
• property SequenceNumber as %Integer [ InitialExpression = 0 ];
SequenceNumber
• property XMLNamespace as %RawString;
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, 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 %Storage.Persistent or %Storage.SQL.
• 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 %Storage.Persistent or %Storage.SQL.
• method DeprecatedIsDefined() as %Boolean
• method DeprecatedReset()
• method DeprecatedSet(value As %String = "") as %Status
This is a Set accessor method for the Deprecated property.
• method DescriptionIsDefined() as %Boolean
• method DescriptionReset()
• method DescriptionSet(value As %String = "") as %Status
This is a Set accessor method for the Description property.
• method InternalIsDefined() as %Boolean
• method InternalReset()
• method InternalSet(value As %String = "") as %Status
This is a Set accessor method for the Internal property.
• method MimeTypeIsDefined() as %Boolean
• method MimeTypeReset()
• method MimeTypeSet(value As %String = "") as %Status
This is a Set accessor method for the MimeType property.
• method NameIsDefined() as %Boolean
• method NameReset()
• method NameSet(value As %String = "") as %Status
This is a Set accessor method for the Name property.
• method ObjectGet() as %RegisteredObject
This is a Get accessor method for the Object property.
• method SchemaSpecIsDefined() as %Boolean
• method SchemaSpecReset()
• method SchemaSpecSet(value As %String = "") as %Status
This is a Set accessor method for the SchemaSpec property.
• method SequenceNumberIsDefined() as %Boolean
• method SequenceNumberReset()
• method SequenceNumberSet(value As %String = "") as %Status
This is a Set accessor method for the SequenceNumber property.
• method XMLNamespaceIsDefined() as %Boolean
• method XMLNamespaceReset()
• method XMLNamespaceSet(value As %String = "") as %Status
This is a Set accessor method for the XMLNamespace property.
• classmethod parentOnDelete(id As %String, concurrency As %Integer) as %Status

Indices

•index (IDKEY on Name) [IdKey];

Triggers

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


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.