Specifies the cardinality of a relationship property. The Cardinality keyword is required for relationship properties. It is ignored by non-relationship properties.
property Identity as %Boolean [ SqlFieldName = _Identity ];
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.
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.
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.
private classmethod %DeleteData(id As %String, concurrency As %Integer) as %Status [ Language = objectscript ]
Inherited description: This method is normally generated by the storage class for persistent classes using
%Storage.Persistent or %Storage.SQL. Persistent
classes using some other storage class, such as %Library.CustomStorage must override this
method.
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.
private method %OnNew(name As %String) as %Status [ Language = objectscript ]
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 [ Language = objectscript ]
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 [ Language = objectscript ]
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 AliasesIsDefined() as %Boolean [ Language = objectscript ]
method AliasesReset() [ Language = objectscript ]
method AliasesSet(value As %String = "") as %Status [ Language = objectscript ]
method CalculatedIsDefined() as %Boolean [ Language = objectscript ]
method CalculatedReset() [ Language = objectscript ]
method CalculatedSet(value As %String = "") as %Status [ Language = objectscript ]
method CardinalityIsDefined() as %Boolean [ Language = objectscript ]
method CardinalityReset() [ Language = objectscript ]
method CardinalitySet(value As %String = "") as %Status [ Language = objectscript ]
method ClientNameIsDefined() as %Boolean [ Language = objectscript ]
method ClientNameReset() [ Language = objectscript ]
method ClientNameSet(value As %String = "") as %Status [ Language = objectscript ]
method CollectionIsDefined() as %Boolean [ Language = objectscript ]
method CollectionReset() [ Language = objectscript ]
method CollectionSet(value As %String = "") as %Status [ Language = objectscript ]
method DeprecatedIsDefined() as %Boolean [ Language = objectscript ]
method DeprecatedReset() [ Language = objectscript ]
method DeprecatedSet(value As %String = "") as %Status [ Language = objectscript ]
method DescriptionIsDefined() as %Boolean [ Language = objectscript ]
method DescriptionReset() [ Language = objectscript ]
method DescriptionSet(value As %String = "") as %Status [ Language = objectscript ]
method FinalIsDefined() as %Boolean [ Language = objectscript ]
method FinalReset() [ Language = objectscript ]
method FinalSet(value As %String = "") as %Status [ Language = objectscript ]
method IdentityIsDefined() as %Boolean [ Language = objectscript ]
method IdentityReset() [ Language = objectscript ]
method IdentitySet(value As %String = "") as %Status [ Language = objectscript ]
method InitialExpressionIsDefined() as %Boolean [ Language = objectscript ]
method InitialExpressionReset() [ Language = objectscript ]
method InitialExpressionSet(value As %String = "") as %Status [ Language = objectscript ]
method InternalIsDefined() as %Boolean [ Language = objectscript ]
method InternalReset() [ Language = objectscript ]
method InternalSet(value As %String = "") as %Status [ Language = objectscript ]
method InverseIsDefined() as %Boolean [ Language = objectscript ]
method InverseReset() [ Language = objectscript ]
method InverseSet(value As %String = "") as %Status [ Language = objectscript ]
method MultiDimensionalIsDefined() as %Boolean [ Language = objectscript ]
method MultiDimensionalReset() [ Language = objectscript ]
method MultiDimensionalSet(value As %String = "") as %Status [ Language = objectscript ]
method NameIsDefined() as %Boolean [ Language = objectscript ]
method NameReset() [ Language = objectscript ]
method NameSet(value As %String = "") as %Status [ Language = objectscript ]
method NoModBitIsDefined() as %Boolean [ Language = objectscript ]
method NoModBitReset() [ Language = objectscript ]
method NoModBitSet(value As %String = "") as %Status [ Language = objectscript ]
method NotInheritableIsDefined() as %Boolean [ Language = objectscript ]
method NotInheritableReset() [ Language = objectscript ]
method NotInheritableSet(value As %String = "") as %Status [ Language = objectscript ]
method OnDeleteIsDefined() as %Boolean [ Language = objectscript ]
method OnDeleteReset() [ Language = objectscript ]
method OnDeleteSet(value As %String = "") as %Status [ Language = objectscript ]
method PrivateIsDefined() as %Boolean [ Language = objectscript ]
method PrivateReset() [ Language = objectscript ]
method PrivateSet(value As %String = "") as %Status [ Language = objectscript ]
method ReadOnlyIsDefined() as %Boolean [ Language = objectscript ]
method ReadOnlyReset() [ Language = objectscript ]
method ReadOnlySet(value As %String = "") as %Status [ Language = objectscript ]
method RelationshipIsDefined() as %Boolean [ Language = objectscript ]
method RelationshipReset() [ Language = objectscript ]
method RelationshipSet(value As %String = "") as %Status [ Language = objectscript ]
method RequiredIsDefined() as %Boolean [ Language = objectscript ]
method RequiredReset() [ Language = objectscript ]
method RequiredSet(value As %String = "") as %Status [ Language = objectscript ]
method SequenceNumberIsDefined() as %Boolean [ Language = objectscript ]
method SequenceNumberReset() [ Language = objectscript ]
method SequenceNumberSet(value As %String = "") as %Status [ Language = objectscript ]
method ServerOnlyIsDefined() as %Boolean [ Language = objectscript ]
method ServerOnlyReset() [ Language = objectscript ]
method ServerOnlySet(value As %String = "") as %Status [ Language = objectscript ]
method SqlCollationIsDefined() as %Boolean [ Language = objectscript ]
method SqlCollationReset() [ Language = objectscript ]
method SqlCollationSet(value As %String = "") as %Status [ Language = objectscript ]
method SqlColumnNumberIsDefined() as %Boolean [ Language = objectscript ]
method SqlColumnNumberReset() [ Language = objectscript ]
method SqlColumnNumberSet(value As %String = "") as %Status [ Language = objectscript ]
method SqlComputeCodeIsDefined() as %Boolean [ Language = objectscript ]
method SqlComputeCodeReset() [ Language = objectscript ]
method SqlComputeCodeSet(value As %String = "") as %Status [ Language = objectscript ]
method SqlComputeOnChangeIsDefined() as %Boolean [ Language = objectscript ]
method SqlComputeOnChangeReset() [ Language = objectscript ]
method SqlComputeOnChangeSet(value As %String = "") as %Status [ Language = objectscript ]
method SqlComputedIsDefined() as %Boolean [ Language = objectscript ]
method SqlComputedReset() [ Language = objectscript ]
method SqlComputedSet(value As %String = "") as %Status [ Language = objectscript ]
method SqlFieldNameIsDefined() as %Boolean [ Language = objectscript ]
method SqlFieldNameReset() [ Language = objectscript ]
method SqlFieldNameSet(value As %String = "") as %Status [ Language = objectscript ]
method SqlListDelimiterIsDefined() as %Boolean [ Language = objectscript ]
method SqlListDelimiterReset() [ Language = objectscript ]
method SqlListDelimiterSet(value As %String = "") as %Status [ Language = objectscript ]
method SqlListTypeIsDefined() as %Boolean [ Language = objectscript ]
method SqlListTypeReset() [ Language = objectscript ]
method SqlListTypeSet(value As %String = "") as %Status [ Language = objectscript ]
method TransientIsDefined() as %Boolean [ Language = objectscript ]
method TransientReset() [ Language = objectscript ]
method TransientSet(value As %String = "") as %Status [ Language = objectscript ]
method TypeIsDefined() as %Boolean [ Language = objectscript ]
method TypeReset() [ Language = objectscript ]
method TypeSet(value As %String = "") as %Status [ Language = objectscript ]
classmethod parentOnDelete(id As %String, concurrency As %Integer) as %Status [ Language = objectscript ]
Indexes
index (IDKEY on Name) [IdKey, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()