From d3a20a1e9257ecec417e219ebaf079370015f06d Mon Sep 17 00:00:00 2001
From: Justin Clark-Casey (justincc)
Date: Mon, 21 Mar 2011 21:37:06 +0000
Subject: On initial region registration, if the user chooses the option to
 make the region part of an existing estate, then list the existing region
 names.

---
 OpenSim/Region/Framework/Interfaces/IEstateDataStore.cs | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

(limited to 'OpenSim/Region/Framework/Interfaces/IEstateDataStore.cs')

diff --git a/OpenSim/Region/Framework/Interfaces/IEstateDataStore.cs b/OpenSim/Region/Framework/Interfaces/IEstateDataStore.cs
index 87c7a05..d78ad78 100644
--- a/OpenSim/Region/Framework/Interfaces/IEstateDataStore.cs
+++ b/OpenSim/Region/Framework/Interfaces/IEstateDataStore.cs
@@ -37,8 +37,22 @@ namespace OpenSim.Region.Framework.Interfaces
 
         EstateSettings LoadEstateSettings(UUID regionID, bool create);
         EstateSettings LoadEstateSettings(int estateID);
+        
+        /// <summary>
+        /// Load/Get all estate settings.
+        /// </summary>
+        /// <returns>An empty list if no estates were found.</returns>
+        List<EstateSettings> LoadEstateSettingsAll();
+        
         void StoreEstateSettings(EstateSettings es);
         List<int> GetEstates(string search);
+        
+        /// <summary>
+        /// Get the IDs of all estates.
+        /// </summary>
+        /// <returns>An empty list if no estates were found.</returns>
+        List<int> GetEstatesAll();
+        
         bool LinkRegion(UUID regionID, int estateID);
         List<UUID> GetRegions(int estateID);
         bool DeleteEstate(int estateID);
-- 
cgit v1.1


From 793bfb5a663879296789efa8350df0e9cabb2148 Mon Sep 17 00:00:00 2001
From: Justin Clark-Casey (justincc)
Date: Mon, 21 Mar 2011 22:25:20 +0000
Subject: add method doc to IEstateDataService and IEstateDataStore interfaces

---
 .../Framework/Interfaces/IEstateDataStore.cs       | 48 +++++++++++++++++++++-
 1 file changed, 47 insertions(+), 1 deletion(-)

(limited to 'OpenSim/Region/Framework/Interfaces/IEstateDataStore.cs')

diff --git a/OpenSim/Region/Framework/Interfaces/IEstateDataStore.cs b/OpenSim/Region/Framework/Interfaces/IEstateDataStore.cs
index d78ad78..4974d5d 100644
--- a/OpenSim/Region/Framework/Interfaces/IEstateDataStore.cs
+++ b/OpenSim/Region/Framework/Interfaces/IEstateDataStore.cs
@@ -33,9 +33,25 @@ namespace OpenSim.Region.Framework.Interfaces
 {
     public interface IEstateDataStore
     {
+        /// <summary>
+        /// Initialise the data store.
+        /// </summary>
+        /// <param name="connectstring"></param>
         void Initialise(string connectstring);
 
+        /// <summary>
+        /// Load estate settings for a region.
+        /// </summary>
+        /// <param name="regionID"></param>
+        /// <param name="create">If true, then an estate is created if one is not found.  This is used in migration.</param>
+        /// <returns></returns>
         EstateSettings LoadEstateSettings(UUID regionID, bool create);
+        
+        /// <summary>
+        /// Load estate settings for an estate ID.
+        /// </summary>
+        /// <param name="estateID"></param>
+        /// <returns></returns>
         EstateSettings LoadEstateSettings(int estateID);
         
         /// <summary>
@@ -44,7 +60,19 @@ namespace OpenSim.Region.Framework.Interfaces
         /// <returns>An empty list if no estates were found.</returns>
         List<EstateSettings> LoadEstateSettingsAll();
         
+        /// <summary>
+        /// Store estate settings.
+        /// </summary>
+        /// <remarks>
+        /// This is also called by EstateSettings.Save()</remarks>
+        /// <param name="es"></param>
         void StoreEstateSettings(EstateSettings es);
+        
+        /// <summary>
+        /// Get estate IDs.
+        /// </summary>
+        /// <param name="search">Name of estate to search for.  This is the exact name, no parttern matching is done.</param>
+        /// <returns></returns>
         List<int> GetEstates(string search);
         
         /// <summary>
@@ -53,8 +81,26 @@ namespace OpenSim.Region.Framework.Interfaces
         /// <returns>An empty list if no estates were found.</returns>
         List<int> GetEstatesAll();
         
+        /// <summary>
+        /// Link a region to an estate.
+        /// </summary>
+        /// <param name="regionID"></param>
+        /// <param name="estateID"></param>
+        /// <returns>true if the link succeeded, false otherwise</returns>
         bool LinkRegion(UUID regionID, int estateID);
+        
+        /// <summary>
+        /// Get the UUIDs of all the regions in an estate.
+        /// </summary>
+        /// <param name="estateID"></param>
+        /// <returns></returns>
         List<UUID> GetRegions(int estateID);
+        
+        /// <summary>
+        /// Delete an estate
+        /// </summary>
+        /// <param name="estateID"></param>
+        /// <returns>true if the delete succeeded, false otherwise</returns>
         bool DeleteEstate(int estateID);
     }
-}
+}
\ No newline at end of file
-- 
cgit v1.1


From 2d1f0d224c355e92997643cf849b8e9774dddbad Mon Sep 17 00:00:00 2001
From: Justin Clark-Casey (justincc)
Date: Mon, 21 Mar 2011 22:27:16 +0000
Subject: minor: slightly adjust previous method doc.

---
 OpenSim/Region/Framework/Interfaces/IEstateDataStore.cs | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'OpenSim/Region/Framework/Interfaces/IEstateDataStore.cs')

diff --git a/OpenSim/Region/Framework/Interfaces/IEstateDataStore.cs b/OpenSim/Region/Framework/Interfaces/IEstateDataStore.cs
index 4974d5d..c82661d 100644
--- a/OpenSim/Region/Framework/Interfaces/IEstateDataStore.cs
+++ b/OpenSim/Region/Framework/Interfaces/IEstateDataStore.cs
@@ -43,7 +43,7 @@ namespace OpenSim.Region.Framework.Interfaces
         /// Load estate settings for a region.
         /// </summary>
         /// <param name="regionID"></param>
-        /// <param name="create">If true, then an estate is created if one is not found.  This is used in migration.</param>
+        /// <param name="create">If true, then an estate is created if one is not found.</param>
         /// <returns></returns>
         EstateSettings LoadEstateSettings(UUID regionID, bool create);
         
-- 
cgit v1.1