diff options
author | Justin Clark-Casey (justincc) | 2011-03-21 22:25:20 +0000 |
---|---|---|
committer | Justin Clark-Casey (justincc) | 2011-03-21 22:25:20 +0000 |
commit | 793bfb5a663879296789efa8350df0e9cabb2148 (patch) | |
tree | 24aa293b8de03e233058ca656d4c4cfb751d9e67 /OpenSim/Region/Framework | |
parent | On initial region registration, if the user chooses the option to make the re... (diff) | |
download | opensim-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 '')
-rw-r--r-- | OpenSim/Region/Framework/Interfaces/IEstateDataService.cs | 44 | ||||
-rw-r--r-- | OpenSim/Region/Framework/Interfaces/IEstateDataStore.cs | 48 |
2 files changed, 90 insertions, 2 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 |
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 | |||
33 | { | 33 | { |
34 | public interface IEstateDataStore | 34 | public interface IEstateDataStore |
35 | { | 35 | { |
36 | /// <summary> | ||
37 | /// Initialise the data store. | ||
38 | /// </summary> | ||
39 | /// <param name="connectstring"></param> | ||
36 | void Initialise(string connectstring); | 40 | void Initialise(string connectstring); |
37 | 41 | ||
42 | /// <summary> | ||
43 | /// Load estate settings for a region. | ||
44 | /// </summary> | ||
45 | /// <param name="regionID"></param> | ||
46 | /// <param name="create">If true, then an estate is created if one is not found. This is used in migration.</param> | ||
47 | /// <returns></returns> | ||
38 | EstateSettings LoadEstateSettings(UUID regionID, bool create); | 48 | EstateSettings LoadEstateSettings(UUID regionID, bool create); |
49 | |||
50 | /// <summary> | ||
51 | /// Load estate settings for an estate ID. | ||
52 | /// </summary> | ||
53 | /// <param name="estateID"></param> | ||
54 | /// <returns></returns> | ||
39 | EstateSettings LoadEstateSettings(int estateID); | 55 | EstateSettings LoadEstateSettings(int estateID); |
40 | 56 | ||
41 | /// <summary> | 57 | /// <summary> |
@@ -44,7 +60,19 @@ namespace OpenSim.Region.Framework.Interfaces | |||
44 | /// <returns>An empty list if no estates were found.</returns> | 60 | /// <returns>An empty list if no estates were found.</returns> |
45 | List<EstateSettings> LoadEstateSettingsAll(); | 61 | List<EstateSettings> LoadEstateSettingsAll(); |
46 | 62 | ||
63 | /// <summary> | ||
64 | /// Store estate settings. | ||
65 | /// </summary> | ||
66 | /// <remarks> | ||
67 | /// This is also called by EstateSettings.Save()</remarks> | ||
68 | /// <param name="es"></param> | ||
47 | void StoreEstateSettings(EstateSettings es); | 69 | void StoreEstateSettings(EstateSettings es); |
70 | |||
71 | /// <summary> | ||
72 | /// Get estate IDs. | ||
73 | /// </summary> | ||
74 | /// <param name="search">Name of estate to search for. This is the exact name, no parttern matching is done.</param> | ||
75 | /// <returns></returns> | ||
48 | List<int> GetEstates(string search); | 76 | List<int> GetEstates(string search); |
49 | 77 | ||
50 | /// <summary> | 78 | /// <summary> |
@@ -53,8 +81,26 @@ namespace OpenSim.Region.Framework.Interfaces | |||
53 | /// <returns>An empty list if no estates were found.</returns> | 81 | /// <returns>An empty list if no estates were found.</returns> |
54 | List<int> GetEstatesAll(); | 82 | List<int> GetEstatesAll(); |
55 | 83 | ||
84 | /// <summary> | ||
85 | /// Link a region to an estate. | ||
86 | /// </summary> | ||
87 | /// <param name="regionID"></param> | ||
88 | /// <param name="estateID"></param> | ||
89 | /// <returns>true if the link succeeded, false otherwise</returns> | ||
56 | bool LinkRegion(UUID regionID, int estateID); | 90 | bool LinkRegion(UUID regionID, int estateID); |
91 | |||
92 | /// <summary> | ||
93 | /// Get the UUIDs of all the regions in an estate. | ||
94 | /// </summary> | ||
95 | /// <param name="estateID"></param> | ||
96 | /// <returns></returns> | ||
57 | List<UUID> GetRegions(int estateID); | 97 | List<UUID> GetRegions(int estateID); |
98 | |||
99 | /// <summary> | ||
100 | /// Delete an estate | ||
101 | /// </summary> | ||
102 | /// <param name="estateID"></param> | ||
103 | /// <returns>true if the delete succeeded, false otherwise</returns> | ||
58 | bool DeleteEstate(int estateID); | 104 | bool DeleteEstate(int estateID); |
59 | } | 105 | } |
60 | } | 106 | } \ No newline at end of file |