Visual Application Launcher

namespace VAL.Contracts
{
    using System;
    using System.ServiceModel;
    using VAL.Contracts.ServiceFaults;
    using VAL.Model;

    /// <summary>
    /// Defines the contract for operations available to a standard user
    /// </summary>
    public interface IUserService
    {
        /// <summary>
        /// Gets a user object based on the windows identity name
        /// </summary>
        /// <param name="userName">The users windows identity name</param>
        /// <returns>A <see cref="User"/> object</returns>
        /// <exception cref="UserInactiveException">The user is currently set to inactive</exception>
        /// <exception cref="UserNotFoundException">The specified user name was not found in the database</exception>
        User GetUser(string userName);

        /// <summary>
        /// Gets a user object based on the specified unique identifier
        /// </summary>
        /// <param name="id">The id of the VAL user record</param>
        /// <returns>A <see cref="User"/> object</returns>
        User GetUser(int id);

        /// <summary>
        /// Deletes a user from the database that matches the specified ID
        /// </summary>
        /// <param name="userId">The unique ID of the user</param>
        void DeleteUser(int userId);

        /// <summary>
        /// Either inserts or updates a <see cref="User"/> instance
        /// </summary>
        /// <param name="file">The <see cref="User"/> to persist to the database</param>
        User SaveUser(User user);

        /// <summary>
        /// Gets a list of all active <see cref="User"/>s that are defined within a particular <see cref="Group"/>
        /// </summary>
        /// <param name="groupId">The unique ID of the group</param>
        /// <returns>List of users defined within a group</returns>
        User[] GetGroupUsers(int groupId);

        /// <summary>
        /// Gets a list of all <see cref="User"/>s that are defined in the database
        /// </summary>
        /// <returns>List of Users</returns>
        User[] GetUsers();

        /// <summary>
        /// Gets a list of all active <see cref="User"/>s that are defined in the database
        /// </summary>
        /// <returns>List of active Users</returns>
        User[] GetActiveUsers();

        /// <summary>
        /// Clones a set of permissions from one user to another
        /// </summary>
        /// <param name="groups">A user object that defines a new user to save to the database</param>
        /// <param name="targetUserId">An array of groups identifiers to apply to the user</param>
        void CloneUserPermissions(User user, int targetUserId);
    }
}