opensim – Blame information for rev 1
?pathlinks?
Rev | Author | Line No. | Line |
---|---|---|---|
1 | eva | 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; |
||
29 | using System.Collections.Generic; |
||
30 | using OpenSim.Framework; |
||
31 | using OpenMetaverse; |
||
32 | |||
33 | namespace OpenSim.Region.Framework.Interfaces |
||
34 | { |
||
35 | public interface IEstateDataService |
||
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.</param> |
||
42 | /// <returns></returns> |
||
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> |
||
50 | EstateSettings LoadEstateSettings(int estateID); |
||
51 | |||
52 | /// <summary> |
||
53 | /// Create a new estate. |
||
54 | /// </summary> |
||
55 | /// <returns> |
||
56 | /// A <see cref="EstateSettings"/> |
||
57 | /// </returns> |
||
58 | EstateSettings CreateNewEstate(); |
||
59 | |||
60 | /// <summary> |
||
61 | /// Load/Get all estate settings. |
||
62 | /// </summary> |
||
63 | /// <returns>An empty list if no estates were found.</returns> |
||
64 | List<EstateSettings> LoadEstateSettingsAll(); |
||
65 | |||
66 | /// <summary> |
||
67 | /// Store estate settings. |
||
68 | /// </summary> |
||
69 | /// <remarks> |
||
70 | /// This is also called by EstateSettings.Save()</remarks> |
||
71 | /// <param name="es"></param> |
||
72 | void StoreEstateSettings(EstateSettings es); |
||
73 | |||
74 | /// <summary> |
||
75 | /// Get estate IDs. |
||
76 | /// </summary> |
||
77 | /// <param name="search">Name of estate to search for. This is the exact name, no parttern matching is done.</param> |
||
78 | /// <returns></returns> |
||
79 | List<int> GetEstates(string search); |
||
80 | |||
81 | /// <summary> |
||
82 | /// Get the IDs of all estates owned by the given user. |
||
83 | /// </summary> |
||
84 | /// <returns>An empty list if no estates were found.</returns> |
||
85 | List<int> GetEstatesByOwner(UUID ownerID); |
||
86 | |||
87 | /// <summary> |
||
88 | /// Get the IDs of all estates. |
||
89 | /// </summary> |
||
90 | /// <returns>An empty list if no estates were found.</returns> |
||
91 | List<int> GetEstatesAll(); |
||
92 | |||
93 | /// <summary> |
||
94 | /// Link a region to an estate. |
||
95 | /// </summary> |
||
96 | /// <param name="regionID"></param> |
||
97 | /// <param name="estateID"></param> |
||
98 | /// <returns>true if the link succeeded, false otherwise</returns> |
||
99 | bool LinkRegion(UUID regionID, int estateID); |
||
100 | |||
101 | /// <summary> |
||
102 | /// Get the UUIDs of all the regions in an estate. |
||
103 | /// </summary> |
||
104 | /// <param name="estateID"></param> |
||
105 | /// <returns></returns> |
||
106 | List<UUID> GetRegions(int estateID); |
||
107 | |||
108 | /// <summary> |
||
109 | /// Delete an estate |
||
110 | /// </summary> |
||
111 | /// <param name="estateID"></param> |
||
112 | /// <returns>true if the delete succeeded, false otherwise</returns> |
||
113 | bool DeleteEstate(int estateID); |
||
114 | } |
||
115 | } |