Specifies the base location of counters for properties with type is %Library.Counter. Normally this would be a global reference such as ^User.PersonC. The global reference can also include one or more leading subscripts.
Specifies expression that is the location where data is stored for this class. Normally this would be a global reference such as ^User.PersonD. The global reference can also include one or more leading subscripts.
Specifies the name of the DATA definition that the Class Compiler Data Structure Generator uses to place any previously unstored properties. A property is unstored if it is storable, but is not listed in any DATA definition.
For a serial embedded class, this keyword specifies which Data definition is used to define the serialized state of the object. This is also the default DATA definition that unstored properties will be added to by the default structure generator.
Specifies the default global used to store any stream properties within this class. If not specified, the index location is ^MyApp.MyClassS, where MyApp.MyClass is the classname.
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 CounterLocationIsDefined() as %Boolean [ Language = objectscript ]
method CounterLocationReset() [ Language = objectscript ]
method CounterLocationSet(value As %String = "") as %Status [ Language = objectscript ]
method DataLocationIsDefined() as %Boolean [ Language = objectscript ]
method DataLocationReset() [ Language = objectscript ]
method DataLocationSet(value As %String = "") as %Status [ Language = objectscript ]
method DefaultDataIsDefined() as %Boolean [ Language = objectscript ]
method DefaultDataReset() [ Language = objectscript ]
method DefaultDataSet(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 ExtentLocationIsDefined() as %Boolean [ Language = objectscript ]
method ExtentLocationReset() [ Language = objectscript ]
method ExtentLocationSet(value As %String = "") as %Status [ Language = objectscript ]
method ExtentSizeIsDefined() as %Boolean [ Language = objectscript ]
method ExtentSizeReset() [ Language = objectscript ]
method ExtentSizeSet(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 IdExpressionIsDefined() as %Boolean [ Language = objectscript ]
method IdExpressionReset() [ Language = objectscript ]
method IdExpressionSet(value As %String = "") as %Status [ Language = objectscript ]
method IdFunctionIsDefined() as %Boolean [ Language = objectscript ]
classmethod IdFunctionIsValid(val As %String) as %Status [ Language = objectscript ]
method IdFunctionReset() [ Language = objectscript ]
method IdFunctionSet(value As %String = "") as %Status [ Language = objectscript ]
method IdLocationIsDefined() as %Boolean [ Language = objectscript ]
method IdLocationReset() [ Language = objectscript ]
method IdLocationSet(value As %String = "") as %Status [ Language = objectscript ]
method IndexLocationIsDefined() as %Boolean [ Language = objectscript ]
method IndexLocationReset() [ Language = objectscript ]
method IndexLocationSet(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 SequenceNumberIsDefined() as %Boolean [ Language = objectscript ]
method SequenceNumberReset() [ Language = objectscript ]
method SequenceNumberSet(value As %String = "") as %Status [ Language = objectscript ]
method SqlChildSubIsDefined() as %Boolean [ Language = objectscript ]
method SqlChildSubReset() [ Language = objectscript ]
method SqlChildSubSet(value As %String = "") as %Status [ Language = objectscript ]
method SqlIdExpressionIsDefined() as %Boolean [ Language = objectscript ]
method SqlIdExpressionReset() [ Language = objectscript ]
method SqlIdExpressionSet(value As %String = "") as %Status [ Language = objectscript ]
method SqlRowIdNameIsDefined() as %Boolean [ Language = objectscript ]
method SqlRowIdNameReset() [ Language = objectscript ]
method SqlRowIdNameSet(value As %String = "") as %Status [ Language = objectscript ]
method SqlRowIdPropertyIsDefined() as %Boolean [ Language = objectscript ]
method SqlRowIdPropertyReset() [ Language = objectscript ]
method SqlRowIdPropertySet(value As %String = "") as %Status [ Language = objectscript ]
method SqlTableNumberIsDefined() as %Boolean [ Language = objectscript ]
method SqlTableNumberReset() [ Language = objectscript ]
method SqlTableNumberSet(value As %String = "") as %Status [ Language = objectscript ]
method StateIsDefined() as %Boolean [ Language = objectscript ]
method StateReset() [ Language = objectscript ]
method StateSet(value As %String = "") as %Status [ Language = objectscript ]
method StreamLocationIsDefined() as %Boolean [ Language = objectscript ]
method StreamLocationReset() [ Language = objectscript ]
method StreamLocationSet(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 ]
method VersionLocationIsDefined() as %Boolean [ Language = objectscript ]
method VersionLocationReset() [ Language = objectscript ]
method VersionLocationSet(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()