property Extent as %Boolean [ InitialExpression = 0 ];
An extent index is used to keep track of which object instances belong to a subclass. When using bitmap indices, then an extent index is automatically maintained and there is no need to define one.
property IdKey as %Boolean [ InitialExpression = 0 ];
Specifies that the property or properties defined for this index will be used to form the Object Identity value for this object. This value is used to uniquely locate persistent object instances.
Specifies whether this is a unique index. The property or properties indexed by a unique index are constrained to have unique values. This means that no two instances can have the same collated value within the extent among the set of all objects of the class that defines the index.
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 AbstractIsDefined() as %Boolean [ Language = objectscript ]
method AbstractReset() [ Language = objectscript ]
method AbstractSet(value As %String = "") as %Status [ Language = objectscript ]
method ConditionIsDefined() as %Boolean [ Language = objectscript ]
method ConditionReset() [ Language = objectscript ]
method ConditionSet(value As %String = "") as %Status [ Language = objectscript ]
method CoshardWithIsDefined() as %Boolean [ Language = objectscript ]
method CoshardWithReset() [ Language = objectscript ]
method CoshardWithSet(value As %String = "") as %Status [ Language = objectscript ]
method DataIsDefined() as %Boolean [ Language = objectscript ]
method DataReset() [ Language = objectscript ]
method DataSet(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 ExtentIsDefined() as %Boolean [ Language = objectscript ]
method ExtentReset() [ Language = objectscript ]
method ExtentSet(value As %String = "") as %Status [ Language = objectscript ]
method IdKeyIsDefined() as %Boolean [ Language = objectscript ]
method IdKeyReset() [ Language = objectscript ]
method IdKeySet(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 NameIsDefined() as %Boolean [ Language = objectscript ]
method NameReset() [ Language = objectscript ]
method NameSet(value As %String = "") as %Status [ Language = objectscript ]
method PrimaryKeyIsDefined() as %Boolean [ Language = objectscript ]
method PrimaryKeyReset() [ Language = objectscript ]
method PrimaryKeySet(value As %String = "") as %Status [ Language = objectscript ]
method PropertiesIsDefined() as %Boolean [ Language = objectscript ]
method PropertiesReset() [ Language = objectscript ]
method PropertiesSet(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 ShardKeyIsDefined() as %Boolean [ Language = objectscript ]
method ShardKeyReset() [ Language = objectscript ]
method ShardKeySet(value As %String = "") as %Status [ Language = objectscript ]
method SqlNameIsDefined() as %Boolean [ Language = objectscript ]
method SqlNameReset() [ Language = objectscript ]
method SqlNameSet(value As %String = "") as %Status [ Language = objectscript ]
method TypeClassIsDefined() as %Boolean [ Language = objectscript ]
method TypeClassReset() [ Language = objectscript ]
method TypeClassSet(value As %String = "") as %Status [ Language = objectscript ]
method TypeIsDefined() as %Boolean [ Language = objectscript ]
classmethod TypeIsValid(val As %String) as %Status [ Language = objectscript ]
method TypeReset() [ Language = objectscript ]
method TypeSet(value As %String = "") as %Status [ Language = objectscript ]
method UniqueIsDefined() as %Boolean [ Language = objectscript ]
method UniqueReset() [ Language = objectscript ]
method UniqueSet(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()