IEstateDataService.cs 4.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115
  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.Region.Framework.Interfaces
  32. {
  33. public interface IEstateDataService
  34. {
  35. /// <summary>
  36. /// Load estate settings for a region.
  37. /// </summary>
  38. /// <param name="regionID"></param>
  39. /// <param name="create">If true, then an estate is created if one is not found.</param>
  40. /// <returns></returns>
  41. EstateSettings LoadEstateSettings(UUID regionID, bool create);
  42. /// <summary>
  43. /// Load estate settings for an estate ID.
  44. /// </summary>
  45. /// <param name="estateID"></param>
  46. /// <returns></returns>
  47. EstateSettings LoadEstateSettings(int estateID);
  48. /// <summary>
  49. /// Create a new estate.
  50. /// </summary>
  51. /// <returns>
  52. /// A <see cref="EstateSettings"/>
  53. /// </returns>
  54. EstateSettings CreateNewEstate();
  55. /// <summary>
  56. /// Load/Get all estate settings.
  57. /// </summary>
  58. /// <returns>An empty list if no estates were found.</returns>
  59. List<EstateSettings> LoadEstateSettingsAll();
  60. /// <summary>
  61. /// Store estate settings.
  62. /// </summary>
  63. /// <remarks>
  64. /// This is also called by EstateSettings.Save()</remarks>
  65. /// <param name="es"></param>
  66. void StoreEstateSettings(EstateSettings es);
  67. /// <summary>
  68. /// Get estate IDs.
  69. /// </summary>
  70. /// <param name="search">Name of estate to search for. This is the exact name, no parttern matching is done.</param>
  71. /// <returns></returns>
  72. List<int> GetEstates(string search);
  73. /// <summary>
  74. /// Get the IDs of all estates owned by the given user.
  75. /// </summary>
  76. /// <returns>An empty list if no estates were found.</returns>
  77. List<int> GetEstatesByOwner(UUID ownerID);
  78. /// <summary>
  79. /// Get the IDs of all estates.
  80. /// </summary>
  81. /// <returns>An empty list if no estates were found.</returns>
  82. List<int> GetEstatesAll();
  83. /// <summary>
  84. /// Link a region to an estate.
  85. /// </summary>
  86. /// <param name="regionID"></param>
  87. /// <param name="estateID"></param>
  88. /// <returns>true if the link succeeded, false otherwise</returns>
  89. bool LinkRegion(UUID regionID, int estateID);
  90. /// <summary>
  91. /// Get the UUIDs of all the regions in an estate.
  92. /// </summary>
  93. /// <param name="estateID"></param>
  94. /// <returns></returns>
  95. List<UUID> GetRegions(int estateID);
  96. /// <summary>
  97. /// Delete an estate
  98. /// </summary>
  99. /// <param name="estateID"></param>
  100. /// <returns>true if the delete succeeded, false otherwise</returns>
  101. bool DeleteEstate(int estateID);
  102. }
  103. }