aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim/Framework/IInventoryData.cs
diff options
context:
space:
mode:
Diffstat (limited to 'OpenSim/Framework/IInventoryData.cs')
-rw-r--r--OpenSim/Framework/IInventoryData.cs156
1 files changed, 0 insertions, 156 deletions
diff --git a/OpenSim/Framework/IInventoryData.cs b/OpenSim/Framework/IInventoryData.cs
deleted file mode 100644
index 8ea1fb3..0000000
--- a/OpenSim/Framework/IInventoryData.cs
+++ /dev/null
@@ -1,156 +0,0 @@
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
28using System.Collections.Generic;
29using OpenMetaverse;
30
31namespace OpenSim.Framework
32{
33 /// <summary>
34 /// An interface for accessing inventory data from a storage server
35 /// </summary>
36 public interface IInventoryDataPlugin : IPlugin
37 {
38 /// <summary>
39 /// Initialises the interface
40 /// </summary>
41 void Initialise(string connect);
42
43 /// <summary>
44 /// Returns all descendent folders of this folder. Does not return the parent folder itself.
45 /// </summary>
46 /// <param name="parentID">The folder to get subfolders for</param>
47 /// <returns>A list of inventory folders</returns>
48 List<InventoryFolderBase> getFolderHierarchy(UUID parentID);
49
50 /// <summary>
51 /// Returns a list of inventory items contained within the specified folder
52 /// </summary>
53 /// <param name="folderID">The UUID of the target folder</param>
54 /// <returns>A List of InventoryItemBase items</returns>
55 List<InventoryItemBase> getInventoryInFolder(UUID folderID);
56
57 /// <summary>
58 /// Returns a list of the root folders within a users inventory
59 /// </summary>
60 /// <param name="user">The user whos inventory is to be searched</param>
61 /// <returns>A list of folder objects</returns>
62 List<InventoryFolderBase> getUserRootFolders(UUID user);
63
64 /// <summary>
65 /// Returns the users inventory root folder.
66 /// </summary>
67 /// <param name="user">The UUID of the user who is having inventory being returned</param>
68 /// <returns>Root inventory folder, null if no root inventory folder was found</returns>
69 InventoryFolderBase getUserRootFolder(UUID user);
70
71 /// <summary>
72 /// Returns a list of inventory folders contained in the folder 'parentID'
73 /// </summary>
74 /// <param name="parentID">The folder to get subfolders for</param>
75 /// <returns>A list of inventory folders</returns>
76 List<InventoryFolderBase> getInventoryFolders(UUID parentID);
77
78 /// <summary>
79 /// Returns an inventory item by its UUID
80 /// </summary>
81 /// <param name="item">The UUID of the item to be returned</param>
82 /// <returns>A class containing item information</returns>
83 InventoryItemBase getInventoryItem(UUID item);
84
85 /// <summary>
86 /// Returns a specified inventory folder by its UUID
87 /// </summary>
88 /// <param name="folder">The UUID of the folder to be returned</param>
89 /// <returns>A class containing folder information</returns>
90 InventoryFolderBase getInventoryFolder(UUID folder);
91
92 /// <summary>
93 /// Creates a new inventory item based on item
94 /// </summary>
95 /// <param name="item">The item to be created</param>
96 void addInventoryItem(InventoryItemBase item);
97
98 /// <summary>
99 /// Updates an inventory item with item (updates based on ID)
100 /// </summary>
101 /// <param name="item">The updated item</param>
102 void updateInventoryItem(InventoryItemBase item);
103
104 /// <summary>
105 ///
106 /// </summary>
107 /// <param name="item"></param>
108 void deleteInventoryItem(UUID item);
109
110 /// <summary>
111 /// Adds a new folder specified by folder
112 /// </summary>
113 /// <param name="folder">The inventory folder</param>
114 void addInventoryFolder(InventoryFolderBase folder);
115
116 /// <summary>
117 /// Updates a folder based on its ID with folder
118 /// </summary>
119 /// <param name="folder">The inventory folder</param>
120 void updateInventoryFolder(InventoryFolderBase folder);
121
122 /// <summary>
123 /// Updates a folder based on its ID with folder
124 /// </summary>
125 /// <param name="folder">The inventory folder</param>
126 void moveInventoryFolder(InventoryFolderBase folder);
127
128 /// <summary>
129 /// Deletes a folder. Thie will delete both the folder itself and its contents (items and descendent folders)
130 /// </summary>
131 /// <param name="folder">The id of the folder</param>
132 void deleteInventoryFolder(UUID folder);
133
134 /// <summary>
135 /// Returns all activated gesture-items in the inventory of the specified avatar.
136 /// </summary>
137 /// <param name="avatarID">
138 /// The <see cref="UUID"/> of the avatar
139 /// </param>
140 /// <returns>
141 /// The list of gestures (<see cref="InventoryItemBase"/>s)
142 /// </returns>
143 List<InventoryItemBase> fetchActiveGestures(UUID avatarID);
144 }
145
146 public class InventoryDataInitialiser : PluginInitialiserBase
147 {
148 private string connect;
149 public InventoryDataInitialiser (string s) { connect = s; }
150 public override void Initialise (IPlugin plugin)
151 {
152 IInventoryDataPlugin p = plugin as IInventoryDataPlugin;
153 p.Initialise (connect);
154 }
155 }
156}
generated by cgit v1.1 at 2024-11-05 12:28:23 +0000