aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim/Region/Framework/Interfaces/IEstateDataService.cs
diff options
context:
space:
mode:
authorJustin Clark-Casey (justincc)2011-03-21 22:25:20 +0000
committerJustin Clark-Casey (justincc)2011-03-21 22:25:20 +0000
commit793bfb5a663879296789efa8350df0e9cabb2148 (patch)
tree24aa293b8de03e233058ca656d4c4cfb751d9e67 /OpenSim/Region/Framework/Interfaces/IEstateDataService.cs
parentOn initial region registration, if the user chooses the option to make the re... (diff)
downloadopensim-SC_OLD-793bfb5a663879296789efa8350df0e9cabb2148.zip
opensim-SC_OLD-793bfb5a663879296789efa8350df0e9cabb2148.tar.gz
opensim-SC_OLD-793bfb5a663879296789efa8350df0e9cabb2148.tar.bz2
opensim-SC_OLD-793bfb5a663879296789efa8350df0e9cabb2148.tar.xz
add method doc to IEstateDataService and IEstateDataStore interfaces
Diffstat (limited to 'OpenSim/Region/Framework/Interfaces/IEstateDataService.cs')
-rw-r--r--OpenSim/Region/Framework/Interfaces/IEstateDataService.cs44
1 files changed, 43 insertions, 1 deletions
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
34{ 34{
35 public interface IEstateDataService 35 public interface IEstateDataService
36 { 36 {
37 /// <summary>
38 /// Load estate settings for a region.
39 /// </summary>
40 /// <param name="regionID"></param>
41 /// <param name="create">If true, then an estate is created if one is not found. This is used in migration.</param>
42 /// <returns></returns>
37 EstateSettings LoadEstateSettings(UUID regionID, bool create); 43 EstateSettings LoadEstateSettings(UUID regionID, bool create);
44
45 /// <summary>
46 /// Load estate settings for an estate ID.
47 /// </summary>
48 /// <param name="estateID"></param>
49 /// <returns></returns>
38 EstateSettings LoadEstateSettings(int estateID); 50 EstateSettings LoadEstateSettings(int estateID);
39 51
40 /// <summary> 52 /// <summary>
@@ -43,7 +55,19 @@ namespace OpenSim.Region.Framework.Interfaces
43 /// <returns>An empty list if no estates were found.</returns> 55 /// <returns>An empty list if no estates were found.</returns>
44 List<EstateSettings> LoadEstateSettingsAll(); 56 List<EstateSettings> LoadEstateSettingsAll();
45 57
58 /// <summary>
59 /// Store estate settings.
60 /// </summary>
61 /// <remarks>
62 /// This is also called by EstateSettings.Save()</remarks>
63 /// <param name="es"></param>
46 void StoreEstateSettings(EstateSettings es); 64 void StoreEstateSettings(EstateSettings es);
65
66 /// <summary>
67 /// Get estate IDs.
68 /// </summary>
69 /// <param name="search">Name of estate to search for. This is the exact name, no parttern matching is done.</param>
70 /// <returns></returns>
47 List<int> GetEstates(string search); 71 List<int> GetEstates(string search);
48 72
49 /// <summary> 73 /// <summary>
@@ -52,8 +76,26 @@ namespace OpenSim.Region.Framework.Interfaces
52 /// <returns>An empty list if no estates were found.</returns> 76 /// <returns>An empty list if no estates were found.</returns>
53 List<int> GetEstatesAll(); 77 List<int> GetEstatesAll();
54 78
79 /// <summary>
80 /// Link a region to an estate.
81 /// </summary>
82 /// <param name="regionID"></param>
83 /// <param name="estateID"></param>
84 /// <returns>true if the link succeeded, false otherwise</returns>
55 bool LinkRegion(UUID regionID, int estateID); 85 bool LinkRegion(UUID regionID, int estateID);
86
87 /// <summary>
88 /// Get the UUIDs of all the regions in an estate.
89 /// </summary>
90 /// <param name="estateID"></param>
91 /// <returns></returns>
56 List<UUID> GetRegions(int estateID); 92 List<UUID> GetRegions(int estateID);
93
94 /// <summary>
95 /// Delete an estate
96 /// </summary>
97 /// <param name="estateID"></param>
98 /// <returns>true if the delete succeeded, false otherwise</returns>
57 bool DeleteEstate(int estateID); 99 bool DeleteEstate(int estateID);
58 } 100 }
59} 101} \ No newline at end of file