IInventoryService.cs 8.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204
  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 OpenSimulator 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;
  28. using System.Collections.Generic;
  29. using OpenSim.Framework;
  30. using OpenMetaverse;
  31. namespace OpenSim.Services.Interfaces
  32. {
  33. /// <summary>
  34. /// Callback used when a user's inventory is received from the inventory service
  35. /// </summary>
  36. public delegate void InventoryReceiptCallback(
  37. ICollection<InventoryFolderImpl> folders, ICollection<InventoryItemBase> items);
  38. public interface IInventoryService
  39. {
  40. /// <summary>
  41. /// Create the entire inventory for a given user
  42. /// </summary>
  43. /// <param name="user"></param>
  44. /// <returns></returns>
  45. bool CreateUserInventory(UUID user);
  46. /// <summary>
  47. /// Gets the skeleton of the inventory -- folders only
  48. /// </summary>
  49. /// <param name="userId"></param>
  50. /// <returns></returns>
  51. List<InventoryFolderBase> GetInventorySkeleton(UUID userId);
  52. /// <summary>
  53. /// Retrieve the root inventory folder for the given user.
  54. /// </summary>
  55. /// <param name="userID"></param>
  56. /// <returns>null if no root folder was found</returns>
  57. InventoryFolderBase GetRootFolder(UUID userID);
  58. /// <summary>
  59. /// Gets the user folder for the given folder-type
  60. /// </summary>
  61. /// <param name="userID"></param>
  62. /// <param name="type"></param>
  63. /// <returns></returns>
  64. InventoryFolderBase GetFolderForType(UUID userID, FolderType type);
  65. /// <summary>
  66. /// Gets everything (folders and items) inside a folder
  67. /// </summary>
  68. /// <param name="userId"></param>
  69. /// <param name="folderID"></param>
  70. /// <returns>Inventory content. null if the request failed.</returns>
  71. InventoryCollection GetFolderContent(UUID userID, UUID folderID);
  72. /// <summary>
  73. /// Gets everything (folders and items) inside a folder
  74. /// </summary>
  75. /// <param name="userId"></param>
  76. /// <param name="folderIDs"></param>
  77. /// <returns>Inventory content.</returns>
  78. InventoryCollection[] GetMultipleFoldersContent(UUID userID, UUID[] folderIDs);
  79. /// <summary>
  80. /// Gets the items inside a folder
  81. /// </summary>
  82. /// <param name="userID"></param>
  83. /// <param name="folderID"></param>
  84. /// <returns></returns>
  85. List<InventoryItemBase> GetFolderItems(UUID userID, UUID folderID);
  86. /// <summary>
  87. /// Add a new folder to the user's inventory
  88. /// </summary>
  89. /// <param name="folder"></param>
  90. /// <returns>true if the folder was successfully added</returns>
  91. bool AddFolder(InventoryFolderBase folder);
  92. /// <summary>
  93. /// Update a folder in the user's inventory
  94. /// </summary>
  95. /// <param name="folder"></param>
  96. /// <returns>true if the folder was successfully updated</returns>
  97. bool UpdateFolder(InventoryFolderBase folder);
  98. /// <summary>
  99. /// Move an inventory folder to a new location
  100. /// </summary>
  101. /// <param name="folder">A folder containing the details of the new location</param>
  102. /// <returns>true if the folder was successfully moved</returns>
  103. bool MoveFolder(InventoryFolderBase folder);
  104. /// <summary>
  105. /// Delete an item from the user's inventory
  106. /// </summary>
  107. /// <param name="item"></param>
  108. /// <returns>true if the item was successfully deleted</returns>
  109. //bool DeleteItem(InventoryItemBase item);
  110. bool DeleteFolders(UUID userID, List<UUID> folderIDs);
  111. /// <summary>
  112. /// Purge an inventory folder of all its items and subfolders.
  113. /// </summary>
  114. /// <param name="folder"></param>
  115. /// <returns>true if the folder was successfully purged</returns>
  116. bool PurgeFolder(InventoryFolderBase folder);
  117. /// <summary>
  118. /// Add a new item to the user's inventory
  119. /// </summary>
  120. /// <param name="item">
  121. /// The item to be added. If item.FolderID == UUID.Zero then the item is added to the most suitable system
  122. /// folder. If there is no suitable folder then the item is added to the user's root inventory folder.
  123. /// </param>
  124. /// <returns>true if the item was successfully added, false if it was not</returns>
  125. bool AddItem(InventoryItemBase item);
  126. /// <summary>
  127. /// Update an item in the user's inventory
  128. /// </summary>
  129. /// <param name="item"></param>
  130. /// <returns>true if the item was successfully updated</returns>
  131. bool UpdateItem(InventoryItemBase item);
  132. bool MoveItems(UUID ownerID, List<InventoryItemBase> items);
  133. /// <summary>
  134. /// Delete an item from the user's inventory
  135. /// </summary>
  136. /// <param name="item"></param>
  137. /// <returns>true if the item was successfully deleted</returns>
  138. //bool DeleteItem(InventoryItemBase item);
  139. bool DeleteItems(UUID userID, List<UUID> itemIDs);
  140. /// <summary>
  141. /// Get an item, given by its UUID
  142. /// </summary>
  143. /// <param name="item"></param>
  144. /// <returns>null if no item was found, otherwise the found item</returns>
  145. InventoryItemBase GetItem(InventoryItemBase item);
  146. /// <summary>
  147. /// Get multiple items, given by their UUIDs
  148. /// </summary>
  149. /// <param name="item"></param>
  150. /// <returns>null if no item was found, otherwise the found item</returns>
  151. InventoryItemBase[] GetMultipleItems(UUID userID, UUID[] ids);
  152. /// <summary>
  153. /// Get a folder, given by its UUID
  154. /// </summary>
  155. /// <param name="folder"></param>
  156. /// <returns></returns>
  157. InventoryFolderBase GetFolder(InventoryFolderBase folder);
  158. /// <summary>
  159. /// Does the given user have an inventory structure?
  160. /// </summary>
  161. /// <param name="userID"></param>
  162. /// <returns></returns>
  163. bool HasInventoryForUser(UUID userID);
  164. /// <summary>
  165. /// Get the active gestures of the agent.
  166. /// </summary>
  167. /// <param name="userId"></param>
  168. /// <returns></returns>
  169. List<InventoryItemBase> GetActiveGestures(UUID userId);
  170. /// <summary>
  171. /// Get the union of permissions of all inventory items
  172. /// that hold the given assetID.
  173. /// </summary>
  174. /// <param name="userID"></param>
  175. /// <param name="assetID"></param>
  176. /// <returns>The permissions or 0 if no such asset is found in
  177. /// the user's inventory</returns>
  178. int GetAssetPermissions(UUID userID, UUID assetID);
  179. }
  180. }