From 3436961bb5c01d659d09be134368f4f69460cef9 Mon Sep 17 00:00:00 2001 From: MW Date: Sat, 26 May 2007 13:40:19 +0000 Subject: Start of rewrite 5279! --- .../OpenGrid.Framework.Data/UserData.cs | 101 +++++++++++++++++++++ 1 file changed, 101 insertions(+) create mode 100644 OpenGridServices/OpenGrid.Framework.Data/UserData.cs (limited to 'OpenGridServices/OpenGrid.Framework.Data/UserData.cs') diff --git a/OpenGridServices/OpenGrid.Framework.Data/UserData.cs b/OpenGridServices/OpenGrid.Framework.Data/UserData.cs new file mode 100644 index 0000000..4802c5f --- /dev/null +++ b/OpenGridServices/OpenGrid.Framework.Data/UserData.cs @@ -0,0 +1,101 @@ +using System; +using System.Collections.Generic; +using System.Text; +using libsecondlife; + +namespace OpenGrid.Framework.Data +{ + public interface IUserData + { + /// <summary> + /// Returns a user profile from a database via their UUID + /// </summary> + /// <param name="user">The accounts UUID</param> + /// <returns>The user data profile</returns> + UserProfileData getUserByUUID(LLUUID user); + + /// <summary> + /// Returns a users profile by searching their username + /// </summary> + /// <param name="name">The users username</param> + /// <returns>The user data profile</returns> + UserProfileData getUserByName(string name); + + /// <summary> + /// Returns a users profile by searching their username parts + /// </summary> + /// <param name="fname">Account firstname</param> + /// <param name="lname">Account lastname</param> + /// <returns>The user data profile</returns> + UserProfileData getUserByName(string fname, string lname); + + /// <summary> + /// Returns the current agent for a user searching by it's UUID + /// </summary> + /// <param name="user">The users UUID</param> + /// <returns>The current agent session</returns> + UserAgentData getAgentByUUID(LLUUID user); + + /// <summary> + /// Returns the current session agent for a user searching by username + /// </summary> + /// <param name="name">The users account name</param> + /// <returns>The current agent session</returns> + UserAgentData getAgentByName(string name); + + /// <summary> + /// Returns the current session agent for a user searching by username parts + /// </summary> + /// <param name="fname">The users first account name</param> + /// <param name="lname">The users account surname</param> + /// <returns>The current agent session</returns> + UserAgentData getAgentByName(string fname, string lname); + + /// <summary> + /// Adds a new User profile to the database + /// </summary> + /// <param name="user">UserProfile to add</param> + void addNewUserProfile(UserProfileData user); + + /// <summary> + /// Adds a new agent to the database + /// </summary> + /// <param name="agent">The agent to add</param> + void addNewUserAgent(UserAgentData agent); + + /// <summary> + /// Attempts to move currency units between accounts (NOT RELIABLE / TRUSTWORTHY. DONT TRY RUN YOUR OWN CURRENCY EXCHANGE WITH REAL VALUES) + /// </summary> + /// <param name="from">The account to transfer from</param> + /// <param name="to">The account to transfer to</param> + /// <param name="amount">The amount to transfer</param> + /// <returns>Successful?</returns> + bool moneyTransferRequest(LLUUID from, LLUUID to, uint amount); + + /// <summary> + /// Attempts to move inventory between accounts, if inventory is copyable it will be copied into the target account. + /// </summary> + /// <param name="from">User to transfer from</param> + /// <param name="to">User to transfer to</param> + /// <param name="inventory">Specified inventory item</param> + /// <returns>Successful?</returns> + bool inventoryTransferRequest(LLUUID from, LLUUID to, LLUUID inventory); + + /// <summary> + /// Returns the plugin version + /// </summary> + /// <returns>Plugin version in MAJOR.MINOR.REVISION.BUILD format</returns> + string getVersion(); + + /// <summary> + /// Returns the plugin name + /// </summary> + /// <returns>Plugin name, eg MySQL User Provider</returns> + string getName(); + + /// <summary> + /// Initialises the plugin (artificial constructor) + /// </summary> + void Initialise(); + } +} -- cgit v1.1