aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim/Framework/Data/InventoryData.cs
diff options
context:
space:
mode:
authorSean Dague2007-07-16 15:40:11 +0000
committerSean Dague2007-07-16 15:40:11 +0000
commit2a3c79df83e800d5dfe75a1a3b140ed81da2b1d6 (patch)
treee3f80ad51736cf17e856547b1bcf956010927434 /OpenSim/Framework/Data/InventoryData.cs
parent*Trunk compiles now (diff)
downloadopensim-SC_OLD-2a3c79df83e800d5dfe75a1a3b140ed81da2b1d6.zip
opensim-SC_OLD-2a3c79df83e800d5dfe75a1a3b140ed81da2b1d6.tar.gz
opensim-SC_OLD-2a3c79df83e800d5dfe75a1a3b140ed81da2b1d6.tar.bz2
opensim-SC_OLD-2a3c79df83e800d5dfe75a1a3b140ed81da2b1d6.tar.xz
changed to native line ending encoding
Diffstat (limited to 'OpenSim/Framework/Data/InventoryData.cs')
-rw-r--r--OpenSim/Framework/Data/InventoryData.cs394
1 files changed, 197 insertions, 197 deletions
diff --git a/OpenSim/Framework/Data/InventoryData.cs b/OpenSim/Framework/Data/InventoryData.cs
index 7253cc7..f6aeb58 100644
--- a/OpenSim/Framework/Data/InventoryData.cs
+++ b/OpenSim/Framework/Data/InventoryData.cs
@@ -1,197 +1,197 @@
1/* 1/*
2* Copyright (c) Contributors, http://www.openmetaverse.org/ 2* Copyright (c) Contributors, http://www.openmetaverse.org/
3* See CONTRIBUTORS.TXT for a full list of copyright holders. 3* See CONTRIBUTORS.TXT for a full list of copyright holders.
4* 4*
5* Redistribution and use in source and binary forms, with or without 5* Redistribution and use in source and binary forms, with or without
6* modification, are permitted provided that the following conditions are met: 6* modification, are permitted provided that the following conditions are met:
7* * Redistributions of source code must retain the above copyright 7* * Redistributions of source code must retain the above copyright
8* notice, this list of conditions and the following disclaimer. 8* notice, this list of conditions and the following disclaimer.
9* * Redistributions in binary form must reproduce the above copyright 9* * Redistributions in binary form must reproduce the above copyright
10* notice, this list of conditions and the following disclaimer in the 10* notice, this list of conditions and the following disclaimer in the
11* documentation and/or other materials provided with the distribution. 11* documentation and/or other materials provided with the distribution.
12* * Neither the name of the OpenSim Project nor the 12* * Neither the name of the OpenSim Project nor the
13* names of its contributors may be used to endorse or promote products 13* names of its contributors may be used to endorse or promote products
14* derived from this software without specific prior written permission. 14* derived from this software without specific prior written permission.
15* 15*
16* THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS AND ANY 16* THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS AND ANY
17* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 17* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 18* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19* DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY 19* DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
20* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 20* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 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 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 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 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. 25* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26* 26*
27*/ 27*/
28using System.Collections.Generic; 28using System.Collections.Generic;
29using libsecondlife; 29using libsecondlife;
30 30
31namespace OpenSim.Framework.Data 31namespace OpenSim.Framework.Data
32{ 32{
33 /// <summary> 33 /// <summary>
34 /// Inventory Item - contains all the properties associated with an individual inventory piece. 34 /// Inventory Item - contains all the properties associated with an individual inventory piece.
35 /// </summary> 35 /// </summary>
36 public class InventoryItemBase 36 public class InventoryItemBase
37 { 37 {
38 /// <summary> 38 /// <summary>
39 /// A UUID containing the ID for the inventory item itself 39 /// A UUID containing the ID for the inventory item itself
40 /// </summary> 40 /// </summary>
41 public LLUUID inventoryID; 41 public LLUUID inventoryID;
42 /// <summary> 42 /// <summary>
43 /// The UUID of the associated asset on the asset server 43 /// The UUID of the associated asset on the asset server
44 /// </summary> 44 /// </summary>
45 public LLUUID assetID; 45 public LLUUID assetID;
46 /// <summary> 46 /// <summary>
47 /// This is an enumerated value determining the type of asset (eg Notecard, Sound, Object, etc) 47 /// This is an enumerated value determining the type of asset (eg Notecard, Sound, Object, etc)
48 /// </summary> 48 /// </summary>
49 public int type; 49 public int type;
50 /// <summary> 50 /// <summary>
51 /// The folder this item is contained in 51 /// The folder this item is contained in
52 /// </summary> 52 /// </summary>
53 public LLUUID parentFolderID; 53 public LLUUID parentFolderID;
54 /// <summary> 54 /// <summary>
55 /// The owner of this inventory item 55 /// The owner of this inventory item
56 /// </summary> 56 /// </summary>
57 public LLUUID avatarID; 57 public LLUUID avatarID;
58 /// <summary> 58 /// <summary>
59 /// The creator of this item 59 /// The creator of this item
60 /// </summary> 60 /// </summary>
61 public LLUUID creatorsID; 61 public LLUUID creatorsID;
62 /// <summary> 62 /// <summary>
63 /// The name of the inventory item (must be less than 64 characters) 63 /// The name of the inventory item (must be less than 64 characters)
64 /// </summary> 64 /// </summary>
65 public string inventoryName; 65 public string inventoryName;
66 /// <summary> 66 /// <summary>
67 /// The description of the inventory item (must be less than 64 characters) 67 /// The description of the inventory item (must be less than 64 characters)
68 /// </summary> 68 /// </summary>
69 public string inventoryDescription; 69 public string inventoryDescription;
70 /// <summary> 70 /// <summary>
71 /// A mask containing the permissions for the next owner (cannot be enforced) 71 /// A mask containing the permissions for the next owner (cannot be enforced)
72 /// </summary> 72 /// </summary>
73 public uint inventoryNextPermissions; 73 public uint inventoryNextPermissions;
74 /// <summary> 74 /// <summary>
75 /// A mask containing permissions for the current owner (cannot be enforced) 75 /// A mask containing permissions for the current owner (cannot be enforced)
76 /// </summary> 76 /// </summary>
77 public uint inventoryCurrentPermissions; 77 public uint inventoryCurrentPermissions;
78 } 78 }
79 79
80 /// <summary> 80 /// <summary>
81 /// A Class for folders which contain users inventory 81 /// A Class for folders which contain users inventory
82 /// </summary> 82 /// </summary>
83 public class InventoryFolderBase 83 public class InventoryFolderBase
84 { 84 {
85 /// <summary> 85 /// <summary>
86 /// The name of the folder (64 characters or less) 86 /// The name of the folder (64 characters or less)
87 /// </summary> 87 /// </summary>
88 public string name; 88 public string name;
89 /// <summary> 89 /// <summary>
90 /// The agent who's inventory this is contained by 90 /// The agent who's inventory this is contained by
91 /// </summary> 91 /// </summary>
92 public LLUUID agentID; 92 public LLUUID agentID;
93 /// <summary> 93 /// <summary>
94 /// The folder this folder is contained in 94 /// The folder this folder is contained in
95 /// </summary> 95 /// </summary>
96 public LLUUID parentID; 96 public LLUUID parentID;
97 /// <summary> 97 /// <summary>
98 /// The UUID for this folder 98 /// The UUID for this folder
99 /// </summary> 99 /// </summary>
100 public LLUUID folderID; 100 public LLUUID folderID;
101 /// <summary> 101 /// <summary>
102 /// Tyep of Items normally stored in this folder 102 /// Tyep of Items normally stored in this folder
103 /// </summary> 103 /// </summary>
104 public ushort type; 104 public ushort type;
105 /// <summary> 105 /// <summary>
106 /// 106 ///
107 /// </summary> 107 /// </summary>
108 public ushort version; 108 public ushort version;
109 } 109 }
110 110
111 /// <summary> 111 /// <summary>
112 /// An interface for accessing inventory data from a storage server 112 /// An interface for accessing inventory data from a storage server
113 /// </summary> 113 /// </summary>
114 public interface IInventoryData 114 public interface IInventoryData
115 { 115 {
116 /// <summary> 116 /// <summary>
117 /// Initialises the interface 117 /// Initialises the interface
118 /// </summary> 118 /// </summary>
119 void Initialise(); 119 void Initialise();
120 120
121 /// <summary> 121 /// <summary>
122 /// Closes the interface 122 /// Closes the interface
123 /// </summary> 123 /// </summary>
124 void Close(); 124 void Close();
125 125
126 /// <summary> 126 /// <summary>
127 /// The plugin being loaded 127 /// The plugin being loaded
128 /// </summary> 128 /// </summary>
129 /// <returns>A string containing the plugin name</returns> 129 /// <returns>A string containing the plugin name</returns>
130 string getName(); 130 string getName();
131 131
132 /// <summary> 132 /// <summary>
133 /// The plugins version 133 /// The plugins version
134 /// </summary> 134 /// </summary>
135 /// <returns>A string containing the plugin version</returns> 135 /// <returns>A string containing the plugin version</returns>
136 string getVersion(); 136 string getVersion();
137 137
138 /// <summary> 138 /// <summary>
139 /// Returns a list of inventory items contained within the specified folder 139 /// Returns a list of inventory items contained within the specified folder
140 /// </summary> 140 /// </summary>
141 /// <param name="folderID">The UUID of the target folder</param> 141 /// <param name="folderID">The UUID of the target folder</param>
142 /// <returns>A List of InventoryItemBase items</returns> 142 /// <returns>A List of InventoryItemBase items</returns>
143 List<InventoryItemBase> getInventoryInFolder(LLUUID folderID); 143 List<InventoryItemBase> getInventoryInFolder(LLUUID folderID);
144 144
145 /// <summary> 145 /// <summary>
146 /// Returns a list of folders in the users inventory root. 146 /// Returns a list of folders in the users inventory root.
147 /// </summary> 147 /// </summary>
148 /// <param name="user">The UUID of the user who is having inventory being returned</param> 148 /// <param name="user">The UUID of the user who is having inventory being returned</param>
149 /// <returns>A list of folders</returns> 149 /// <returns>A list of folders</returns>
150 List<InventoryFolderBase> getUserRootFolders(LLUUID user); 150 List<InventoryFolderBase> getUserRootFolders(LLUUID user);
151 151
152 /// <summary> 152 /// <summary>
153 /// Returns a list of inventory folders contained in the folder 'parentID' 153 /// Returns a list of inventory folders contained in the folder 'parentID'
154 /// </summary> 154 /// </summary>
155 /// <param name="parentID">The folder to get subfolders for</param> 155 /// <param name="parentID">The folder to get subfolders for</param>
156 /// <returns>A list of inventory folders</returns> 156 /// <returns>A list of inventory folders</returns>
157 List<InventoryFolderBase> getInventoryFolders(LLUUID parentID); 157 List<InventoryFolderBase> getInventoryFolders(LLUUID parentID);
158 158
159 /// <summary> 159 /// <summary>
160 /// Returns an inventory item by its UUID 160 /// Returns an inventory item by its UUID
161 /// </summary> 161 /// </summary>
162 /// <param name="item">The UUID of the item to be returned</param> 162 /// <param name="item">The UUID of the item to be returned</param>
163 /// <returns>A class containing item information</returns> 163 /// <returns>A class containing item information</returns>
164 InventoryItemBase getInventoryItem(LLUUID item); 164 InventoryItemBase getInventoryItem(LLUUID item);
165 165
166 /// <summary> 166 /// <summary>
167 /// Returns a specified inventory folder by its UUID 167 /// Returns a specified inventory folder by its UUID
168 /// </summary> 168 /// </summary>
169 /// <param name="folder">The UUID of the folder to be returned</param> 169 /// <param name="folder">The UUID of the folder to be returned</param>
170 /// <returns>A class containing folder information</returns> 170 /// <returns>A class containing folder information</returns>
171 InventoryFolderBase getInventoryFolder(LLUUID folder); 171 InventoryFolderBase getInventoryFolder(LLUUID folder);
172 172
173 /// <summary> 173 /// <summary>
174 /// Creates a new inventory item based on item 174 /// Creates a new inventory item based on item
175 /// </summary> 175 /// </summary>
176 /// <param name="item">The item to be created</param> 176 /// <param name="item">The item to be created</param>
177 void addInventoryItem(InventoryItemBase item); 177 void addInventoryItem(InventoryItemBase item);
178 178
179 /// <summary> 179 /// <summary>
180 /// Updates an inventory item with item (updates based on ID) 180 /// Updates an inventory item with item (updates based on ID)
181 /// </summary> 181 /// </summary>
182 /// <param name="item">The updated item</param> 182 /// <param name="item">The updated item</param>
183 void updateInventoryItem(InventoryItemBase item); 183 void updateInventoryItem(InventoryItemBase item);
184 184
185 /// <summary> 185 /// <summary>
186 /// Adds a new folder specified by folder 186 /// Adds a new folder specified by folder
187 /// </summary> 187 /// </summary>
188 /// <param name="folder">The inventory folder</param> 188 /// <param name="folder">The inventory folder</param>
189 void addInventoryFolder(InventoryFolderBase folder); 189 void addInventoryFolder(InventoryFolderBase folder);
190 190
191 /// <summary> 191 /// <summary>
192 /// Updates a folder based on its ID with folder 192 /// Updates a folder based on its ID with folder
193 /// </summary> 193 /// </summary>
194 /// <param name="folder">The inventory folder</param> 194 /// <param name="folder">The inventory folder</param>
195 void updateInventoryFolder(InventoryFolderBase folder); 195 void updateInventoryFolder(InventoryFolderBase folder);
196 } 196 }
197} 197}
generated by cgit v1.1 at 2024-07-08 09:24:32 +0000