For more information on class definition classes, refer to
About Class Definition Classes.
Properties (Including Private)Copy link to this section
property Calculated as %CacheString ;
Copy link to this section
A flag indicating whether the property is calculated (1) or not (0).
Property methods: CalculatedGet(), CalculatedIsValid(), CalculatedSet()
property Cardinality as %CacheString ;
Copy link to this section
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 methods: CardinalityGet(), CardinalityIsValid(), CardinalitySet()
property ClassName as %CacheString ;
Copy link to this section
A string containing the name of the class the property belongs to.
Property methods: ClassNameGet(), ClassNameIsValid(), ClassNameSet()
property Collection as %CacheString ;
Copy link to this section
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 methods: CollectionGet(), CollectionIsValid(), CollectionSet()
property Description as %CacheString ;
Copy link to this section
A string containing the description of the property.
Property methods: DescriptionGet(), DescriptionIsValid(), DescriptionSet()
A flag indicating whether the property is final (1) or not (0).
Property methods: FinalGet(), FinalIsValid(), FinalSet()
property InitialExpression as %CacheString [ InitialExpression = """""" ];
Copy link to this section
A string containing the initial value expression for the property.
Property methods: InitialExpressionGet(), InitialExpressionIsValid(), InitialExpressionSet()
property Internal as %CacheString ;
Copy link to this section
A flag indicating whether the property is internal (1) or not (0).
Property methods: InternalGet(), InternalIsValid(), InternalSet()
A string containing the name of the inverse relationship in the related class.
Property methods: InverseGet(), InverseIsValid(), InverseSet()
property MultiDimensional as %CacheString ;
Copy link to this section
A flag indicating whether the property is multi-dimensional (1) or not (0).
Property methods: MultiDimensionalGet(), MultiDimensionalIsValid(), MultiDimensionalSet()
A string containing the name of the property.
Property methods: NameGet(), NameIsValid(), NameSet()
property Parameters as array of %CacheString ;
Copy link to this section
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 methods: ParametersBuildValueArray(), ParametersCollectionToDisplay(), ParametersCollectionToOdbc(), ParametersDisplayToCollection(), ParametersGet(), ParametersGetObject(), ParametersGetObjectId(), ParametersGetSwizzled(), ParametersIsValid(), ParametersOdbcToCollection(), ParametersSet(), ParametersSetObject(), ParametersSetObjectId()
A flag indicating whether the property is private (1) or public (0).
Property methods: PrivateGet(), PrivateIsValid(), PrivateSet()
property ReadOnly as %CacheString ;
Copy link to this section
A flag indicating whether the property is a readonly (1) or writeable (0).
Property methods: ReadOnlyGet(), ReadOnlyIsValid(), ReadOnlySet()
property Relationship as %CacheString ;
Copy link to this section
A flag indicating whether the property is a relationship (1) or attribute (0).
Property methods: RelationshipGet(), RelationshipIsValid(), RelationshipSet()
property Required as %CacheString ;
Copy link to this section
A flag indicating whether the property is required (1) or not (0).
Property methods: RequiredGet(), RequiredIsValid(), RequiredSet()
property SequenceNumber as %CacheString ;
Copy link to this section
Sequence number used to determine order of this item in Studio editor and in XML export format.
Property methods: SequenceNumberGet(), SequenceNumberIsValid(), SequenceNumberSet()
property SqlCollation as %CacheString ;
Copy link to this section
A string containing the name of the class this method belongs to.
Property methods: SqlCollationGet(), SqlCollationIsValid(), SqlCollationSet()
property SqlColumnNumber as %CacheString ;
Copy link to this section
The column number used when projecting the property as an SQL table.
Property methods: SqlColumnNumberGet(), SqlColumnNumberIsValid(), SqlColumnNumberSet()
property SqlComputeCode as %CacheString ;
Copy link to this section
For an SQL-computed field this is a string containing any SQL compute code for the field.
Property methods: SqlComputeCodeGet(), SqlComputeCodeIsValid(), SqlComputeCodeSet()
property SqlComputeOnChange as %CacheString ;
Copy link to this section
Property methods: SqlComputeOnChangeGet(), SqlComputeOnChangeIsValid(), SqlComputeOnChangeSet()
property SqlComputed as %CacheString ;
Copy link to this section
A flag indicating whether the property is SQL-computed (1) or not (0).
Property methods: SqlComputedGet(), SqlComputedIsValid(), SqlComputedSet()
property SqlFieldName as %CacheString ;
Copy link to this section
A string containing an optional SQL name for the property. This is the name with
which the property is projected to SQL.
Property methods: SqlFieldNameGet(), SqlFieldNameIsValid(), SqlFieldNameSet()
property SqlListDelimiter as %CacheString ;
Copy link to this section
Property methods: SqlListDelimiterGet(), SqlListDelimiterIsValid(), SqlListDelimiterSet()
property SqlListType as %CacheString ;
Copy link to this section
Property methods: SqlListTypeGet(), SqlListTypeIsValid(), SqlListTypeSet()
property Transient as %CacheString ;
Copy link to this section
A flag indicating whether the property is transient (1) or not (0).
Property methods: TransientGet(), TransientIsValid(), TransientSet()
A string containing the type (class name) of the field.
Property methods: TypeGet(), TypeIsValid(), TypeSet()
Methods (Including Private)Copy link to this section
private method %LoadData(id As %String ) as %Status
Copy link to this section
Inherited description: %LoadData() - loads an object from storage. This method is
implemented by the storage class.
private method %OnNew(initvalue As %String ) as %Status
Copy link to this section
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 %OnValidateObject() as %Status
Copy link to this section
Inherited description: This callback method is invoked by the
%ValidateObject() method to
provide notification that the current object is being validated.
If this method returns an error then %ValidateObject() will fail.
private method %SaveData(id As %String ) as %Status
Copy link to this section
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.