Share via

2.7.14 Entity.InstanceSelection

  • Article

The Entity.InstanceSelection element specifies the behavior of the client application for selecting instances of the entity, based upon the expected number of total instances.

The Entity.InstanceSelection element MUST be specified. Its value MUST be a String that is one of the following:

Dropdown: Specifies that the number of instances is small enough to fit in a simple dropdown.

List: Specifies that the number of instances is too large for a simple dropdown but does not require pre-filtering.

FilteredList: Specifies that the number of instances is large enough to require the user to initially filter the values before selecting instances.

MandatoryFilter: Specifies that the number of instances is so large to prohibit users from building queries on this entity without filtering.

The following is the parent element of the Entity.InstanceSelection element.

Parent elements

Entity

The following is the XML Schema definition of the Entity.InstanceSelection element.

 <xsd:element name="InstanceSelection">
   <xsd:simpleType>
     <xsd:restriction base="xsd:string">
       <xsd:enumeration value="FilteredList" />
       <xsd:enumeration value="Dropdown" />
       <xsd:enumeration value="List" />
       <xsd:enumeration value="MandatoryFilter" />
     </xsd:restriction>
   </xsd:simpleType>
 </xsd:element>