From 9bc4dc6c5f7c8d1430db31a657399d0bf794a7f7 Mon Sep 17 00:00:00 2001
From: Justin Clark-Casey (justincc)
Date: Tue, 30 Oct 2012 01:19:32 +0000
Subject: Add method doc to IAssetService.Get(string, object, AssetRetrieved)
 outlining the situations in which AssetRetrieved may be called back with a
 null AssetBase.

These situations include asset not found and remote service not responding.
---
 OpenSim/Services/Interfaces/IAssetService.cs | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

(limited to 'OpenSim/Services/Interfaces/IAssetService.cs')

diff --git a/OpenSim/Services/Interfaces/IAssetService.cs b/OpenSim/Services/Interfaces/IAssetService.cs
index 80494f1..3c469c6 100644
--- a/OpenSim/Services/Interfaces/IAssetService.cs
+++ b/OpenSim/Services/Interfaces/IAssetService.cs
@@ -68,7 +68,11 @@ namespace OpenSim.Services.Interfaces
         /// </summary>
         /// <param name="id">The asset id</param>
         /// <param name="sender">Represents the requester.  Passed back via the handler</param>
-        /// <param name="handler">The handler to call back once the asset has been retrieved</param>
+        /// <param name="handler">
+        /// The handler to call back once the asset has been retrieved.  This will be called back with a null AssetBase
+        /// if the asset could not be found for some reason (e.g. if it does not exist, if a remote asset service
+        /// was not contactable, if it is not in the database, etc.).
+        /// </param>
         /// <returns>True if the id was parseable, false otherwise</returns>
         bool Get(string id, Object sender, AssetRetrieved handler);
 
-- 
cgit v1.1