/// <summary>
        /// The object factory for a particular data collection instance.
        /// </summary>
        public virtual void CreateObjectsFromData(Residences residences, System.Data.SqlClient.SqlDataReader data)
        {
            // Do nothing if we have nothing
            if (data == null) return;

            // Create a local variable for the new instance.
            Residence newobj = null;
            // Iterate through the data reader
            while (data.Read())
            {
                // Create a new object instance
                newobj = System.Activator.CreateInstance(residences.ContainsType[0]) as Residence;
                // Let the instance set its own members
                newobj.SetMembers(ref data);
                // Add the new object to the collection instance
                residences.Add(newobj);
            }
        }
        /// <summary>
        /// The object factory for a particular data collection instance.
        /// </summary>
        public virtual void CreateObjectsFromData(Residences residences, System.Data.DataSet data)
        {
            // Do nothing if we have nothing
            if (data == null || data.Tables.Count == 0 || data.Tables[0].Rows.Count == 0) return;

            // Create a local variable for the new instance.
            Residence newobj = null;
            // Create a local variable for the data row instance.
            System.Data.DataRow dr = null;

            // Iterate through the table rows
            for (int i = 0; i<data.Tables[0].Rows.Count; i++)
            {
                // Get a reference to the data row
                dr = data.Tables[0].Rows[i];
                // Create a new object instance
                newobj = System.Activator.CreateInstance(residences.ContainsType[0]) as Residence;
                // Let the instance set its own members
                newobj.SetMembers(ref dr);
                // Add the new object to the collection instance
                residences.Add(newobj);
            }
        }
        /// <summary>
        /// Gets the objects for the RESIDENCE relationship.
        /// </summary>
        public Residences GetResidences()
        {
            Residences residences = new Residences();

            ResidenceBase.ServiceObject.FillByBorrowerResidencyType(residences, _id);
            return residences;
        }
        /// <summary>
        /// Gets all the available objects.
        /// </summary>
        public virtual Residences GetAll()
        {
            // create a new instance of the return object
            Residences objects = new Residences();

            // fill the objects
            this.Fill(objects);

            // return the filled object from the service
            return objects;
        }
        /// <summary>
        /// Fill method for populating a collection by BorrowerResidencyType
        /// </summary>
        public void FillByBorrowerResidencyType(Residences residences, System.Int16 id)
        {
            // create the connection to use
            SqlConnection cnn = new SqlConnection(Residence.GetConnectionString());

            try
            {
                // discover the sql parameters
                SqlParameterHash sqlparams = SqlHelperParameterCache.GetSpParameterSet(Residence.GetConnectionString(), "gsp_SelectResidencesByBorrowerResidencyType");

                using (cnn)
                {
                    // open the connection
                    cnn.Open();

                    // set the parameters
                    sqlparams["@borrowerResidencyType"].Value = id;

                    // create an instance of the reader to fill.
                    SqlDataReader datareader = SqlHelper.ExecuteReader(cnn, "gsp_SelectResidencesByBorrowerResidencyType", sqlparams);

                    // Send the collection and data to the object factory.
                    CreateObjectsFromData(residences, datareader);

                    // close the connection
                    cnn.Close();
                }

                // nullify the connection
                cnn = null;
            }
            catch (SqlException sqlex)
            {
                throw sqlex;
            }
        }
        /// <summary>
        /// Fill method for populating an entire collection of Residences
        /// </summary>
        public virtual void Fill(Residences residences)
        {
            // create the connection to use
            SqlConnection cnn = new SqlConnection(Residence.GetConnectionString());

            try
            {
                using (cnn)
                {
                    // open the connection
                    cnn.Open();

                    // create an instance of the reader to fill.
                    SqlDataReader datareader = SqlHelper.ExecuteReader(cnn, "gsp_SelectResidences");

                    // Send the collection and data to the object factory
                    CreateObjectsFromData(residences, datareader);

                    // close the connection
                    cnn.Close();
                }

                // nullify the connection
                cnn = null;
            }
            catch (SqlException sqlex)
            {
                throw sqlex;
            }
        }