%Library.PropertyDefinition

persistent class %Library.PropertyDefinition extends %Library.AbstractDefinition

SQL Table Name: %Library.PropertyDefinition

This class represents a specific property description for a class contained within the Caché Dictionary.

For more information on class definition classes, refer to About Class Definition Classes.

Property Inventory

• Calculated
• Cardinality
• ClassName
• Collection
• Description
• Final
• InitialExpression
• Internal
• Inverse
• MultiDimensional
• Name
• Parameters
• Private
• ReadOnly
• Relationship
• Required
• SequenceNumber
• SqlCollation
• SqlColumnNumber
• SqlComputeCode
• SqlComputeOnChange
• SqlComputed
• SqlFieldName
• SqlListDelimiter
• SqlListType
• Transient
• Type

Properties

property Calculated as %CacheString;

A flag indicating whether the property is calculated (1) or not (0).

Property methods: CalculatedGet(), CalculatedIsValid(), CalculatedSet()

property Cardinality as %CacheString;

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;

A string containing the name of the class the property belongs to.

Property methods: ClassNameGet(), ClassNameIsValid(), ClassNameSet()

property Collection as %CacheString;

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;

A string containing the description of the property.

Property methods: DescriptionGet(), DescriptionIsValid(), DescriptionSet()

property Final as %CacheString;

A flag indicating whether the property is final (1) or not (0).

Property methods: FinalGet(), FinalIsValid(), FinalSet()

property InitialExpression as %CacheString [ InitialExpression = """""" ];

A string containing the initial value expression for the property.

Property methods: InitialExpressionGet(), InitialExpressionIsValid(), InitialExpressionSet()

property Internal as %CacheString;

A flag indicating whether the property is internal (1) or not (0).

Property methods: InternalGet(), InternalIsValid(), InternalSet()

property Inverse as %CacheString;

A string containing the name of the inverse relationship in the related class.

Property methods: InverseGet(), InverseIsValid(), InverseSet()

property MultiDimensional as %CacheString;

A flag indicating whether the property is multi-dimensional (1) or not (0).

Property methods: MultiDimensionalGet(), MultiDimensionalIsValid(), MultiDimensionalSet()

property Name as %CacheString;

A string containing the name of the property.

Property methods: NameGet(), NameIsValid(), NameSet()

property Parameters as array of %CacheString;

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()

property Private as %CacheString;

A flag indicating whether the property is private (1) or public (0).

Property methods: PrivateGet(), PrivateIsValid(), PrivateSet()

property ReadOnly as %CacheString;

A flag indicating whether the property is a readonly (1) or writeable (0).

Property methods: ReadOnlyGet(), ReadOnlyIsValid(), ReadOnlySet()

property Relationship as %CacheString;

A flag indicating whether the property is a relationship (1) or attribute (0).

Property methods: RelationshipGet(), RelationshipIsValid(), RelationshipSet()

property Required as %CacheString;

A flag indicating whether the property is required (1) or not (0).

Property methods: RequiredGet(), RequiredIsValid(), RequiredSet()

property SequenceNumber as %CacheString;

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;

A string containing the name of the class this method belongs to.

Property methods: SqlCollationGet(), SqlCollationIsValid(), SqlCollationSet()

property SqlColumnNumber as %CacheString;

The column number used when projecting the property as an SQL table.

Property methods: SqlColumnNumberGet(), SqlColumnNumberIsValid(), SqlColumnNumberSet()

property SqlComputeCode as %CacheString;

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;

Property methods: SqlComputeOnChangeGet(), SqlComputeOnChangeIsValid(), SqlComputeOnChangeSet()

property SqlComputed as %CacheString;

A flag indicating whether the property is SQL-computed (1) or not (0).

Property methods: SqlComputedGet(), SqlComputedIsValid(), SqlComputedSet()

property SqlFieldName as %CacheString;

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;

Property methods: SqlListDelimiterGet(), SqlListDelimiterIsValid(), SqlListDelimiterSet()

property SqlListType as %CacheString;

Property methods: SqlListTypeGet(), SqlListTypeIsValid(), SqlListTypeSet()

property Transient as %CacheString;

A flag indicating whether the property is transient (1) or not (0).

Property methods: TransientGet(), TransientIsValid(), TransientSet()

property Type as %CacheString;

A string containing the type (class name) of the field.

Property methods: TypeGet(), TypeIsValid(), TypeSet()

Indexes

index (IDKEY on ) [IdKey, Type = key];

Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()