Skip to main content

This documentation is for an older version of this product. See the latest version of this content.Opens in a new tab

%Dictionary.UDLTextDefinition

persistent class %Dictionary.UDLTextDefinition extends %Library.Persistent, %Dictionary.UDLTextDefinitionQuery

SQL Table Name: %Dictionary.UDLTextDefinition

Property Inventory

Method Inventory

Parameters

parameter SQLENABLED = 1;

Properties

property Category as %RawString [ InitialExpression = "comment" ];
Category
Property methods: CategoryGet()
property Content as %Stream.TmpCharacter;
Holds the content of the UDL text.
Property methods: ContentDelete(), ContentGet(), ContentGetObject(), ContentGetObjectId(), ContentGetSwizzled(), ContentIsValid(), ContentNewObject(), ContentOid(), ContentOpen(), ContentSet(), ContentSetObject(), ContentSetObjectId(), ContentUnSwizzle()
property Name as %Dictionary.Identifier [ Required ];
Speficies the COS name of the UDL text.
Property methods: NameGet(), NameIsValid()
property Position as %RawString [ InitialExpression = "body" ];
Position
Property methods: PositionGet()
property SequenceNumber as %Integer [ InitialExpression = 0 ];
SequenceNumber
Property methods: SequenceNumberDisplayToLogical(), SequenceNumberGet(), SequenceNumberIsValid(), SequenceNumberLogicalToDisplay(), SequenceNumberNormalize()
property TextType as %Integer [ InitialExpression = 0 ];
TextType
Property methods: TextTypeDisplayToLogical(), TextTypeGet(), TextTypeIsValid(), TextTypeLogicalToDisplay(), TextTypeNormalize()
relationship parent as %Dictionary.ClassDefinition [ Required , Inverse = UDLTexts , 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.

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 %Storage.Persistent or %Storage.SQL.
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 %Storage.Persistent or %Storage.SQL.
method CategoryIsDefined() as %Boolean
classmethod CategoryIsValid(val As %String) as %Status
method CategoryReset()
method CategorySet(value As %String = "") as %Status
method NameIsDefined() as %Boolean
method NameReset()
method NameSet(value As %String = "") as %Status
method PositionIsDefined() as %Boolean
classmethod PositionIsValid(val As %String) as %Status
method PositionReset()
method PositionSet(value As %String = "") as %Status
method SequenceNumberIsDefined() as %Boolean
method SequenceNumberReset()
method SequenceNumberSet(value As %String = "") as %Status
method TextTypeIsDefined() as %Boolean
method TextTypeReset()
method TextTypeSet(value As %String = "") as %Status
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 tab