2 * Copyright (C) 2015 Roland Haeder
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation, either version 3 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
17 package org.mxchange.addressbook.model.addressbook;
19 import java.io.Serializable;
20 import java.util.List;
21 import javax.ejb.Remote;
22 import org.mxchange.addressbook.exceptions.AddressbookNameAlreadyUsedException;
23 import org.mxchange.addressbook.model.addressbook.entry.AddressbookEntry;
24 import org.mxchange.jusercore.model.user.User;
27 * A remote session interface for addressbook handling
29 * @author Roland Haeder
32 public interface AddressbookSessionBeanRemote extends Serializable {
35 * Returns a list of all entries of given address book, whether the assigned
36 * user is the "owner" or "sharer" of the entry.
38 * @param addressbook Address book instance
40 * @return List of all entries
42 List<AddressbookEntry> allEntries (final Addressbook addressbook);
45 * Some "getter" for a list of address books the logged-in user has created
47 * @param loggedInUser Logged-in user
49 * @return List of all address books
51 List<Addressbook> getUsersList (final User loggedInUser);
54 * Creates given address book by persisting it. A User instance must be set,
55 * else an exception is thrown.
57 * @param addressbook Address book instance to create
59 * @return Updated address book instance
62 * org.mxchange.addressbook.exceptions.AddressbookNameAlreadyUsedException
63 * If the address book's name has already been used by the user.
65 Addressbook createAddressbook (final Addressbook addressbook) throws AddressbookNameAlreadyUsedException;
68 * Checks whether the given address book id is used (means available).
70 * @param addressbookId Address book id to check
71 * @return Whether the id is valid
73 boolean isAddressbookIdUsed (final Long addressbookId);
76 * Checks if the given address book's name is already used by the user.
78 * @param addressbook Address bok instance to check
80 * @return Whether the name has already been used by the user
82 boolean isAddressbookNameUsed (final Addressbook addressbook);