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

%Dictionary.UDLTextDefinition

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

SQL Table Name: %Dictionary.UDLTextDefinition

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter SQLENABLED = 1;

Properties (Including Private)

property Category as %CacheString [ InitialExpression = "comment" ];
Category
Property methods: CategoryGet(), CategoryIsValid(), CategorySet()
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.CacheIdentifier [ Required ];
Speficies the COS name of the UDL text.
Property methods: NameGet(), NameIsValid(), NameSet()
property Position as %CacheString [ InitialExpression = "body" ];
Position
Property methods: PositionGet(), PositionIsValid(), PositionSet()
property SequenceNumber as %Integer [ InitialExpression = 0 ];
SequenceNumber
Property methods: SequenceNumberDisplayToLogical(), SequenceNumberGet(), SequenceNumberIsValid(), SequenceNumberLogicalToDisplay(), SequenceNumberNormalize(), SequenceNumberSet()
property TextType as %Integer [ InitialExpression = 0 ];
TextType
Property methods: TextTypeDisplayToLogical(), TextTypeGet(), TextTypeIsValid(), TextTypeLogicalToDisplay(), TextTypeNormalize(), TextTypeSet()
relationship parent as %Dictionary.ClassDefinition [ Required , Inverse = UDLTexts , 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 (Including Private)

private classmethod %DeleteData(id As %String, concurrency As %Integer) as %Status
Inherited description: This method is normally generated by the storage class for persistent classes using %Library.CacheStorage or %Library.CacheSQLStorage. Persistent classes using some other storage class, such as %Library.CustomStorage must override this method.
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.

private method %LoadData(id As %String) as %Status
Inherited description: %LoadData() - loads an object from storage. This method is implemented by the storage class.
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.
private method %OnNew(name As %String) as %Status
Inherited description: This callback method is invoked by the %New() method to provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created.

It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:

Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.

private method %SaveData(id As %String) as %Status
Inherited description: %SaveData() - saves an object to disk, checks uniqueness and referential integrity constraints, and maintains index structures. This method is implemented by the storage class.
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.
classmethod CategoryIsValid(val As %String) as %Status
classmethod PositionIsValid(val 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