Class: PropertyDescriptor

PropertyDescriptor

new PropertyDescriptor()

Describes a property of objects of a certain type.
Deprecated:
  • Yes
Source:

Extends

  • external:Montage

Members

cardinality :number

Cardinality of the property descriptor. The Cardinality of an property descriptor is the number of values that can be stored. A cardinality of one means that only one object can be stored. Only positive values are legal. A value of infinity means that any number of values can be stored.
Type:
  • number
Default Value:
  • 1
Source:

collectionValueType :string

Type:
  • string
Source:

definition :string

Definition can be used to express a property as the result of evaluating an expressionAn example would be to flatten/traverse two properties across two objects to make itscontent accessible as a new property name. For example, in a many to many relationalstyle, a Movie would have a toDirector property to a "DirectorRole" which itself wouldpoint through a toTalent property to the actual Person. A "director" property definitionwould then be "toDirector.toTalent"TODO: It is likely that if a property has a definition, it should return true to isDerivedand false to serializable
Type:
  • string
Source:

denyDelete :boolean

Type:
  • boolean
Default Value:
  • false
Source:

enumValues :Array

List of values for enumerated value types
Type:
  • Array
Source:

(readonly) identifier :string

The identifier is the name of the descriptor, dot, the name of the property descriptor, and is used to make the serialization of property descriptors more readable.
Type:
  • string
Source:

(readonly) isAssociationBlueprint :boolean

Type:
  • boolean
Deprecated:
  • Yes
Default Value:
  • false
Source:

isDerived :boolean

Type:
  • boolean
Default Value:
  • false
Source:

isOptional :boolean

Type:
  • boolean
Source:

isRelationship :boolean

Type:
  • boolean
Source:

(readonly) isToMany :boolean

Returns true if the cardinality is more than one.
Type:
  • boolean
Default Value:
  • false
Source:

mandatory :boolean

Type:
  • boolean
Default Value:
  • false
Source:

(readonly) name :string

Name of the object. The name is used to define the property on the object.
Type:
  • string
Source:

owner

Component description attached to this property descriptor.
Source:

readOnly :boolean

Type:
  • boolean
Default Value:
  • false
Source:

serializable :boolean

possible values are: "reference" | "value" | "auto" | true | false,
Type:
  • boolean
Default Value:
  • false
Source:

valueDescriptor :string

Promise for the descriptor targeted by this association. **Note**: The setter expects an actual descriptor but the getter will return a promise.
Type:
  • string
Source:

valueObjectModuleId :string

Type:
  • string
Source:

valueObjectPrototypeName :string

Type:
  • string
Source:

valueType :string

TODO: This is semantically similar to valueDescriptorWe should check if valueDescriptor can do the same job and eliminatethis.
Type:
  • string
Source:

Methods

initWithNameBlueprintAndCardinality(name, objectDescriptor, cardinality)

Initialize a newly allocated property descriptor.
Parameters:
Name Type Description
name string name of the property descriptor to create
objectDescriptor ObjectDescriptor
cardinality number name of the property descriptor to create
Deprecated:
  • Yes
Source:
Returns:
itself

initWithNameObjectDescriptorAndCardinality(name, objectDescriptor, cardinality)

Initialize a newly allocated property descriptor.
Parameters:
Name Type Description
name string name of the property descriptor to create
objectDescriptor ObjectDescriptor
cardinality number name of the property descriptor to create
Source:
Returns:
itself

PropertyDescriptor

new PropertyDescriptor()

Source:

Members

cardinality :number

Cardinality of the property descriptor. The Cardinality of an property descriptor is the number of values that can be stored. A cardinality of one means that only one object can be stored. Only positive values are legal. A value of infinity means that any number of values can be stored.
Type:
  • number
Default Value:
  • 1
Source:

collectionValueType :string

Type:
  • string
Source:

definition :string

Definition can be used to express a property as the result of evaluating an expressionAn example would be to flatten/traverse two properties across two objects to make itscontent accessible as a new property name. For example, in a many to many relationalstyle, a Movie would have a toDirector property to a "DirectorRole" which itself wouldpoint through a toTalent property to the actual Person. A "director" property definitionwould then be "toDirector.toTalent"TODO: It is likely that if a property has a definition, it should return true to isDerivedand false to serializable
Type:
  • string
Source:

denyDelete :boolean

Type:
  • boolean
Default Value:
  • false
Source:

enumValues :Array

List of values for enumerated value types
Type:
  • Array
Source:

(readonly) identifier :string

The identifier is the name of the descriptor, dot, the name of the property descriptor, and is used to make the serialization of property descriptors more readable.
Type:
  • string
Source:

(readonly) isAssociationBlueprint :boolean

Type:
  • boolean
Deprecated:
  • Yes
Default Value:
  • false
Source:

isDerived :boolean

Type:
  • boolean
Default Value:
  • false
Source:

isOptional :boolean

Type:
  • boolean
Source:

isRelationship :boolean

Type:
  • boolean
Source:

(readonly) isToMany :boolean

Returns true if the cardinality is more than one.
Type:
  • boolean
Default Value:
  • false
Source:

mandatory :boolean

Type:
  • boolean
Default Value:
  • false
Source:

(readonly) name :string

Name of the object. The name is used to define the property on the object.
Type:
  • string
Source:

owner

Component description attached to this property descriptor.
Source:

readOnly :boolean

Type:
  • boolean
Default Value:
  • false
Source:

serializable :boolean

possible values are: "reference" | "value" | "auto" | true | false,
Type:
  • boolean
Default Value:
  • false
Source:

valueDescriptor :string

Promise for the descriptor targeted by this association. **Note**: The setter expects an actual descriptor but the getter will return a promise.
Type:
  • string
Source:

valueObjectModuleId :string

Type:
  • string
Source:

valueObjectPrototypeName :string

Type:
  • string
Source:

valueType :string

TODO: This is semantically similar to valueDescriptorWe should check if valueDescriptor can do the same job and eliminatethis.
Type:
  • string
Source:

Methods

initWithNameBlueprintAndCardinality(name, objectDescriptor, cardinality)

Initialize a newly allocated property descriptor.
Parameters:
Name Type Description
name string name of the property descriptor to create
objectDescriptor ObjectDescriptor
cardinality number name of the property descriptor to create
Deprecated:
  • Yes
Source:
Returns:
itself

initWithNameObjectDescriptorAndCardinality(name, objectDescriptor, cardinality)

Initialize a newly allocated property descriptor.
Parameters:
Name Type Description
name string name of the property descriptor to create
objectDescriptor ObjectDescriptor
cardinality number name of the property descriptor to create
Source:
Returns:
itself