clockwerk-opensim – Blame information for rev 1

Subversion Repositories:
Rev:
Rev Author Line No. Line
1 vero 1 /*
2 * Copyright (c) Contributors, http://opensimulator.org/
3 * See CONTRIBUTORS.TXT for a full list of copyright holders.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 * * Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * * Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * * Neither the name of the OpenSimulator Project nor the
13 * names of its contributors may be used to endorse or promote products
14 * derived from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
17 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
20 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27  
28 using System.Collections.Generic;
29 using OpenMetaverse;
30 using OpenSim.Framework;
31  
32 namespace OpenSim.Data
33 {
34 public interface IEstateDataStore
35 {
36 /// <summary>
37 /// Initialise the data store.
38 /// </summary>
39 /// <param name="connectstring"></param>
40 void Initialise(string connectstring);
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.</param>
47 /// <returns></returns>
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>
55 EstateSettings LoadEstateSettings(int estateID);
56  
57 /// <summary>
58 /// Create a new estate.
59 /// </summary>
60 /// <returns>
61 /// A <see cref="EstateSettings"/>
62 /// </returns>
63 EstateSettings CreateNewEstate();
64  
65 /// <summary>
66 /// Load/Get all estate settings.
67 /// </summary>
68 /// <returns>An empty list if no estates were found.</returns>
69 List<EstateSettings> LoadEstateSettingsAll();
70  
71 /// <summary>
72 /// Store estate settings.
73 /// </summary>
74 /// <remarks>
75 /// This is also called by EstateSettings.Save()</remarks>
76 /// <param name="es"></param>
77 void StoreEstateSettings(EstateSettings es);
78  
79 /// <summary>
80 /// Get estate IDs.
81 /// </summary>
82 /// <param name="search">Name of estate to search for. This is the exact name, no parttern matching is done.</param>
83 /// <returns></returns>
84 List<int> GetEstates(string search);
85  
86 /// <summary>
87 /// Get the IDs of all estates owned by the given user.
88 /// </summary>
89 /// <returns>An empty list if no estates were found.</returns>
90 List<int> GetEstatesByOwner(UUID ownerID);
91  
92 /// <summary>
93 /// Get the IDs of all estates.
94 /// </summary>
95 /// <returns>An empty list if no estates were found.</returns>
96 List<int> GetEstatesAll();
97  
98 /// <summary>
99 /// Link a region to an estate.
100 /// </summary>
101 /// <param name="regionID"></param>
102 /// <param name="estateID"></param>
103 /// <returns>true if the link succeeded, false otherwise</returns>
104 bool LinkRegion(UUID regionID, int estateID);
105  
106 /// <summary>
107 /// Get the UUIDs of all the regions in an estate.
108 /// </summary>
109 /// <param name="estateID"></param>
110 /// <returns></returns>
111 List<UUID> GetRegions(int estateID);
112  
113 /// <summary>
114 /// Delete an estate
115 /// </summary>
116 /// <param name="estateID"></param>
117 /// <returns>true if the delete succeeded, false otherwise</returns>
118 bool DeleteEstate(int estateID);
119 }
120 }