diff options
author | Sean Dague | 2008-04-07 18:28:48 +0000 |
---|---|---|
committer | Sean Dague | 2008-04-07 18:28:48 +0000 |
commit | 79222a0b45eca74c32cda95cc0857ac860ab6d19 (patch) | |
tree | 86654770a4a4c4e756d78440ad19ec90038c93ad /OpenSim/Framework/IInventoryData.cs | |
parent | added swag #1 on Inventory NHibernate implementation. There (diff) | |
download | opensim-SC-79222a0b45eca74c32cda95cc0857ac860ab6d19.zip opensim-SC-79222a0b45eca74c32cda95cc0857ac860ab6d19.tar.gz opensim-SC-79222a0b45eca74c32cda95cc0857ac860ab6d19.tar.bz2 opensim-SC-79222a0b45eca74c32cda95cc0857ac860ab6d19.tar.xz |
break out the 5 classes that were
InventoryItemBase into seperate .cs files 1 per class
Diffstat (limited to '')
-rw-r--r-- | OpenSim/Framework/IInventoryData.cs | 154 |
1 files changed, 154 insertions, 0 deletions
diff --git a/OpenSim/Framework/IInventoryData.cs b/OpenSim/Framework/IInventoryData.cs new file mode 100644 index 0000000..cfba135 --- /dev/null +++ b/OpenSim/Framework/IInventoryData.cs | |||
@@ -0,0 +1,154 @@ | |||
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 | using System.Collections; | ||
29 | using System.Collections.Generic; | ||
30 | using System.Xml.Serialization; | ||
31 | using libsecondlife; | ||
32 | |||
33 | namespace OpenSim.Framework | ||
34 | { | ||
35 | /// <summary> | ||
36 | /// An interface for accessing inventory data from a storage server | ||
37 | /// </summary> | ||
38 | public interface IInventoryData | ||
39 | { | ||
40 | /// <summary> | ||
41 | /// Initialises the interface | ||
42 | /// </summary> | ||
43 | void Initialise(); | ||
44 | |||
45 | /// <summary> | ||
46 | /// Closes the interface | ||
47 | /// </summary> | ||
48 | void Close(); | ||
49 | |||
50 | /// <summary> | ||
51 | /// The plugin being loaded | ||
52 | /// </summary> | ||
53 | /// <returns>A string containing the plugin name</returns> | ||
54 | string getName(); | ||
55 | |||
56 | /// <summary> | ||
57 | /// The plugins version | ||
58 | /// </summary> | ||
59 | /// <returns>A string containing the plugin version</returns> | ||
60 | string getVersion(); | ||
61 | |||
62 | /// <summary> | ||
63 | /// Returns all child folders in the hierarchy from the parent folder and down. | ||
64 | /// Does not return the parent folder itself. | ||
65 | /// </summary> | ||
66 | /// <param name="parentID">The folder to get subfolders for</param> | ||
67 | /// <returns>A list of inventory folders</returns> | ||
68 | List<InventoryFolderBase> getFolderHierarchy(LLUUID parentID); | ||
69 | |||
70 | /// <summary> | ||
71 | /// Returns a list of inventory items contained within the specified folder | ||
72 | /// </summary> | ||
73 | /// <param name="folderID">The UUID of the target folder</param> | ||
74 | /// <returns>A List of InventoryItemBase items</returns> | ||
75 | List<InventoryItemBase> getInventoryInFolder(LLUUID folderID); | ||
76 | |||
77 | /// <summary> | ||
78 | /// Returns a list of the root folders within a users inventory | ||
79 | /// </summary> | ||
80 | /// <param name="user">The user whos inventory is to be searched</param> | ||
81 | /// <returns>A list of folder objects</returns> | ||
82 | List<InventoryFolderBase> getUserRootFolders(LLUUID user); | ||
83 | |||
84 | /// <summary> | ||
85 | /// Returns the users inventory root folder. | ||
86 | /// </summary> | ||
87 | /// <param name="user">The UUID of the user who is having inventory being returned</param> | ||
88 | /// <returns>Root inventory folder, null if no root inventory folder was found</returns> | ||
89 | InventoryFolderBase getUserRootFolder(LLUUID user); | ||
90 | |||
91 | /// <summary> | ||
92 | /// Returns a list of inventory folders contained in the folder 'parentID' | ||
93 | /// </summary> | ||
94 | /// <param name="parentID">The folder to get subfolders for</param> | ||
95 | /// <returns>A list of inventory folders</returns> | ||
96 | List<InventoryFolderBase> getInventoryFolders(LLUUID parentID); | ||
97 | |||
98 | /// <summary> | ||
99 | /// Returns an inventory item by its UUID | ||
100 | /// </summary> | ||
101 | /// <param name="item">The UUID of the item to be returned</param> | ||
102 | /// <returns>A class containing item information</returns> | ||
103 | InventoryItemBase getInventoryItem(LLUUID item); | ||
104 | |||
105 | /// <summary> | ||
106 | /// Returns a specified inventory folder by its UUID | ||
107 | /// </summary> | ||
108 | /// <param name="folder">The UUID of the folder to be returned</param> | ||
109 | /// <returns>A class containing folder information</returns> | ||
110 | InventoryFolderBase getInventoryFolder(LLUUID folder); | ||
111 | |||
112 | /// <summary> | ||
113 | /// Creates a new inventory item based on item | ||
114 | /// </summary> | ||
115 | /// <param name="item">The item to be created</param> | ||
116 | void addInventoryItem(InventoryItemBase item); | ||
117 | |||
118 | /// <summary> | ||
119 | /// Updates an inventory item with item (updates based on ID) | ||
120 | /// </summary> | ||
121 | /// <param name="item">The updated item</param> | ||
122 | void updateInventoryItem(InventoryItemBase item); | ||
123 | |||
124 | /// <summary> | ||
125 | /// | ||
126 | /// </summary> | ||
127 | /// <param name="item"></param> | ||
128 | void deleteInventoryItem(LLUUID item); | ||
129 | |||
130 | /// <summary> | ||
131 | /// Adds a new folder specified by folder | ||
132 | /// </summary> | ||
133 | /// <param name="folder">The inventory folder</param> | ||
134 | void addInventoryFolder(InventoryFolderBase folder); | ||
135 | |||
136 | /// <summary> | ||
137 | /// Updates a folder based on its ID with folder | ||
138 | /// </summary> | ||
139 | /// <param name="folder">The inventory folder</param> | ||
140 | void updateInventoryFolder(InventoryFolderBase folder); | ||
141 | |||
142 | /// <summary> | ||
143 | /// Updates a folder based on its ID with folder | ||
144 | /// </summary> | ||
145 | /// <param name="folder">The inventory folder</param> | ||
146 | void moveInventoryFolder(InventoryFolderBase folder); | ||
147 | |||
148 | /// <summary> | ||
149 | /// Deletes a folder based on its ID with folder | ||
150 | /// </summary> | ||
151 | /// <param name="folder">The id of the folder</param> | ||
152 | void deleteInventoryFolder(LLUUID folder); | ||
153 | } | ||
154 | } | ||