Class %Library.PropertyDefinition

hidden deprecatedpersistent class %Library.PropertyDefinition extends %AbstractDefinition

Note: The class definition classes in the %Library package have been superceded by those in the %Dictionary package. Instead use %Dictionary.PropertyDefinition.

This class represents a specific property description.

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
	28

Summary

Properties
Calculated	Cardinality	ClassName	Collection
Deprecated	Description	Final	InitialExpression
Internal	Inverse	MultiDimensional	Name
Parameters	Private	ReadOnly	Relationship
Required	SequenceNumber	SqlCollation	SqlColumnNumber
SqlComputeCode	SqlComputeOnChange	SqlComputed	SqlFieldName
SqlListDelimiter	SqlListType	Transient	Type

Methods
%AddToSaveSet	%AddToSyncSet	%BuildDeferredIndices	%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	%OnDeleteFinally
%OnDetermineClass	%OnOpenFinally	%OnSaveFinally	%Open
%OpenId	%OriginalNamespace	%PackageName	%PurgeIndices
%Reload	%RemoveFromSaveSet	%ResolveConcurrencyConflict	%RollBack
%Save	%SaveDirect	%SerializeObject	%SetModified
%SortBegin	%SortEnd	%SyncObjectIn	%SyncTransport
%UnlockExtent	%UnlockId	%ValidateIndices	%ValidateObject
%ValidateTable	GetTransientState	SetTransientState	lb
li	ll

Properties

• property Calculated as %RawString;

A flag indicating whether the property is calculated (1) or not (0).

• property Cardinality as %RawString;

If the property is a relationship, this is a string contains the cardinality of the relationship. Cardinality = 'one' indicates the child side of the relationship while Cardinality = 'many' indicates the parent. Cardinality = 'child' and 'parent' mean the same but also indicate a dependent relationship.

• property ClassName as %RawString;

A string containing the name of the class the property belongs to.

• property Collection as %RawString;

If the property is a collection, this is a string containing the name of the collection type. If the property is not a collection (single-valued) it contains a null string ("").

• property Deprecated as %RawString;

A flag indicating if this property is deprecated (1) or not (0).

• property Description as %RawString;

A string containing the description of the property.

• property Final as %RawString;

A flag indicating whether the property is final (1) or not (0).

• property InitialExpression as %RawString [ InitialExpression = """""" ];

A string containing the initial value expression for the property.

• property Internal as %RawString;

A flag indicating whether the property is internal (1) or not (0).

• property Inverse as %RawString;

A string containing the name of the inverse relationship in the related class.

• property MultiDimensional as %RawString;

A flag indicating whether the property is multi-dimensional (1) or not (0).

• property Name as %RawString;

A string containing the name of the property.

• property Parameters as array of %RawString;

An array containing any parameter definitions for the property. The array keys are the parameter names and the array values are the parameter values.

• property Private as %RawString;

A flag indicating whether the property is private (1) or public (0).

• property ReadOnly as %RawString;

A flag indicating whether the property is a readonly (1) or writeable (0).

• property Relationship as %RawString;

A flag indicating whether the property is a relationship (1) or attribute (0).

• property Required as %RawString;

A flag indicating whether the property is required (1) or not (0).

• property SequenceNumber as %RawString;

Sequence number used to determine order of this item in Studio editor and in XML export format.

• property SqlCollation as %RawString;

A string containing the name of the class this method belongs to.

• property SqlColumnNumber as %RawString;

The column number used when projecting the property as an SQL table.

• property SqlComputeCode as %RawString;

For an SQL-computed field this is a string containing any SQL compute code for the field.

• property SqlComputeOnChange as %RawString;

• property SqlComputed as %RawString;

A flag indicating whether the property is SQL-computed (1) or not (0).

• property SqlFieldName as %RawString;

A string containing an optional SQL name for the property. This is the name with which the property is projected to SQL.

• property SqlListDelimiter as %RawString;

• property SqlListType as %RawString;

• property Transient as %RawString;

A flag indicating whether the property is transient (1) or not (0).

• property Type as %RawString;

A string containing the type (class name) of the field.

Class Reference IRIS for UNIX 2024.1.2
Documentation Search