From 0898be5750a9e5f0cfab566a34b65e4a227d82e6 Mon Sep 17 00:00:00 2001
From: Justin Clark-Casey (justincc)
Date: Mon, 31 Jan 2011 22:54:36 +0000
Subject: Change SimianGroupsServicesConnectorModule.GetAgentGroupMembership()
 so that it returns null if the user isn't a member of the group.

This matches the behaviour of the same method for Flotsam Groups.  This is the behaviour assumed by existing code.
Method doc also added to IGroupsServicesConnector to the make the contract clear.
---
 .../Avatar/XmlRpcGroups/IGroupsServicesConnector.cs   | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

(limited to 'OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/IGroupsServicesConnector.cs')

diff --git a/OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/IGroupsServicesConnector.cs b/OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/IGroupsServicesConnector.cs
index 5c779de..6d26075 100644
--- a/OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/IGroupsServicesConnector.cs
+++ b/OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/IGroupsServicesConnector.cs
@@ -63,7 +63,26 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
         void SetAgentActiveGroupRole(UUID RequestingAgentID, UUID AgentID, UUID GroupID, UUID RoleID);
         void SetAgentGroupInfo(UUID RequestingAgentID, UUID AgentID, UUID GroupID, bool AcceptNotices, bool ListInProfile);
 
+        /// <summary>
+        /// Get information about a specific group to which the user belongs.
+        /// </summary>
+        /// <param name="RequestingAgentID">The agent requesting the information.</param>
+        /// <param name="AgentID">The agent requested.</param>
+        /// <param name="GroupID">The group requested.</param>
+        /// <returns>
+        /// If the user is a member of the group then the data structure is returned.  If not, then null is returned.
+        /// </returns>
         GroupMembershipData GetAgentGroupMembership(UUID RequestingAgentID, UUID AgentID, UUID GroupID);
+        
+        /// <summary>
+        /// Get information about the groups to which a user belongs.
+        /// </summary>
+        /// <param name="RequestingAgentID">The agent requesting the information.</param>
+        /// <param name="AgentID">The agent requested.</param>
+        /// <returns>
+        /// Information about the groups to which the user belongs.  If the user belongs to no groups then an empty
+        /// list is returned.
+        /// </returns>
         List<GroupMembershipData> GetAgentGroupMemberships(UUID RequestingAgentID, UUID AgentID);
 
         void AddGroupNotice(UUID RequestingAgentID, UUID groupID, UUID noticeID, string fromName, string subject, string message, byte[] binaryBucket);
-- 
cgit v1.1