/* Copyright (C) 2011, 2012, 2013 by Bundesanstalt für Gewässerkunde
 * Software engineering by Intevation GmbH
 *
 * This file is Free Software under the GNU AGPL (>=v3)
 * and comes with ABSOLUTELY NO WARRANTY! Check out the
 * documentation coming with Dive4Elements River for details.
 */

package org.dive4elements.river.client.client.services;

import com.google.gwt.user.client.rpc.RemoteService;
import com.google.gwt.user.client.rpc.RemoteServiceRelativePath;

import org.dive4elements.river.client.shared.exceptions.AuthenticationException;
import org.dive4elements.river.client.shared.model.User;


/**
 * This interface describes services for the user.
 *
 * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
 */
@RemoteServiceRelativePath("user")
public interface UserService extends RemoteService {

    /**
     * This method retrieves the user that is currently logged in.
     *
     * @param locale The current locale.
     *
     * @return the current {@link User}.
     */
    User getCurrentUser(String locale)
    throws AuthenticationException;

    /**
     * Removes the current user object from the session
     */
    void logoutCurrentUser();
}
// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :