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/Region')
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
{
+ ///
+ /// Load estate settings for a region.
+ ///
+ ///
+ /// If true, then an estate is created if one is not found. This is used in migration.
+ ///
EstateSettings LoadEstateSettings(UUID regionID, bool create);
+
+ ///
+ /// Load estate settings for an estate ID.
+ ///
+ ///
+ ///
EstateSettings LoadEstateSettings(int estateID);
///
@@ -43,7 +55,19 @@ namespace OpenSim.Region.Framework.Interfaces
/// An empty list if no estates were found.
List LoadEstateSettingsAll();
+ ///
+ /// Store estate settings.
+ ///
+ ///
+ /// This is also called by EstateSettings.Save()
+ ///
void StoreEstateSettings(EstateSettings es);
+
+ ///
+ /// Get estate IDs.
+ ///
+ /// Name of estate to search for. This is the exact name, no parttern matching is done.
+ ///
List GetEstates(string search);
///
@@ -52,8 +76,26 @@ namespace OpenSim.Region.Framework.Interfaces
/// An empty list if no estates were found.
List GetEstatesAll();
+ ///
+ /// Link a region to an estate.
+ ///
+ ///
+ ///
+ /// true if the link succeeded, false otherwise
bool LinkRegion(UUID regionID, int estateID);
+
+ ///
+ /// Get the UUIDs of all the regions in an estate.
+ ///
+ ///
+ ///
List GetRegions(int estateID);
+
+ ///
+ /// Delete an estate
+ ///
+ ///
+ /// true if the delete succeeded, false otherwise
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
{
+ ///
+ /// Initialise the data store.
+ ///
+ ///
void Initialise(string connectstring);
+ ///
+ /// Load estate settings for a region.
+ ///
+ ///
+ /// If true, then an estate is created if one is not found. This is used in migration.
+ ///
EstateSettings LoadEstateSettings(UUID regionID, bool create);
+
+ ///
+ /// Load estate settings for an estate ID.
+ ///
+ ///
+ ///
EstateSettings LoadEstateSettings(int estateID);
///
@@ -44,7 +60,19 @@ namespace OpenSim.Region.Framework.Interfaces
/// An empty list if no estates were found.
List LoadEstateSettingsAll();
+ ///
+ /// Store estate settings.
+ ///
+ ///
+ /// This is also called by EstateSettings.Save()
+ ///
void StoreEstateSettings(EstateSettings es);
+
+ ///
+ /// Get estate IDs.
+ ///
+ /// Name of estate to search for. This is the exact name, no parttern matching is done.
+ ///
List GetEstates(string search);
///
@@ -53,8 +81,26 @@ namespace OpenSim.Region.Framework.Interfaces
/// An empty list if no estates were found.
List GetEstatesAll();
+ ///
+ /// Link a region to an estate.
+ ///
+ ///
+ ///
+ /// true if the link succeeded, false otherwise
bool LinkRegion(UUID regionID, int estateID);
+
+ ///
+ /// Get the UUIDs of all the regions in an estate.
+ ///
+ ///
+ ///
List GetRegions(int estateID);
+
+ ///
+ /// Delete an estate
+ ///
+ ///
+ /// true if the delete succeeded, false otherwise
bool DeleteEstate(int estateID);
}
-}
+}
\ No newline at end of file
--
cgit v1.1