Some work on restructuring the namespaces / project names. Note this doesn't compile yet as not all the code has been changed to use the new namespaces. Am committing it now for feedback on the namespaces.

author: MW 2007-06-27 15:28:52 +0000
committer: MW 2007-06-27 15:28:52 +0000
commit: 646bbbc84b8010e0dacbeed5342cdb045f46cc49 (patch)
tree: 770b34d19855363c3c113ab9a0af9a56d821d887 /OpenSim/Framework/Data/InventoryData.cs
download: opensim-SC-646bbbc84b8010e0dacbeed5342cdb045f46cc49.zip
opensim-SC-646bbbc84b8010e0dacbeed5342cdb045f46cc49.tar.gz
opensim-SC-646bbbc84b8010e0dacbeed5342cdb045f46cc49.tar.bz2
opensim-SC-646bbbc84b8010e0dacbeed5342cdb045f46cc49.tar.xz
1 files changed, 187 insertions, 0 deletions
diff --git a/OpenSim/Framework/Data/InventoryData.cs b/OpenSim/Framework/Data/InventoryData.cs
new file mode 100644
index 0000000..8a3a664
--- /dev/null
+++ b/OpenSim/Framework/Data/InventoryData.cs
@@ -0,0 +1,187 @@
+/*
+* Copyright (c) Contributors, http://www.openmetaverse.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;
+using System.Collections.Generic;
+using System.Text;
+using libsecondlife;
+namespace OpenSim.Framework.Data
+{
+    /// <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 type;
+        /// <summary>
+        /// The folder this item is contained in (NULL_KEY = Inventory Root)
+        /// </summary>
+        public LLUUID parentFolderID;
+        /// <summary>
+        /// The owner of this inventory item
+        /// </summary>
+        public LLUUID avatarID;
+        /// <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>
+    /// 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 (NULL_KEY for root)
+        /// </summary>
+        public LLUUID parentID;
+        /// <summary>
+        /// The UUID for this folder
+        /// </summary>
+        public LLUUID folderID;
+    }
+    /// <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 folders in the users inventory root.
+        /// </summary>
+        /// <param name="user">The UUID of the user who is having inventory being returned</param>
+        /// <returns>A list of folders</returns>
+        List<InventoryFolderBase> getUserRootFolders(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>
+        /// 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);
+    }
+}
author	MW	2007-06-27 15:28:52 +0000
committer	MW	2007-06-27 15:28:52 +0000
commit	646bbbc84b8010e0dacbeed5342cdb045f46cc49 (patch)
tree	770b34d19855363c3c113ab9a0af9a56d821d887 /OpenSim/Framework/Data/InventoryData.cs
download	opensim-SC-646bbbc84b8010e0dacbeed5342cdb045f46cc49.zip opensim-SC-646bbbc84b8010e0dacbeed5342cdb045f46cc49.tar.gz opensim-SC-646bbbc84b8010e0dacbeed5342cdb045f46cc49.tar.bz2 opensim-SC-646bbbc84b8010e0dacbeed5342cdb045f46cc49.tar.xz

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