%Dictionary.XDataDefinition
persistent class %Dictionary.XDataDefinition extends %Library.Persistent, %Dictionary.XDataDefinitionQuery
SQL Table Name: %Dictionary.XDataDefinition
Property Inventory
- Data
- Deprecated
- Description
- Internal
- MimeType
- Name
- Object
- SchemaSpec
- SequenceNumber
- XMLNamespace
- parent
Method Inventory
- %Exists()
- %LockId()
- %UnlockId()
- DeprecatedIsDefined()
- DeprecatedReset()
- DeprecatedSet()
- DescriptionIsDefined()
- DescriptionReset()
- DescriptionSet()
- InternalIsDefined()
- InternalReset()
- InternalSet()
- MimeTypeIsDefined()
- MimeTypeReset()
- MimeTypeSet()
- NameIsDefined()
- NameReset()
- NameSet()
- ObjectGet()
- SchemaSpecIsDefined()
- SchemaSpecReset()
- SchemaSpecSet()
- SequenceNumberIsDefined()
- SequenceNumberReset()
- SequenceNumberSet()
- XMLNamespaceIsDefined()
- XMLNamespaceReset()
- XMLNamespaceSet()
- parentOnDelete()
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()
property Description as %RawString;
Specifies a description of the XData.
Property methods: DescriptionGet(), DescriptionIsValid()
property Internal as %Boolean [ InitialExpression = 0 ];
If true, then do not display this item in automatic documentation.
Property methods: InternalDisplayToLogical(), InternalGet(), InternalIsValid(), InternalLogicalToDisplay(), InternalNormalize()
property MimeType as %RawString [ InitialExpression = "text/xml" ];
Mime type of XData block.
Property methods: MimeTypeGet(), MimeTypeIsValid()
property Name as %Dictionary.Identifier [ Required ];
The name of the xData block.
Property methods: NameGet(), NameIsValid()
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 methods: SchemaSpecGet(), SchemaSpecIsValid()
property SequenceNumber as %Integer [ InitialExpression = 0 ];
SequenceNumber
Property methods: SequenceNumberDisplayToLogical(), SequenceNumberGet(), SequenceNumberIsValid(), SequenceNumberLogicalToDisplay(), SequenceNumberNormalize()
property XMLNamespace as %RawString;
The default XML NameSpace for the XDATA.
Property methods: XMLNamespaceGet(), XMLNamespaceIsValid()
relationship parent as %Dictionary.ClassDefinition [ Required , Inverse = XDatas , Cardinality = parent ];
Pointer to the containing parent object
Property methods: parentGet(), parentGetObject(), parentGetObjectId(), parentGetSwizzled(), parentIsValid(), parentNewObject(), 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.
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 %Storage.Persistent or %Storage.SQL.
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 %Storage.Persistent or %Storage.SQL.
method DeprecatedIsDefined() as %Boolean
method DeprecatedReset()
method DescriptionIsDefined() as %Boolean
method DescriptionReset()
method InternalIsDefined() as %Boolean
method InternalReset()
method MimeTypeIsDefined() as %Boolean
method MimeTypeReset()
method NameIsDefined() as %Boolean
method NameReset()
method ObjectGet() as %RegisteredObject
method SchemaSpecIsDefined() as %Boolean
method SchemaSpecReset()
method SequenceNumberIsDefined() as %Boolean
method SequenceNumberReset()
method XMLNamespaceIsDefined() as %Boolean
method XMLNamespaceReset()
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
- %AddToSaveSet()
- %AddToSyncSet()
- %BuildDeferredIndices()
- %BuildIndices()
- %BuildIndicesAsync()
- %BuildIndicesAsyncResponse()
- %CheckConstraints()
- %CheckConstraintsForExtent()
- %ClassIsLatestVersion()
- %ClassName()
- %ComposeOid()
- %ConstructClone()
- %Delete()
- %DeleteExtent()
- %DeleteId()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %ExistsId()
- %Extends()
- %GUID()
- %GUIDSet()
- %GetLock()
- %GetParameter()
- %GetSwizzleObject()
- %Id()
- %IsA()
- %IsModified()
- %IsNull()
- %KillExtent()
- %LockExtent()
- %New()
- %NormalizeObject()
- %ObjectIsNull()
- %ObjectModified()
- %Oid()
- %OnBeforeAddToSync()
- %OnDeleteFinally()
- %OnDetermineClass()
- %OnOpenFinally()
- %OnSaveFinally()
- %Open()
- %OpenId()
- %OriginalNamespace()
- %PackageName()
- %PurgeIndices()
- %Reload()
- %RemoveFromSaveSet()
- %ResolveConcurrencyConflict()
- %RollBack()
- %Save()
- %SaveDirect()
- %SerializeObject()
- %SetModified()
- %SortBegin()
- %SortEnd()
- %SyncObjectIn()
- %SyncTransport()
- %UnlockExtent()
- %ValidateIndices()
- %ValidateObject()
- %ValidateTable()
- SummaryClose()
- SummaryExecute()
- SummaryFetch()