Properties (Including Private)Copy link to this section
List of aliases for this property.
Property methods: AliasesGet(), AliasesIsValid(), AliasesSet()
property Calculated as %Boolean ;
Copy link to this section
Specifies that the property has no in-memory storage allocated for it when the object containing it is instantiated.
Property methods: CalculatedDisplayToLogical(), CalculatedGet(), CalculatedIsValid(), CalculatedLogicalToDisplay(), CalculatedNormalize(), CalculatedSet()
property Cardinality as %CacheString ;
Copy link to this section
Specifies the cardinality of a relationship property. The Cardinality keyword is required for relationship properties. It is ignored by non-relationship properties.
Property methods: CardinalityGet(), CardinalityIsValid(), CardinalitySet()
property ClientName as %CacheString ;
Copy link to this section
ClientName
Property methods: ClientNameGet(), ClientNameIsValid(), ClientNameSet()
property Collection as %CacheString ;
Copy link to this section
Specifies that a property is a collection property as well as what type of collection it is.
Property methods: CollectionGet(), CollectionIsValid(), CollectionSet()
property CompilerGenerated as %Boolean ;
Copy link to this section
CompilerGenerated
Property methods: CompilerGeneratedDisplayToLogical(), CompilerGeneratedGet(), CompilerGeneratedIsValid(), CompilerGeneratedLogicalToDisplay(), CompilerGeneratedNormalize(), CompilerGeneratedSet()
property ComputeDependency as %CacheString ;
Copy link to this section
List of properties referenced by the SQLCOMPUTECODE.
Property methods: ComputeDependencyGet(), ComputeDependencyIsValid(), ComputeDependencySet()
property ComputeTriggers as %CacheString ;
Copy link to this section
List of properties to be computed when this property changes.
Property methods: ComputeTriggersGet(), ComputeTriggersIsValid(), ComputeTriggersSet()
property Deprecated as %Boolean ;
Copy link to this section
True if this property is deprecated.
Property methods: DeprecatedDisplayToLogical(), DeprecatedGet(), DeprecatedIsValid(), DeprecatedLogicalToDisplay(), DeprecatedNormalize(), DeprecatedSet()
property Description as %CacheString ;
Copy link to this section
Specifies a description of the property.
Property methods: DescriptionGet(), DescriptionIsValid(), DescriptionSet()
property DirectRefOnGet as %Boolean ;
Copy link to this section
Deprecated
Property methods: DirectRefOnGetDisplayToLogical(), DirectRefOnGetGet(), DirectRefOnGetIsValid(), DirectRefOnGetLogicalToDisplay(), DirectRefOnGetNormalize(), DirectRefOnGetSet()
property DirectRefOnSet as %Boolean ;
Copy link to this section
Deprecated
Property methods: DirectRefOnSetDisplayToLogical(), DirectRefOnSetGet(), DirectRefOnSetIsValid(), DirectRefOnSetLogicalToDisplay(), DirectRefOnSetNormalize(), DirectRefOnSetSet()
property Final as %Boolean ;
Copy link to this section
Specifies that subclasses cannot override the definition of this property.
Property methods: FinalDisplayToLogical(), FinalGet(), FinalIsValid(), FinalLogicalToDisplay(), FinalNormalize(), FinalSet()
property Id as %Integer ;
Copy link to this section
Id
Property methods: IdDisplayToLogical(), IdGet(), IdIsValid(), IdLogicalToDisplay(), IdNormalize(), IdSet(), IdentityDisplayToLogical(), IdentityGet(), IdentityIsValid(), IdentityLogicalToDisplay(), IdentityNormalize(), IdentitySet()
property Identity as %Boolean [ SqlFieldName = _Identity ];
Copy link to this section
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 methods: IdentityDisplayToLogical(), IdentityGet(), IdentityIsValid(), IdentityLogicalToDisplay(), IdentityNormalize(), IdentitySet()
property InheritedId as %Boolean ;
Copy link to this section
InheritedId
Property methods: InheritedIdDisplayToLogical(), InheritedIdGet(), InheritedIdIsValid(), InheritedIdLogicalToDisplay(), InheritedIdNormalize(), InheritedIdSet()
property InitialExpression as %CacheString ;
Copy link to this section
Specifies an initial value for the property.
Property methods: InitialExpressionGet(), InitialExpressionIsValid(), InitialExpressionSet()
property Internal as %Boolean ;
Copy link to this section
If true, then do not display this item in automatic documentation.
Property methods: InternalDisplayToLogical(), InternalGet(), InternalIsValid(), InternalLogicalToDisplay(), InternalNormalize(), InternalSet()
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 methods: InverseGet(), InverseIsValid(), InverseSet()
property KeywordError as %Boolean ;
Copy link to this section
KeywordError
Property methods: KeywordErrorDisplayToLogical(), KeywordErrorGet(), KeywordErrorIsValid(), KeywordErrorLogicalToDisplay(), KeywordErrorNormalize(), KeywordErrorSet()
property KeywordModified as %Boolean ;
Copy link to this section
KeywordModified
Property methods: KeywordModifiedDisplayToLogical(), KeywordModifiedGet(), KeywordModifiedIsValid(), KeywordModifiedLogicalToDisplay(), KeywordModifiedNormalize(), KeywordModifiedSet()
relationship Methods as array of %Dictionary.CompiledPropertyMethod [ InitialExpression = $listbuild("%Dictionary.CompiledPropertyMethod","parent",+$this,"children",1,1) , Transient , Inverse = parent , Cardinality = children ];
Copy link to this section
Method
Property methods: MethodsGet(), MethodsGetObject(), MethodsGetObjectId(), MethodsGetSwizzled(), MethodsIsEmpty(), MethodsIsValid(), MethodsNewObject(), MethodsRClose(), MethodsRExec(), MethodsRFetch(), MethodsRelate(), MethodsSQLCompute(), MethodsSet(), MethodsUnRelate()
property MultiDimensional as %Boolean ;
Copy link to this section
Specifies that an attribute has the characteristics of a multidimensional array.
Property methods: MultiDimensionalDisplayToLogical(), MultiDimensionalGet(), MultiDimensionalIsValid(), MultiDimensionalLogicalToDisplay(), MultiDimensionalNormalize(), MultiDimensionalSet()
The name of the property.
Property methods: NameGet(), NameIsValid(), NameSet()
property NoModBit as %Boolean ;
Copy link to this section
Deprecated.
Property methods: NoModBitDisplayToLogical(), NoModBitGet(), NoModBitIsValid(), NoModBitLogicalToDisplay(), NoModBitNormalize(), NoModBitSet()
property NotInheritable as %Boolean ;
Copy link to this section
Deprecated.
Property methods: NotInheritableDisplayToLogical(), NotInheritableGet(), NotInheritableIsValid(), NotInheritableLogicalToDisplay(), NotInheritableNormalize(), NotInheritableSet()
property OnDelete as %CacheString ;
Copy link to this section
Specifies what referential action to take when the key value is deleted from the foreign table.
Property methods: OnDeleteExecute(), OnDeleteGet(), OnDeleteIsValid(), OnDeleteSet()
Origin
Property methods: OriginGet(), OriginIsValid(), OriginSet()
property Parameters as array of %CacheString ;
Copy link to this section
Parameter
Property methods: ParametersBuildValueArray(), ParametersCollectionToDisplay(), ParametersCollectionToOdbc(), ParametersDisplayToCollection(), ParametersGet(), ParametersGetObject(), ParametersGetObjectId(), ParametersGetSwizzled(), ParametersIsValid(), ParametersOdbcToCollection(), ParametersSet(), ParametersSetObject(), ParametersSetObjectId()
property Private as %Boolean ;
Copy link to this section
Specifies that the property is private. Private properties can only be used by instance methods of this class or its subclasses.
Property methods: PrivateDisplayToLogical(), PrivateGet(), PrivateIsValid(), PrivateLogicalToDisplay(), PrivateNormalize(), PrivateSet()
property ReadOnly as %Boolean ;
Copy link to this section
Specifies that the property is readonly.
Property methods: ReadOnlyDisplayToLogical(), ReadOnlyGet(), ReadOnlyIsValid(), ReadOnlyLogicalToDisplay(), ReadOnlyNormalize(), ReadOnlySet()
property Relationship as %Boolean ;
Copy link to this section
Specifies that a property is a relationship property.
Property methods: RelationshipDisplayToLogical(), RelationshipGet(), RelationshipIsValid(), RelationshipLogicalToDisplay(), RelationshipNormalize(), RelationshipSet()
property Required as %Boolean ;
Copy link to this section
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 methods: RequiredDisplayToLogical(), RequiredGet(), RequiredIsValid(), RequiredLogicalToDisplay(), RequiredNormalize(), RequiredSet()
property RuntimeType as %CacheString ;
Copy link to this section
RuntimeType
Property methods: RuntimeTypeGet(), RuntimeTypeIsValid(), RuntimeTypeSet()
property SequenceNumber as %Integer ;
Copy link to this section
SequenceNumber
Property methods: SequenceNumberDisplayToLogical(), SequenceNumberGet(), SequenceNumberIsValid(), SequenceNumberLogicalToDisplay(), SequenceNumberNormalize(), SequenceNumberSet()
property ServerOnly as %CacheString ;
Copy link to this section
Specifies that a property will not be projected to a Java or C++ client.
Property methods: ServerOnlyGet(), ServerOnlyIsValid(), ServerOnlySet()
property SqlCollation as %CacheString ;
Copy link to this section
Deprecated.
Property methods: SqlCollationGet(), SqlCollationIsValid(), SqlCollationSet()
property SqlColumnNumber as %CacheString ;
Copy link to this section
Explicitly sets the SQL Column number for this property. This is provided for legacy application support.
Property methods: SqlColumnNumberGet(), SqlColumnNumberIsValid(), SqlColumnNumberSet()
property SqlComputeCode as %CacheString ;
Copy link to this section
Specifies Cache ObjectScript code that evaluates to a computed field value.
Property methods: SqlComputeCodeGet(), SqlComputeCodeIsValid(), SqlComputeCodeSet()
property SqlComputeOnChange as %CacheString ;
Copy link to this section
Specifies one or more properties whose modification triggers the recalculation of this computed field within SQL.
Property methods: SqlComputeOnChangeGet(), SqlComputeOnChangeIsValid(), SqlComputeOnChangeSet()
property SqlComputed as %Boolean ;
Copy link to this section
Specifies that this property is an SQL computed field.
Property methods: SqlComputedDisplayToLogical(), SqlComputedGet(), SqlComputedIsValid(), SqlComputedLogicalToDisplay(), SqlComputedNormalize(), SqlComputedSet()
property SqlFieldName as %CacheString ;
Copy link to this section
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 methods: SqlFieldNameGet(), SqlFieldNameIsValid(), SqlFieldNameSet()
property SqlListDelimiter as %CacheString ;
Copy link to this section
Specifies the delimiter character used within SQL for lists. This is provided for legacy application support.
Property methods: SqlListDelimiterGet(), SqlListDelimiterIsValid(), SqlListDelimiterSet()
property SqlListType as %CacheString ;
Copy link to this section
specifies the representation to be used for a list.
Property methods: SqlListTypeGet(), SqlListTypeIsValid(), SqlListTypeSet()
property Storable as %Boolean ;
Copy link to this section
Storable
Property methods: StorableDisplayToLogical(), StorableGet(), StorableIsValid(), StorableLogicalToDisplay(), StorableNormalize(), StorableSet()
property Transient as %Boolean ;
Copy link to this section
In the case of a persistent class, specifies that the property is not stored in the database.
Property methods: TransientDisplayToLogical(), TransientGet(), TransientIsValid(), TransientLogicalToDisplay(), TransientNormalize(), TransientSet()
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.
Property methods: TypeGet(), TypeIsValid(), TypeSet()
relationship UDLTexts as array of %Dictionary.CompiledPropertyUDLText [ InitialExpression = $listbuild("%Dictionary.CompiledPropertyUDLText","parent",+$this,"children",1,1) , Transient , Inverse = parent , Cardinality = children ];
Copy link to this section
UDLText
Property methods: UDLTextsGet(), UDLTextsGetObject(), UDLTextsGetObjectId(), UDLTextsGetSwizzled(), UDLTextsIsEmpty(), UDLTextsIsValid(), UDLTextsNewObject(), UDLTextsRClose(), UDLTextsRExec(), UDLTextsRFetch(), UDLTextsRelate(), UDLTextsSQLCompute(), UDLTextsSet(), UDLTextsUnRelate()
Pointer to the containing parent object
Property methods: parentCheck(), parentDelete(), parentGet(), parentGetObject(), parentGetObjectId(), parentGetSwizzled(), parentIsValid(), parentNewObject(), parentOnDelete(), parentRClose(), parentRExec(), parentRFetch(), parentRelate(), parentSQLCompute(), parentSet(), parentSetObject(), parentSetObjectId(), parentUnRelate(), parentUnSwizzle()