Dont want to do that again --- MySQL interface is now fully documented. Added little bit more documentation to the MSSQL interface.

1 files changed, 87 insertions, 0 deletions

diff --git a/OpenGridServices/OpenGrid.Framework.Data.MySQL/MySQLInventoryData.cs b/OpenGridServices/OpenGrid.Framework.Data.MySQL/MySQLInventoryData.cs
index 50ffbb0..9177cc3 100644
--- a/OpenGridServices/OpenGrid.Framework.Data.MySQL/MySQLInventoryData.cs
+++ b/OpenGridServices/OpenGrid.Framework.Data.MySQL/MySQLInventoryData.cs
@@ -1,3 +1,29 @@
+/*

+* Copyright (c) OpenSim project, http://sim.opensecondlife.org/

+*

+* 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 <organization> 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 <copyright holder> 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;

@@ -5,10 +31,19 @@ using libsecondlife;
 

 namespace OpenGrid.Framework.Data.MySQL

 {

+    /// <summary>

+    /// A MySQL interface for the inventory server

+    /// </summary>

     class MySQLInventoryData : IInventoryData

     {

+        /// <summary>

+        /// The database manager

+        /// </summary>

         public MySQLManager database;

 

+        /// <summary>

+        /// Loads and initialises this database plugin

+        /// </summary>

         public void Initialise()

         {

             IniFile GridDataMySqlFile = new IniFile("mysql_connection.ini");

@@ -22,21 +57,37 @@ namespace OpenGrid.Framework.Data.MySQL
             database = new MySQLManager(settingHostname, settingDatabase, settingUsername, settingPassword, settingPooling, settingPort);

         }

         

+        /// <summary>

+        /// The name of this DB provider

+        /// </summary>

+        /// <returns>Name of DB provider</returns>

         public string getName()

         {

             return "MySQL Inventory Data Interface";

         }

 

+        /// <summary>

+        /// Closes this DB provider

+        /// </summary>

         public void Close()

         {

             // Do nothing.

         }

 

+        /// <summary>

+        /// Returns the version of this DB provider

+        /// </summary>

+        /// <returns>A string containing the DB provider</returns>

         public string getVersion()

         {

             return "0.1";

         }

 

+        /// <summary>

+        /// Returns a list of items in a specified folder

+        /// </summary>

+        /// <param name="folderID">The folder to search</param>

+        /// <returns>A list containing inventory items</returns>

         public List<InventoryItemBase> getInventoryInFolder(LLUUID folderID)

         {

             try

@@ -65,6 +116,11 @@ namespace OpenGrid.Framework.Data.MySQL
             }

         }

 

+        /// <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>

         public List<InventoryFolderBase> getUserRootFolders(LLUUID user)

         {

             try

@@ -94,6 +150,11 @@ namespace OpenGrid.Framework.Data.MySQL
             }

         }

 

+        /// <summary>

+        /// Returns a list of folders in a users inventory contained within the specified folder

+        /// </summary>

+        /// <param name="parentID">The folder to search</param>

+        /// <returns>A list of inventory folders</returns>

         public List<InventoryFolderBase> getInventoryFolders(LLUUID parentID)

         {

             try

@@ -122,6 +183,11 @@ namespace OpenGrid.Framework.Data.MySQL
             }

         }

 

+        /// <summary>

+        /// Returns a specified inventory item

+        /// </summary>

+        /// <param name="item">The item to return</param>

+        /// <returns>An inventory item</returns>

         public InventoryItemBase getInventoryItem(LLUUID item)

         {

             try

@@ -157,6 +223,11 @@ namespace OpenGrid.Framework.Data.MySQL
             }

         }

 

+        /// <summary>

+        /// Returns a specified inventory folder

+        /// </summary>

+        /// <param name="folder">The folder to return</param>

+        /// <returns>A folder class</returns>

         public InventoryFolderBase getInventoryFolder(LLUUID folder)

         {

             try

@@ -192,6 +263,10 @@ namespace OpenGrid.Framework.Data.MySQL
             }

         }

 

+        /// <summary>

+        /// Adds a specified item to the database

+        /// </summary>

+        /// <param name="item">The inventory item</param>

         public void addInventoryItem(InventoryItemBase item)

         {

             lock (database)

@@ -200,11 +275,19 @@ namespace OpenGrid.Framework.Data.MySQL
             }

         }

 

+        /// <summary>

+        /// Updates the specified inventory item

+        /// </summary>

+        /// <param name="item">Inventory item to update</param>

         public void updateInventoryItem(InventoryItemBase item)

         {

             addInventoryItem(item);

         }

 

+        /// <summary>

+        /// Creates a new inventory folder

+        /// </summary>

+        /// <param name="folder">Folder to create</param>

         public void addInventoryFolder(InventoryFolderBase folder)

         {

             lock (database)

@@ -213,6 +296,10 @@ namespace OpenGrid.Framework.Data.MySQL
             }

         }

 

+        /// <summary>

+        /// Updates an inventory folder

+        /// </summary>

+        /// <param name="folder">Folder to update</param>

         public void updateInventoryFolder(InventoryFolderBase folder)

         {

             addInventoryFolder(folder);