ODataSchemaAssociation Type

An object representing a single OData schema navigation property and its corresponding association.

Remarks

An object representing a single OData schema navigation property and its corresponding association.

Fields

ContainsTarget
boolean

Whether the navigation property contains a target. If True the navigation property is a containment navigation property.

This field is only applicable to OData Version 4.

Description
String

The documentation long description of the OData schema association.

FromRole
String

The name of the starting point of the navigation.

FromRoleDescription
String

The documentation long description of the OData schema FromRole association end point.

FromRoleEntity
String

The name of the entity that FromRole association end point maps to.

FromRoleMultiplicity
int

The multiplicity of the FromRole association end point. This is used along with ToRoleMultiplicity to determine the cardinality of the relationship (i.e. one-to-one or one-to-many).

The available values are:

nmZeroOne (0) Zero-One (0..1)
nmOne (1) One (1)
nmMany (2) Many (*)

FromRoleSummary
String

The documentation summary of the OData schema FromRole association end point.

Name
String

The Name of the OData schema navigation property.

Nullable
boolean

Whether the property defined by the schema can be a null value. If False then the object must contain a value.

This field is only applicable to OData Version 4.

OnDelete
int

The delete action to be performed.

Possible values are:

0 (daNone) Only the specified entry instance within FromRoleEntity is deleted. This is the default value.
1 (daCascade) After the specified entry instance is deleted within FromRoleEntity, the action is applied to the entry instance within the ToRoleEntity. For example, a single Customer is associated with multiple Orders. When a Customer is deleted, all Orders associated with the Customer will be deleted.
2 (daSetNull) All properties of related entities that are tied to properties of the source entity via a referential constraint and that do not participate in other referential constraints will be set to null. This value is only applicable to OData Version 4.
3 (daSetDefault) All properties of related entities that are tied to properties of the source entity via a referential constraint and that do not participate in other referential constraints will be set to their default value. This value is only applicable to OData Version 4.

Partner
String

The partner value identifying a navigation property (if any).

This field is only applicable to OData Version 4.

RefConstraintCount
int

The number of referential constraints. To examine the individual referential constraints set RefConstraintIndex to a value from 0 to RefConstraintCount -1. For instance:

For i = 0 to odata.SchemaAssociation.RefConstraintCount - 1
    odata.SchemaAssociation.RefConstraintIndex = i;
    Console.Write(odata.SchemaAssociation.RefConstraintProperty);
    Console.Write(odata.SchemaAssociation.RefConstraintReferencedProperty);
Next i

This field is only applicable to OData Version 4.

RefConstraintIndex
int

The current index of the referential constraint. See RefConstraintCount for details.

This field is only applicable to OData Version 4.

RefConstraintProperty
String

The property that takes part in the referential constraint.

This field is only applicable to OData Version 4.

RefConstraintReferencedProperty
String

The corresponding property of the principal entity type.

This field is only applicable to OData Version 4.

Relationship
String

The name of the relationship (association) of the navigation property.

Summary
String

The documentation summary of the OData schema association.

ToRole
String

The name of the end point of the navigation.

ToRoleDescription
String

The documentation long description of the OData schema ToRole association end point.

ToRoleEntity
String

The name of the entity that ToRole association end point maps to.

ToRoleMultiplicity
int

The multiplicity of the ToRole association end point. This is used along with FromRoleMultiplicity to determine the cardinality of the relationship (i.e. one-to-one or one-to-many).

The available values are:

nmZeroOne (0) Zero-One (0..1)
nmOne (1) One (1)
nmMany (2) Many (*)

ToRoleSummary
String

The documentation summary of the OData schema ToRole association end point.

Type
String

The entity type.

This field is only applicable to OData Version 4.

Constructors

public ODataSchemaAssociation();



Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks 2020 Java Edition - Version 20.0 [Build 8307]