diff options
Diffstat (limited to 'OpenSim/Region/OptionalModules/ContentManagementSystem/IContentDatabase.cs')
-rw-r--r-- | OpenSim/Region/OptionalModules/ContentManagementSystem/IContentDatabase.cs | 94 |
1 files changed, 94 insertions, 0 deletions
diff --git a/OpenSim/Region/OptionalModules/ContentManagementSystem/IContentDatabase.cs b/OpenSim/Region/OptionalModules/ContentManagementSystem/IContentDatabase.cs new file mode 100644 index 0000000..7a25fa5 --- /dev/null +++ b/OpenSim/Region/OptionalModules/ContentManagementSystem/IContentDatabase.cs | |||
@@ -0,0 +1,94 @@ | |||
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 OpenSim 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 | #region Header | ||
29 | |||
30 | // IContentDatabase.cs | ||
31 | // User: bongiojp | ||
32 | // | ||
33 | // | ||
34 | // | ||
35 | |||
36 | #endregion Header | ||
37 | |||
38 | using System; | ||
39 | using OpenMetaverse; | ||
40 | using OpenSim.Region.Framework.Scenes; | ||
41 | using Nini.Config; | ||
42 | |||
43 | namespace OpenSim.Region.OptionalModules.ContentManagement | ||
44 | { | ||
45 | public interface IContentDatabase | ||
46 | { | ||
47 | #region Methods | ||
48 | |||
49 | /// <summary> | ||
50 | /// Returns the most recent revision number of a region. | ||
51 | /// </summary> | ||
52 | int GetMostRecentRevision(UUID regionid); | ||
53 | |||
54 | string GetRegionObjectHeightMap(UUID regionid); | ||
55 | |||
56 | string GetRegionObjectHeightMap(UUID regionid, int revision); | ||
57 | |||
58 | /// <summary> | ||
59 | /// Retrieves the xml that describes each individual object from the last revision or specific revision of the given region. | ||
60 | /// </summary> | ||
61 | System.Collections.ArrayList GetRegionObjectXMLList(UUID regionid); | ||
62 | |||
63 | System.Collections.ArrayList GetRegionObjectXMLList(UUID regionid, int revision); | ||
64 | |||
65 | /// <summary> | ||
66 | /// Similar to the IRegionModule function. This is the function to be called before attempting to interface with the database. | ||
67 | /// Initialise should be called one for each region to be contained in the database. The directory should be the full path | ||
68 | /// to the repository and will only be defined once, regardless of how many times the method is called. | ||
69 | /// </summary> | ||
70 | void Initialise(Scene scene, String dir); | ||
71 | |||
72 | /// <summary> | ||
73 | /// Returns a list of the revision numbers and corresponding log messages for a given region. | ||
74 | /// </summary> | ||
75 | System.Collections.Generic.SortedDictionary<string, string> ListOfRegionRevisions(UUID id); | ||
76 | |||
77 | /// <summary> | ||
78 | /// Returns the total number of revisions saved for a specific region. | ||
79 | /// </summary> | ||
80 | int NumOfRegionRev(UUID regionid); | ||
81 | |||
82 | /// <summary> | ||
83 | /// Should be called once after Initialise has been called. | ||
84 | /// </summary> | ||
85 | void PostInitialise(); | ||
86 | |||
87 | /// <summary> | ||
88 | /// Saves the Region terrain map and objects within the region as xml to the database. | ||
89 | /// </summary> | ||
90 | void SaveRegion(UUID regionid, string regionName, string logMessage); | ||
91 | |||
92 | #endregion Methods | ||
93 | } | ||
94 | } | ||