Share via

2.1.27 ReferenceType

  • Article

ReferenceType is used to specify the reference to an actual entity either in the return type or in a parameter definition. The reference type can be specified as an attribute or by using child element syntax.

The following is an example of the ReferenceType in a return type.

 <ReferenceType Type="Model.Person" />

The following is an example of the ReferenceType in a parameter definition.

 <ReturnType>
       <CollectionType>
             <ReferenceType Type="Model.Person" />
       </CollectionType>
 </ReturnType>

The following is an example of the ReferenceType as an attribute.

 <ReturnType Type="Ref(Model.Person)" />

The following rules apply to the ReferenceType element:

  • The Type attribute on a ReferenceType element MUST always be defined.

  • The Type of the reference MUST always be of EntityType.

  • ReferenceType can contain any number of AnnotationAttribute attributes. The full names of the AnnotationAttribute attributes cannot collide.

  • ReferenceType elements can contain at most one Documentation element.

  • ReferenceType elements can contain any number of AnnotationElement elements.

  • AnnotationElement is last in the sequence of child elements of ReferenceType.

Graphic representation in table format of the rules that apply to the ReferenceType element.

All child elements are to appear in the order indicated.