Relation Schema
Relation Element
Relation Schema : Relation Element

Glossary Item Box

Description

A definition of one type of link between two entity types.
Namespace (none)

Diagram

AggregatedRelations Element StorageDescriptor Element Label Element Features Element Required Element TargetEntity Element SourceEntity Element Alias Element Sequence TargetAliases Element All Relation Element

Overview

Relation
A definition of one type of link between two entity types.
Name required xs:string
Do not use the Name to indicate a relation in a cross-query, use an alias.
typeDefinedBy optional xs:string
The entity type on which the relation is defined.
All
TargetAliases AliasComplexType Complex Type
The phrases used to reference the target in a query.
Sequence
Alias 1..∞
Name optional xs:string
The phrase used to reference the entity in the query.
Unique optional xs:boolean
Indicates whether this alias is unique for this entity's relations
SourceEntity xs:string
The entity type of the source of the link.
TargetEntity xs:string
The entity type of the target of the link.
Required optional xs:boolean
For future use.
Features optional
For internal use by Micro Focus and partners in implementing integrations.
Label optional
The display label.
StorageDescriptor
A collection of descriptions of the data models of the relations. The model does not reflect physical storage.
Choice
AssociationStorage
A description of the data model of a 1-to-1 or 1-to-many association.
ReferenceStorage
A description of the data model of a one-to-many relation.
AggregatedRelations optional
The collection of the many-to-many relations implemented with multiple one-to-many relations.

Attributes

NameTypeUseDefaultFixedDescription
Namexs:stringrequired  Do not use the Name to indicate a relation in a cross-query, use an alias.
typeDefinedByxs:stringoptional  The entity type on which the relation is defined.

Source

<xs:element name="Relation" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>
                A definition of one type of link between two entity types.
            </xs:documentation>
  </xs:annotation>
  <xs:complexType>
    <xs:all>
      <xs:element name="TargetAliases" type="AliasComplexType">
        <xs:annotation>
          <xs:documentation>
                            The phrases used to reference the target in a query.
                        </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="SourceEntity" type="xs:string">
        <xs:annotation>
          <xs:documentation>
                            The entity type of the source of the link.
                        </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="TargetEntity" type="xs:string">
        <xs:annotation>
          <xs:documentation>
                            The entity type of the target of the link.
                        </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="Required" type="xs:boolean" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
                            For future use.
                        </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element ref="Features" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
                            For internal use by Micro Focus and partners in implementing integrations.
                        </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="Label" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
                            The display label.
                        </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="StorageDescriptor">
        <xs:annotation>
          <xs:documentation>
                            A collection of descriptions of the data models of the relations. The model does not reflect
                            physical storage.
                        </xs:documentation>
        </xs:annotation>
        <xs:complexType>
          <xs:choice>
            <xs:element ref="AssociationStorage">
              <xs:annotation>
                <xs:documentation>
                                        A description of the data model of a many-to-many relation.
                                    </xs:documentation>
              </xs:annotation>
            </xs:element>
            <xs:element ref="ReferenceStorage">
              <xs:annotation>
                <xs:documentation>
                                        A description of the data model of a one-to-many relation.
                                    </xs:documentation>
              </xs:annotation>
            </xs:element>
          </xs:choice>
        </xs:complexType>
      </xs:element>
      <xs:element ref="AggregatedRelations" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
                            The collection of the many-to-many relations implemented with multiple one-to-many
                            relations.
                        </xs:documentation>
        </xs:annotation>
      </xs:element>
    </xs:all>
    <xs:attribute name="Name" type="xs:string" use="required">
      <xs:annotation>
        <xs:documentation>
                        Do not use the Name to indicate a relation in a cross-query, use an alias.
                    </xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="typeDefinedBy" type="xs:string" use="optional">
      <xs:annotation>
        <xs:documentation>
                        The entity type on which the relation is defined.
                    </xs:documentation>
      </xs:annotation>
    </xs:attribute>
  </xs:complexType>
</xs:element>

See Also