IInventoryServices.cs 5.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119
  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. using System.Collections.Generic;
  28. using libsecondlife;
  29. using OpenSim.Framework.Communications.Cache;
  30. namespace OpenSim.Framework.Communications
  31. {
  32. /// <summary>
  33. /// Callback used when a user's inventory is received from the inventory service
  34. /// </summary>
  35. public delegate void InventoryReceiptCallback(
  36. ICollection<InventoryFolderImpl> folders, ICollection<InventoryItemBase> items);
  37. /// <summary>
  38. /// Defines all the operations one can perform on a user's inventory.
  39. /// </summary>
  40. public interface IInventoryServices
  41. {
  42. /// <summary>
  43. /// Request the inventory for a user. This is an asynchronous operation that will call the callback when the
  44. /// inventory has been received
  45. /// </summary>
  46. /// <param name="userID"></param>
  47. /// <param name="callback"></param>
  48. void RequestInventoryForUser(LLUUID userID, InventoryReceiptCallback callback);
  49. /// <summary>
  50. /// Add a new folder to the user's inventory
  51. /// </summary>
  52. /// <param name="folder"></param>
  53. /// <returns>true if the folder was successfully added</returns>
  54. bool AddFolder(InventoryFolderBase folder);
  55. /// <summary>
  56. /// Move an inventory folder to a new location
  57. /// </summary>
  58. /// <param name="folder">A folder containing the details of the new location</param>
  59. /// <returns>true if the folder was successfully moved</returns>
  60. bool MoveFolder(InventoryFolderBase folder);
  61. /// <summary>
  62. /// Purge an inventory folder of all its items and subfolders.
  63. /// </summary>
  64. /// <param name="folder"></param>
  65. /// <returns>true if the folder was successfully purged</returns>
  66. bool PurgeFolder(InventoryFolderBase folder);
  67. /// <summary>
  68. /// Add a new item to the user's inventory
  69. /// </summary>
  70. /// <param name="item"></param>
  71. /// <returns>true if the item was successfully added</returns>
  72. bool AddItem(InventoryItemBase item);
  73. /// <summary>
  74. /// Update an item in the user's inventory
  75. /// </summary>
  76. /// <param name="item"></param>
  77. /// <returns>true if the item was successfully updated</returns>
  78. bool UpdateItem(InventoryItemBase item);
  79. /// <summary>
  80. /// Delete an item from the user's inventory
  81. /// </summary>
  82. /// <param name="item"></param>
  83. /// <returns>true if the item was successfully deleted</returns>
  84. bool DeleteItem(InventoryItemBase item);
  85. /// <summary>
  86. /// Create a new inventory for the given user.
  87. /// </summary>
  88. /// <param name="user"></param>
  89. /// <returns>true if the inventory was successfully created, false otherwise</returns>
  90. bool CreateNewUserInventory(LLUUID user);
  91. bool HasInventoryForUser(LLUUID userID);
  92. /// <summary>
  93. /// Retrieve the root inventory folder for the given user.
  94. /// </summary>
  95. /// <param name="userID"></param>
  96. /// <returns>null if no root folder was found</returns>
  97. InventoryFolderBase RequestRootFolder(LLUUID userID);
  98. /// <summary>
  99. /// Returns a list of all the folders in a given user's inventory.
  100. /// </summary>
  101. /// <param name="userId"></param>
  102. /// <returns>A flat list of the user's inventory folder tree,
  103. /// null if there is no inventory for this user</returns>
  104. List<InventoryFolderBase> GetInventorySkeleton(LLUUID userId);
  105. }
  106. }