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/IEstateDataService.cs     | 44 +++++++++++++++++++-
 .../Framework/Interfaces/IEstateDataStore.cs       | 48 +++++++++++++++++++++-
 2 files changed, 90 insertions(+), 2 deletions(-)

(limited to 'OpenSim')

diff --git a/OpenSim/Region/Framework/Interfaces/IEstateDataService.cs b/OpenSim/Region/Framework/Interfaces/IEstateDataService.cs
index 12ed9e3..55adef1 100644
--- a/OpenSim/Region/Framework/Interfaces/IEstateDataService.cs
+++ b/OpenSim/Region/Framework/Interfaces/IEstateDataService.cs
@@ -34,7 +34,19 @@ namespace OpenSim.Region.Framework.Interfaces
 {
     public interface IEstateDataService
     {
+        /// <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>
@@ -43,7 +55,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>
@@ -52,8 +76,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
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