Class Reference
IRIS for UNIX 2019.3
InterSystems: The power behind what matters   
Documentation  Search
Private  Storage   

persistent class %Dictionary.PropertyDefinition extends %Persistent, %Dictionary.PropertyDefinitionQuery

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 37 113 1 2


Summary

Properties
Aliases Calculated Cardinality ClientName
Collection Deprecated Description Final
Identity InitialExpression Internal Inverse
MultiDimensional Name NoModBit NotInheritable
OnDelete Parameters Private ReadOnly
Relationship Required SequenceNumber ServerOnly
SqlCollation SqlColumnNumber SqlComputeCode SqlComputeOnChange
SqlComputed SqlFieldName SqlListDelimiter SqlListType
Transient Type UDLTexts 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
AliasesIsDefined AliasesReset AliasesSet CalculatedIsDefined
CalculatedReset CalculatedSet CardinalityIsDefined CardinalityIsValid
CardinalityReset CardinalitySet ClientNameIsDefined ClientNameReset
ClientNameSet CollectionIsDefined CollectionIsValid CollectionReset
CollectionSet DeprecatedIsDefined DeprecatedReset DeprecatedSet
DescriptionIsDefined DescriptionReset DescriptionSet FinalIsDefined
FinalReset FinalSet IdentityIsDefined IdentityReset
IdentitySet InitialExpressionIsDefined InitialExpressionReset InitialExpressionSet
InternalIsDefined InternalReset InternalSet InverseIsDefined
InverseReset InverseSet MultiDimensionalIsDefined MultiDimensionalReset
MultiDimensionalSet NameIsDefined NameReset NameSet
NoModBitIsDefined NoModBitReset NoModBitSet NotInheritableIsDefined
NotInheritableReset NotInheritableSet OnDeleteIsDefined OnDeleteIsValid
OnDeleteReset OnDeleteSet PrivateIsDefined PrivateReset
PrivateSet ReadOnlyIsDefined ReadOnlyReset ReadOnlySet
RelationshipIsDefined RelationshipReset RelationshipSet RequiredIsDefined
RequiredReset RequiredSet SequenceNumberIsDefined SequenceNumberReset
SequenceNumberSet ServerOnlyIsDefined ServerOnlyIsValid ServerOnlyReset
ServerOnlySet SqlCollationIsDefined SqlCollationIsValid SqlCollationReset
SqlCollationSet SqlColumnNumberIsDefined SqlColumnNumberReset SqlColumnNumberSet
SqlComputeCodeIsDefined SqlComputeCodeReset SqlComputeCodeSet SqlComputeOnChangeIsDefined
SqlComputeOnChangeReset SqlComputeOnChangeSet SqlComputedIsDefined SqlComputedReset
SqlComputedSet SqlFieldNameIsDefined SqlFieldNameReset SqlFieldNameSet
SqlListDelimiterIsDefined SqlListDelimiterReset SqlListDelimiterSet SqlListTypeIsDefined
SqlListTypeIsValid SqlListTypeReset SqlListTypeSet SummaryClose
SummaryExecute SummaryFetch TransientIsDefined TransientReset
TransientSet TypeIsDefined TypeReset TypeSet
parentOnDelete


Parameters

• parameter SQLENABLED = 1;

Properties

• property Aliases as %RawString;
List of aliases for this property.
• property Calculated as %Boolean [ InitialExpression = 0 ];
Specifies that the property has no in-memory storage allocated for it when the object containing it is instantiated.
• property Cardinality as %RawString;
Specifies the cardinality of a relationship property. The Cardinality keyword is required for relationship properties. It is ignored by non-relationship properties.
• property ClientName as %RawString;
ClientName
• property Collection as %RawString;
Specifies that a property is a collection property as well as what type of collection it is.
• property Deprecated as %Boolean [ InitialExpression = 0 ];
True if this property is deprecated.
• property Description as %RawString;
Specifies a description of the property.
• property Final as %Boolean [ InitialExpression = 0 ];
Specifies that subclasses cannot override the definition of this property.
• property Identity as %Boolean [ SqlFieldName = _Identity,InitialExpression = 0 ];
Specifies that this property is the identity for this class. Identity properties can be set in new objects only and the default is set by incrementing a counter.
• property InitialExpression as %RawString [ InitialExpression = """""" ];
Specifies an initial value for the property.
• property Internal as %Boolean [ InitialExpression = 0 ];
If true, then do not display this item in automatic documentation.
• property Inverse as %RawString;
Specifies the name of the inverse side of a relationship. That is, the name of the corresponding relationship property in the related class. The inverse property must exist in the related class and have the correct Cardinality value. The Inverse keyword is required for relationship properties. It is ignored by non-relationship properties.
• property MultiDimensional as %Boolean [ InitialExpression = 0 ];
Specifies that an attribute has the characteristics of a multidimensional array.
• property Name as %Dictionary.Identifier [ Required ];
The name of the property.
• property NoModBit as %Boolean [ InitialExpression = 0 ];
Deprecated.
• property NotInheritable as %Boolean [ InitialExpression = 0 ];
Deprecated.
• property OnDelete as %RawString;
Specifies what referential action to take when the key value is deleted from the foreign table.
• property Parameters as array of %RawString;
Parameter
• property Private as %Boolean [ InitialExpression = 0 ];
Specifies that the property is private. Private properties can only be used by instance methods of this class or its subclasses.
• property ReadOnly as %Boolean [ InitialExpression = 0 ];
Specifies that the property is readonly.
• property Relationship as %Boolean [ InitialExpression = 0 ];
Specifies that a property is a relationship property.
• property Required as %Boolean [ InitialExpression = 0 ];
In the case of a persistent class, specifies that the value of the property must be given a value before it can be stored to disk.
• property SequenceNumber as %Integer [ InitialExpression = 0 ];
SequenceNumber
• property ServerOnly as %RawString;
Specifies that a property will not be projected to a Java or C++ client.
• property SqlCollation as %RawString;
Deprecated.
• property SqlColumnNumber as %RawString;
Explicitly sets the SQL Column number for this property. This is provided for legacy application support.
• property SqlComputeCode as %RawString;
Specifies ObjectScript code that evaluates to a computed field value.
• property SqlComputeOnChange as %RawString;
Specifies one or more properties whose modification triggers the recalculation of this computed field within SQL.
• property SqlComputed as %Boolean [ InitialExpression = 0 ];
Specifies that this property is an SQL computed field.
• property SqlFieldName as %RawString;
In the case of a persistent class, specifies the column name used to identify the property in its SQL projection. By default, the SQL column name is the same as the property name.
• property SqlListDelimiter as %RawString;
Specifies the delimiter character used within SQL for lists. This is provided for legacy application support.
• property SqlListType as %RawString;
specifies the representation to be used for a list.
• property Transient as %Boolean [ InitialExpression = 0 ];
In the case of a persistent class, specifies that the property is not stored in the database.
• property Type as %Dictionary.Classname;
Specifies the name of the class associated with the property, which can be a data type class, a persistent class, or an embeddable serial class.
• relationship UDLTexts as %Dictionary.PropertyUDLTextDefinition [ Inverse = parent,Cardinality = children ];
UDLText
• relationship parent as %Dictionary.ClassDefinition [ Inverse = Properties,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 AliasesIsDefined() as %Boolean
• method AliasesReset()
• method AliasesSet(value As %String = "") as %Status
This is a Set accessor method for the Aliases property.
• method CalculatedIsDefined() as %Boolean
• method CalculatedReset()
• method CalculatedSet(value As %String = "") as %Status
This is a Set accessor method for the Calculated property.
• method CardinalityIsDefined() as %Boolean
• classmethod CardinalityIsValid(val As %String) as %Status
• method CardinalityReset()
• method CardinalitySet(value As %String = "") as %Status
This is a Set accessor method for the Cardinality property.
• method ClientNameIsDefined() as %Boolean
• method ClientNameReset()
• method ClientNameSet(value As %String = "") as %Status
This is a Set accessor method for the ClientName property.
• method CollectionIsDefined() as %Boolean
• classmethod CollectionIsValid(val As %String) as %Status
• method CollectionReset()
• method CollectionSet(value As %String = "") as %Status
This is a Set accessor method for the Collection property.
• 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 FinalIsDefined() as %Boolean
• method FinalReset()
• method FinalSet(value As %String = "") as %Status
This is a Set accessor method for the Final property.
• method IdentityIsDefined() as %Boolean
• method IdentityReset()
• method IdentitySet(value As %String = "") as %Status
This is a Set accessor method for the Identity property.
• method InitialExpressionIsDefined() as %Boolean
• method InitialExpressionReset()
• method InitialExpressionSet(value As %String = "") as %Status
This is a Set accessor method for the InitialExpression 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 InverseIsDefined() as %Boolean
• method InverseReset()
• method InverseSet(value As %String = "") as %Status
This is a Set accessor method for the Inverse property.
• method MultiDimensionalIsDefined() as %Boolean
• method MultiDimensionalReset()
• method MultiDimensionalSet(value As %String = "") as %Status
This is a Set accessor method for the MultiDimensional 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 NoModBitIsDefined() as %Boolean
• method NoModBitReset()
• method NoModBitSet(value As %String = "") as %Status
This is a Set accessor method for the NoModBit property.
• method NotInheritableIsDefined() as %Boolean
• method NotInheritableReset()
• method NotInheritableSet(value As %String = "") as %Status
This is a Set accessor method for the NotInheritable property.
• method OnDeleteIsDefined() as %Boolean
• classmethod OnDeleteIsValid(val As %String) as %Status
• method OnDeleteReset()
• method OnDeleteSet(value As %String = "") as %Status
This is a Set accessor method for the OnDelete property.
• method PrivateIsDefined() as %Boolean
• method PrivateReset()
• method PrivateSet(value As %String = "") as %Status
This is a Set accessor method for the Private property.
• method ReadOnlyIsDefined() as %Boolean
• method ReadOnlyReset()
• method ReadOnlySet(value As %String = "") as %Status
This is a Set accessor method for the ReadOnly property.
• method RelationshipIsDefined() as %Boolean
• method RelationshipReset()
• method RelationshipSet(value As %String = "") as %Status
This is a Set accessor method for the Relationship property.
• method RequiredIsDefined() as %Boolean
• method RequiredReset()
• method RequiredSet(value As %String = "") as %Status
This is a Set accessor method for the Required 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 ServerOnlyIsDefined() as %Boolean
• classmethod ServerOnlyIsValid(val As %String) as %Status
• method ServerOnlyReset()
• method ServerOnlySet(value As %String = "") as %Status
This is a Set accessor method for the ServerOnly property.
• method SqlCollationIsDefined() as %Boolean
• classmethod SqlCollationIsValid(val As %String) as %Status
• method SqlCollationReset()
• method SqlCollationSet(value As %String = "") as %Status
This is a Set accessor method for the SqlCollation property.
• method SqlColumnNumberIsDefined() as %Boolean
• method SqlColumnNumberReset()
• method SqlColumnNumberSet(value As %String = "") as %Status
This is a Set accessor method for the SqlColumnNumber property.
• method SqlComputeCodeIsDefined() as %Boolean
• method SqlComputeCodeReset()
• method SqlComputeCodeSet(value As %String = "") as %Status
This is a Set accessor method for the SqlComputeCode property.
• method SqlComputeOnChangeIsDefined() as %Boolean
• method SqlComputeOnChangeReset()
• method SqlComputeOnChangeSet(value As %String = "") as %Status
This is a Set accessor method for the SqlComputeOnChange property.
• method SqlComputedIsDefined() as %Boolean
• method SqlComputedReset()
• method SqlComputedSet(value As %String = "") as %Status
This is a Set accessor method for the SqlComputed property.
• method SqlFieldNameIsDefined() as %Boolean
• method SqlFieldNameReset()
• method SqlFieldNameSet(value As %String = "") as %Status
This is a Set accessor method for the SqlFieldName property.
• method SqlListDelimiterIsDefined() as %Boolean
• method SqlListDelimiterReset()
• method SqlListDelimiterSet(value As %String = "") as %Status
This is a Set accessor method for the SqlListDelimiter property.
• method SqlListTypeIsDefined() as %Boolean
• classmethod SqlListTypeIsValid(val As %String) as %Status
• method SqlListTypeReset()
• method SqlListTypeSet(value As %String = "") as %Status
This is a Set accessor method for the SqlListType property.
• method TransientIsDefined() as %Boolean
• method TransientReset()
• method TransientSet(value As %String = "") as %Status
This is a Set accessor method for the Transient property.
• method TypeIsDefined() as %Boolean
• method TypeReset()
• method TypeSet(value As %String = "") as %Status
This is a Set accessor method for the Type 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.