//---------------------------------------------------------------------
// <copyright file="EntityCollectionChangedParams.cs" company="Microsoft">
//      Copyright (c) Microsoft Corporation.  All rights reserved.
// </copyright>
// <summary>
//   EntityCollectionChangedParams class
// </summary>
//
//---------------------------------------------------------------------
 
namespace System.Data.Services.Client
{
#region Namespaces
    using System.Collections;
    using System.Collections.Specialized;
#endregion    
 
    /// <summary>Encapsulates the arguments of an EntityCollectionChanged delegate</summary>
    [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1704", Justification = "Name gets too long with Parameters")]
    public sealed class EntityCollectionChangedParams
    {
        #region Fields
        
        /// <summary>Context associated with the BindingObserver.</summary>
        private readonly DataServiceContext context;
 
        /// <summary>
        /// The source object that references the target object through a collection navigation property.
        /// </summary>
        private readonly object sourceEntity;
 
        /// <summary>The property of the source object that references the collection that has changed.</summary>
        private readonly string propertyName;
 
        /// <summary>The entity set of the source object.</summary>
        private readonly string sourceEntitySet;
 
        /// <summary>The collection that has changed.</summary>
        private readonly ICollection collection;
 
        /// <summary>The target entity object involved in the change.</summary>
        private readonly object targetEntity;
 
        /// <summary>The entity set name of the target object.</summary>
        private readonly string targetEntitySet;
 
        /// <summary>
        /// The action that indicates how the collection was changed. The value will be Add or Remove.
        /// </summary>
        private readonly NotifyCollectionChangedAction action;
 
        #endregion
 
        #region Constructor
        
        /// <summary>
        /// Construct an EntityCollectionChangedParams object.
        /// </summary>
        /// <param name="context">The DataServiceContext associated with the BindingObserver.</param>
        /// <param name="sourceEntity">The source object that references the target object through a collection navigation property.</param>
        /// <param name="propertyName">The property of the source object that references the collection that has changed.</param>
        /// <param name="sourceEntitySet">The entity set of the source object.</param>
        /// <param name="collection">The collection that has changed.</param>
        /// <param name="targetEntity">The target entity object involved in the change.</param>
        /// <param name="targetEntitySet">The entity set name of the target object.</param>
        /// <param name="action">The action that indicates how the collection was changed. The value will be Add or Remove.</param>
        internal EntityCollectionChangedParams(
            DataServiceContext context,
            object sourceEntity,
            string propertyName,
            string sourceEntitySet,
            ICollection collection,
            object targetEntity,
            string targetEntitySet,
            NotifyCollectionChangedAction action)
        {
            this.context = context;
            this.sourceEntity = sourceEntity;
            this.propertyName = propertyName;
            this.sourceEntitySet = sourceEntitySet;
            this.collection = collection;
            this.targetEntity = targetEntity;
            this.targetEntitySet = targetEntitySet;
            this.action = action;
        }
        
        #endregion
 
        #region Properties
        
        /// <summary>Context to which source and target entities belong.</summary>
        public DataServiceContext Context
        {
            get { return this.context; }
        }
 
        /// <summary>
        /// The source object that references the target object through a collection navigation property.
        /// </summary>
        public object SourceEntity
        {
            get { return this.sourceEntity; }
        }
 
        /// <summary>
        /// The property of the source object that references the collection that has changed.
        /// </summary>
        public string PropertyName
        {
            get { return this.propertyName; }
        }
 
        /// <summary>The entity set of the source object.</summary>
        public string SourceEntitySet
        {
            get { return this.sourceEntitySet; }
        }
 
        /// <summary>The target entity object involved in the change.</summary>
        public object TargetEntity
        {
            get { return this.targetEntity; }
        }
 
        /// <summary>The entity set name of the target object.</summary>
        public string TargetEntitySet
        {
            get { return this.targetEntitySet; }
        }
 
        /// <summary>The collection that has changed.</summary>
        public ICollection Collection
        {
            get { return this.collection; }
        }
 
        /// <summary>
        /// The action that indicates how the collection was changed. The value will be Add or Remove.
        /// </summary>
        public NotifyCollectionChangedAction Action
        {
            get { return this.action; }
        }
 
        #endregion    
    }
}