mcs/class/referencesource/System.Data.Entity/System/Data/Metadata/Edm/AssociationSetEnd.cs

   1 //---------------------------------------------------------------------
   2 // <copyright file="AssociationSetEnd.cs" company="Microsoft">
   3 //      Copyright (c) Microsoft Corporation.  All rights reserved.
   4 // </copyright>
   5 //
   6 // @owner       Microsoft
   7 // @backupOwner Microsoft
   8 //---------------------------------------------------------------------
   9 using System;
  10 using System.Collections.Generic;
  11 using System.Data.Common;
  12 using System.Text;
  13
  14
  15 namespace System.Data.Metadata.Edm
  16 {
  17     /// <summary>
  18     /// Class representing a AssociationSet End
  19     /// </summary>
  20     public sealed class AssociationSetEnd : MetadataItem
  21     {
  22         #region Constructors
  23         /// <summary>
  24         /// Initializes a new instance of AssocationSetEnd
  25         /// </summary>
  26         /// <param name="entitySet">Entity set that this end refers to</param>
  27         /// <param name="parentSet">The association set which this belongs to</param>
  28         /// <param name="endMember">The end member of the association set which this is an instance of</param>
  29         /// <exception cref="System.ArgumentNullException">Thrown if either the role,entitySet, parentSet or endMember arguments are null </exception>
  30         internal AssociationSetEnd(EntitySet entitySet, AssociationSet parentSet, AssociationEndMember endMember)
  31         {
  32             _entitySet = EntityUtil.GenericCheckArgumentNull(entitySet, "entitySet");
  33             _parentSet = EntityUtil.GenericCheckArgumentNull(parentSet, "parentSet");
  34             _endMember = EntityUtil.GenericCheckArgumentNull(endMember, "endMember");
  35         }
  36         #endregion
  37
  38         #region Fields
  39         private readonly EntitySet _entitySet;
  40         private readonly AssociationSet _parentSet;
  41         private readonly AssociationEndMember _endMember;
  42         #endregion
  43
  44         #region Properties
  45         /// <summary>
  46         /// Returns the kind of the type
  47         /// </summary>
  48         public override BuiltInTypeKind BuiltInTypeKind { get { return BuiltInTypeKind.AssociationSetEnd; } }
  49
  50         /// <summary>
  51         /// The parent association set for this AssociationSetEnd.
  52         /// </summary>
  53         /// <exception cref="System.ArgumentNullException">Thrown if the value passed in for the setter is null </exception>
  54         /// <exception cref="System.InvalidOperationException">Thrown if Setter is called when the AssociationSetEnd instance is in ReadOnly state</exception>
  55         [MetadataProperty(BuiltInTypeKind.AssociationSet, false)]
  56         public AssociationSet ParentAssociationSet
  57         {
  58             get
  59             {
  60                 return _parentSet;
  61             }
  62         }
  63
  64         /// <summary>
  65         /// The EndMember which this AssociationSetEnd corresponds to.
  66         /// </summary>
  67         /// <exception cref="System.ArgumentNullException">Thrown if the value passed in for the setter is null </exception>
  68         /// <exception cref="System.InvalidOperationException">Thrown if Setter is called when the AssociationSetEnd instance is in ReadOnly state</exception>
  69         [MetadataProperty(BuiltInTypeKind.AssociationEndMember, false)]
  70         public AssociationEndMember CorrespondingAssociationEndMember
  71         {
  72             get
  73             {
  74                 return _endMember;
  75             }
  76         }
  77
  78         /// <summary>
  79         /// Name of the end
  80         /// </summary>
  81         [MetadataProperty(PrimitiveTypeKind.String, false)]
  82         public string Name
  83         {
  84             get
  85             {
  86                 return CorrespondingAssociationEndMember.Name;
  87             }
  88         }
  89
  90         /// <summary>
  91         /// Name of the end role
  92         /// </summary>
  93         /// <exception cref="System.ArgumentNullException">Thrown if the value passed in for the setter is null </exception>
  94         /// <exception cref="System.InvalidOperationException">Thrown if Setter is called when the AssociationSetEnd instance is in ReadOnly state</exception>
  95         [MetadataProperty(PrimitiveTypeKind.String, false)]
  96         [Obsolete("This property is going away, please use the Name property instead")]
  97         public string Role
  98         {
  99             get
 100             {
 101                 return Name;
 102             }
 103         }
 104
 105         /// <summary>
 106         /// Returns the entity set referred by this end role
 107         /// </summary>
 108         [MetadataProperty(BuiltInTypeKind.EntitySet, false)]
 109         public EntitySet EntitySet
 110         {
 111             get
 112             {
 113                 return _entitySet;
 114             }
 115         }
 116
 117         /// <summary>
 118         /// Gets the identity of this item
 119         /// </summary>
 120         internal override string Identity
 121         {
 122             get
 123             {
 124                 return this.Name;
 125             }
 126         }
 127         #endregion
 128
 129         #region Methods
 130         /// <summary>
 131         /// Overriding System.Object.ToString to provide better String representation
 132         /// for this type.
 133         /// </summary>
 134         public override string ToString()
 135         {
 136             return Name;
 137         }
 138
 139         /// <summary>
 140         /// Sets this item to be readonly, once this is set, the item will never be writable again.
 141         /// </summary>
 142         internal override void SetReadOnly()
 143         {
 144             if (!IsReadOnly)
 145             {
 146                 base.SetReadOnly();
 147
 148                 AssociationSet parentAssociationSet = ParentAssociationSet;
 149                 if (parentAssociationSet != null)
 150                 {
 151                     parentAssociationSet.SetReadOnly();
 152                 }
 153
 154                 AssociationEndMember endMember = CorrespondingAssociationEndMember;
 155                 if (endMember != null)
 156                 {
 157                     endMember.SetReadOnly();
 158                 }
 159
 160                 EntitySet entitySet = EntitySet;
 161                 if (entitySet != null)
 162                 {
 163                     entitySet.SetReadOnly();
 164                 }
 165             }
 166         }
 167         #endregion
 168     }
 169 }