2.1.8 TEntitySet

  • Article

The TEntitySet complex type annotates the EntitySet element, as defined in [MC-CSDL] section 2.1.18. The EntitySet element defines a named set that can contain instances of an entity. More than one EntitySet element for a particular EntityType can be defined.

The TEntitySet complex type is defined in the schema as follows.

 <xs:complexType name="TEntitySet">
   <xs:attribute name="Caption" type="xs:string" use="optional" />
   <xs:attribute name="CollectionCaption" type="xs:string" use="optional" />
   <xs:attribute name="ReferenceName" type="xs:string" use="optional" />
   <xs:attribute name="Hidden" type="xs:boolean" default="false" use="optional" />
   <xs:attribute name="LineageTag" type="xs:string" use="optional" />
   <xs:attribute name="Private" type="xs:boolean" default="false" use="optional" />
   <xs:attribute name="ShowAsVariationsOnly" type="xs:boolean" default="false" use="optional" />
 </xs:complexType>
 

The attributes that are defined by the TEntitySet complex type are specified in the following table.

Attribute

Description

Caption

Contains a user-friendly display name for the entity. If no caption is set in the model, no caption is displayed.

CollectionCaption

Contains the plural name for the entity.

ReferenceName

Contains the unmerged and fully qualified name of the entity, that is, the original CubeDimension ([MS-SSAS] section 2.2.4.2.2.9.1) name before munging.

Hidden

Indicates whether the entity is hidden. If the value of this attribute is "true", the entity is hidden.

LineageTag<47>

Returns a tag that represents the lineage of the entity.

Private<48>

Indicates whether the entity is private. If the value of this attribute is "true", the entity is private.

ShowAsVariationsOnly<49>

Indicates whether the entity is referenced as a variation. If the value of the attribute is "true", the entity is shown only when it is referenced as a variation.