1 files changed, 228 insertions, 0 deletions
diff --git a/OpenSim/Framework/General/InventoryItemBase.cs b/OpenSim/Framework/General/InventoryItemBase.cs
new file mode 100644
index 0000000..27124d9
--- /dev/null
+++ b/OpenSim/Framework/General/InventoryItemBase.cs
@@ -0,0 +1,228 @@
+/*
+* Copyright (c) Contributors, http://opensimulator.org/
+* See CONTRIBUTORS.TXT for a full list of copyright holders.
+*
+* Redistribution and use in source and binary forms, with or without
+* modification, are permitted provided that the following conditions are met:
+*     * Redistributions of source code must retain the above copyright
+*       notice, this list of conditions and the following disclaimer.
+*     * Redistributions in binary form must reproduce the above copyright
+*       notice, this list of conditions and the following disclaimer in the
+*       documentation and/or other materials provided with the distribution.
+*     * Neither the name of the OpenSim Project nor the
+*       names of its contributors may be used to endorse or promote products
+*       derived from this software without specific prior written permission.
+*
+* THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS AND ANY
+* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+* DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
+* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+* 
+*/
+using System.Collections.Generic;
+using libsecondlife;
+namespace OpenSim.Framework
+{
+    /// <summary>
+    /// Inventory Item - contains all the properties associated with an individual inventory piece.
+    /// </summary>
+    public class InventoryItemBase
+    {
+        /// <summary>
+        /// A UUID containing the ID for the inventory item itself
+        /// </summary>
+        public LLUUID inventoryID;
+        /// <summary>
+        /// The UUID of the associated asset on the asset server
+        /// </summary>
+        public LLUUID assetID;
+        /// <summary>
+        /// This is an enumerated value determining the type of asset (eg Notecard, Sound, Object, etc)
+        /// </summary>
+        public int assetType;
+        /// <summary>
+        /// The type of inventory item. (Can be slightly different to the asset type
+        /// </summary>
+        public int invType;
+        /// <summary>
+        /// The folder this item is contained in 
+        /// </summary>
+        public LLUUID parentFolderID;
+        /// <summary>
+        /// The owner of this inventory item
+        /// </summary>
+        public LLUUID avatarID;
+        /// <summary>
+        /// The creator of this item
+        /// </summary>
+        public LLUUID creatorsID;
+        /// <summary>
+        /// The name of the inventory item (must be less than 64 characters)
+        /// </summary>
+        public string inventoryName;
+        /// <summary>
+        /// The description of the inventory item (must be less than 64 characters)
+        /// </summary>
+        public string inventoryDescription;
+        /// <summary>
+        /// A mask containing the permissions for the next owner (cannot be enforced)
+        /// </summary>
+        public uint inventoryNextPermissions;
+        /// <summary>
+        /// A mask containing permissions for the current owner (cannot be enforced)
+        /// </summary>
+        public uint inventoryCurrentPermissions;
+        /// <summary>
+        /// 
+        /// </summary>
+        public uint inventoryBasePermissions;
+        /// <summary>
+        /// 
+        /// </summary>
+        public uint inventoryEveryOnePermissions;
+    }
+    /// <summary>
+    /// A Class for folders which contain users inventory
+    /// </summary>
+    public class InventoryFolderBase
+    {
+        /// <summary>
+        /// The name of the folder (64 characters or less)
+        /// </summary>
+        public string name;
+        /// <summary>
+        /// The agent who's inventory this is contained by
+        /// </summary>
+        public LLUUID agentID;
+        /// <summary>
+        /// The folder this folder is contained in 
+        /// </summary>
+        public LLUUID parentID;
+        /// <summary>
+        /// The UUID for this folder
+        /// </summary>
+        public LLUUID folderID;
+        /// <summary>
+        /// Tyep of Items normally stored in this folder
+        /// </summary>
+        public short type;
+        /// <summary>
+        /// 
+        /// </summary>
+        public ushort version;
+    }
+    /// <summary>
+    /// An interface for accessing inventory data from a storage server
+    /// </summary>
+    public interface IInventoryData
+    {
+        /// <summary>
+        /// Initialises the interface
+        /// </summary>
+        void Initialise();
+        /// <summary>
+        /// Closes the interface
+        /// </summary>
+        void Close();
+        /// <summary>
+        /// The plugin being loaded
+        /// </summary>
+        /// <returns>A string containing the plugin name</returns>
+        string getName();
+        /// <summary>
+        /// The plugins version
+        /// </summary>
+        /// <returns>A string containing the plugin version</returns>
+        string getVersion();
+        /// <summary>
+        /// Returns a list of inventory items contained within the specified folder
+        /// </summary>
+        /// <param name="folderID">The UUID of the target folder</param>
+        /// <returns>A List of InventoryItemBase items</returns>
+        List<InventoryItemBase> getInventoryInFolder(LLUUID folderID);
+        /// <summary>
+        /// Returns a list of the root folders within a users inventory
+        /// </summary>
+        /// <param name="user">The user whos inventory is to be searched</param>
+        /// <returns>A list of folder objects</returns>
+        List<InventoryFolderBase> getUserRootFolders(LLUUID user);
+        /// <summary>
+        /// Returns the users inventory root folder.
+        /// </summary>
+        /// <param name="user">The UUID of the user who is having inventory being returned</param>
+        /// <returns>Root inventory folder</returns>
+        InventoryFolderBase getUserRootFolder(LLUUID user);
+        /// <summary>
+        /// Returns a list of inventory folders contained in the folder 'parentID'
+        /// </summary>
+        /// <param name="parentID">The folder to get subfolders for</param>
+        /// <returns>A list of inventory folders</returns>
+        List<InventoryFolderBase> getInventoryFolders(LLUUID parentID);
+        /// <summary>
+        /// Returns an inventory item by its UUID
+        /// </summary>
+        /// <param name="item">The UUID of the item to be returned</param>
+        /// <returns>A class containing item information</returns>
+        InventoryItemBase getInventoryItem(LLUUID item);
+        /// <summary>
+        /// Returns a specified inventory folder by its UUID
+        /// </summary>
+        /// <param name="folder">The UUID of the folder to be returned</param>
+        /// <returns>A class containing folder information</returns>
+        InventoryFolderBase getInventoryFolder(LLUUID folder);
+        /// <summary>
+        /// Creates a new inventory item based on item
+        /// </summary>
+        /// <param name="item">The item to be created</param>
+        void addInventoryItem(InventoryItemBase item);
+        /// <summary>
+        /// Updates an inventory item with item (updates based on ID)
+        /// </summary>
+        /// <param name="item">The updated item</param>
+        void updateInventoryItem(InventoryItemBase item);
+        /// <summary>
+        /// 
+        /// </summary>
+        /// <param name="item"></param>
+        void deleteInventoryItem(LLUUID item);
+        /// <summary>
+        /// Adds a new folder specified by folder
+        /// </summary>
+        /// <param name="folder">The inventory folder</param>
+        void addInventoryFolder(InventoryFolderBase folder);
+        /// <summary>
+        /// Updates a folder based on its ID with folder
+        /// </summary>
+        /// <param name="folder">The inventory folder</param>
+        void updateInventoryFolder(InventoryFolderBase folder);
+        /// <summary>
+        /// Deletes a folder based on its ID with folder
+        /// </summary>
+        /// <param name="folder">The id of the folder</param>
+        void deleteInventoryFolder(LLUUID folder);
+    }
+}

diff --git a/OpenSim/Framework/General/InventoryItemBase.cs b/OpenSim/Framework/General/InventoryItemBase.cs new file mode 100644 index 0000000..27124d9 --- /dev/null +++ b/OpenSim/Framework/General/InventoryItemBase.cs
@@ -0,0 +1,228 @@
	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.Generic;
	29	using libsecondlife;
	30
	31	namespace OpenSim.Framework
	32	{
	33	/// <summary>
	34	/// Inventory Item - contains all the properties associated with an individual inventory piece.
	35	/// </summary>
	36	public class InventoryItemBase
	37	{
	38	/// <summary>
	39	/// A UUID containing the ID for the inventory item itself
	40	/// </summary>
	41	public LLUUID inventoryID;
	42	/// <summary>
	43	/// The UUID of the associated asset on the asset server
	44	/// </summary>
	45	public LLUUID assetID;
	46	/// <summary>
	47	/// This is an enumerated value determining the type of asset (eg Notecard, Sound, Object, etc)
	48	/// </summary>
	49	public int assetType;
	50	/// <summary>
	51	/// The type of inventory item. (Can be slightly different to the asset type
	52	/// </summary>
	53	public int invType;
	54	/// <summary>
	55	/// The folder this item is contained in
	56	/// </summary>
	57	public LLUUID parentFolderID;
	58	/// <summary>
	59	/// The owner of this inventory item
	60	/// </summary>
	61	public LLUUID avatarID;
	62	/// <summary>
	63	/// The creator of this item
	64	/// </summary>
	65	public LLUUID creatorsID;
	66	/// <summary>
	67	/// The name of the inventory item (must be less than 64 characters)
	68	/// </summary>
	69	public string inventoryName;
	70	/// <summary>
	71	/// The description of the inventory item (must be less than 64 characters)
	72	/// </summary>
	73	public string inventoryDescription;
	74	/// <summary>
	75	/// A mask containing the permissions for the next owner (cannot be enforced)
	76	/// </summary>
	77	public uint inventoryNextPermissions;
	78	/// <summary>
	79	/// A mask containing permissions for the current owner (cannot be enforced)
	80	/// </summary>
	81	public uint inventoryCurrentPermissions;
	82	/// <summary>
	83	///
	84	/// </summary>
	85	public uint inventoryBasePermissions;
	86	/// <summary>
	87	///
	88	/// </summary>
	89	public uint inventoryEveryOnePermissions;
	90	}
	91
	92	/// <summary>
	93	/// A Class for folders which contain users inventory
	94	/// </summary>
	95	public class InventoryFolderBase
	96	{
	97	/// <summary>
	98	/// The name of the folder (64 characters or less)
	99	/// </summary>
	100	public string name;
	101	/// <summary>
	102	/// The agent who's inventory this is contained by
	103	/// </summary>
	104	public LLUUID agentID;
	105	/// <summary>
	106	/// The folder this folder is contained in
	107	/// </summary>
	108	public LLUUID parentID;
	109	/// <summary>
	110	/// The UUID for this folder
	111	/// </summary>
	112	public LLUUID folderID;
	113	/// <summary>
	114	/// Tyep of Items normally stored in this folder
	115	/// </summary>
	116	public short type;
	117	/// <summary>
	118	///
	119	/// </summary>
	120	public ushort version;
	121	}
	122
	123	/// <summary>
	124	/// An interface for accessing inventory data from a storage server
	125	/// </summary>
	126	public interface IInventoryData
	127	{
	128	/// <summary>
	129	/// Initialises the interface
	130	/// </summary>
	131	void Initialise();
	132
	133	/// <summary>
	134	/// Closes the interface
	135	/// </summary>
	136	void Close();
	137
	138	/// <summary>
	139	/// The plugin being loaded
	140	/// </summary>
	141	/// <returns>A string containing the plugin name</returns>
	142	string getName();
	143
	144	/// <summary>
	145	/// The plugins version
	146	/// </summary>
	147	/// <returns>A string containing the plugin version</returns>
	148	string getVersion();
	149
	150	/// <summary>
	151	/// Returns a list of inventory items contained within the specified folder
	152	/// </summary>
	153	/// <param name="folderID">The UUID of the target folder</param>
	154	/// <returns>A List of InventoryItemBase items</returns>
	155	List<InventoryItemBase> getInventoryInFolder(LLUUID folderID);
	156
	157	/// <summary>
	158	/// Returns a list of the root folders within a users inventory
	159	/// </summary>
	160	/// <param name="user">The user whos inventory is to be searched</param>
	161	/// <returns>A list of folder objects</returns>
	162	List<InventoryFolderBase> getUserRootFolders(LLUUID user);
	163
	164	/// <summary>
	165	/// Returns the users inventory root folder.
	166	/// </summary>
	167	/// <param name="user">The UUID of the user who is having inventory being returned</param>
	168	/// <returns>Root inventory folder</returns>
	169	InventoryFolderBase getUserRootFolder(LLUUID user);
	170
	171	/// <summary>
	172	/// Returns a list of inventory folders contained in the folder 'parentID'
	173	/// </summary>
	174	/// <param name="parentID">The folder to get subfolders for</param>
	175	/// <returns>A list of inventory folders</returns>
	176	List<InventoryFolderBase> getInventoryFolders(LLUUID parentID);
	177
	178	/// <summary>
	179	/// Returns an inventory item by its UUID
	180	/// </summary>
	181	/// <param name="item">The UUID of the item to be returned</param>
	182	/// <returns>A class containing item information</returns>
	183	InventoryItemBase getInventoryItem(LLUUID item);
	184
	185	/// <summary>
	186	/// Returns a specified inventory folder by its UUID
	187	/// </summary>
	188	/// <param name="folder">The UUID of the folder to be returned</param>
	189	/// <returns>A class containing folder information</returns>
	190	InventoryFolderBase getInventoryFolder(LLUUID folder);
	191
	192	/// <summary>
	193	/// Creates a new inventory item based on item
	194	/// </summary>
	195	/// <param name="item">The item to be created</param>
	196	void addInventoryItem(InventoryItemBase item);
	197
	198	/// <summary>
	199	/// Updates an inventory item with item (updates based on ID)
	200	/// </summary>
	201	/// <param name="item">The updated item</param>
	202	void updateInventoryItem(InventoryItemBase item);
	203
	204	/// <summary>
	205	///
	206	/// </summary>
	207	/// <param name="item"></param>
	208	void deleteInventoryItem(LLUUID item);
	209
	210	/// <summary>
	211	/// Adds a new folder specified by folder
	212	/// </summary>
	213	/// <param name="folder">The inventory folder</param>
	214	void addInventoryFolder(InventoryFolderBase folder);
	215
	216	/// <summary>
	217	/// Updates a folder based on its ID with folder
	218	/// </summary>
	219	/// <param name="folder">The inventory folder</param>
	220	void updateInventoryFolder(InventoryFolderBase folder);
	221
	222	/// <summary>
	223	/// Deletes a folder based on its ID with folder
	224	/// </summary>
	225	/// <param name="folder">The id of the folder</param>
	226	void deleteInventoryFolder(LLUUID folder);
	227	}
	228	}