/*
 * Copyright (C) 2015 Red Hat, Inc. and/or its affiliates.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.jboss.errai.demo.todo.shared;

import org.jboss.errai.bus.server.annotations.Remote;

@Remote
public interface SignupService {

  /**
   * Attempts to register a new user in the system. If successful, the newly
   * registered user will be logged in on the server-side session.
   *
   * @param newUserObject
   *          The data about the user to register.
   * @return a copy of the newly registered User with its ID filled in.
   * @throws RegistrationException
   *           if the signup is not possible (for example, disallowed password;
   *           email address already in use; etc).
   */
  TodoListUser register(TodoListUser newUserObject, String password) throws RegistrationException;
}
