2 * Copyright (C) 2016 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.exceptions.AddressbookNotFoundException;
24 import org.mxchange.addressbook.model.addressbook.entry.AddressbookEntry;
25 import org.mxchange.jusercore.model.user.User;
28 * A remote session interface for addressbook handling
30 * @author Roland Haeder<roland@mxchange.org>
33 public interface AddressbookSessionBeanRemote extends Serializable {
36 * Retrieves a list of all users this user is not sharing the given address
39 * @param user User instance
40 * @param addressbook Address book instance
42 * @return List of users
44 List<User> allUsersNotSharing (final User user, final Addressbook addressbook);
47 * Count all shared address books by given user
49 * @param user User instance
51 * @return Count of all user's shared address books
53 Integer countAllUserSharedAddressbooks (final User user);
56 * Some getter for an address book instance from given id number. If the
57 * address book is not found, an exception is thrown.
59 * @param addressbookId Id number for address book instance
61 * @return Address book instance
63 * @throws org.mxchange.addressbook.exceptions.AddressbookNotFoundException
64 * If the address book cannot be found by given id number
65 * @throws NullPointerException If addressbookId is null
66 * @throws IllegalArgumentException If the id number is below 1
68 Addressbook getAddressbookById (final Long addressbookId) throws AddressbookNotFoundException;
71 * Returns a list of all entries of given address book, whether the assigned
72 * user is the "owner" or "sharer" of the entry.
74 * @param addressbook Address book instance
76 * @return List of all entries
78 List<AddressbookEntry> allEntries (final Addressbook addressbook);
81 * Some "getter" for a list of address books the logged-in user has created
83 * @param loggedInUser Logged-in user
85 * @return List of all address books
87 List<Addressbook> getUsersAddressbookList (final User loggedInUser);
90 * Creates given address book by persisting it. A User instance must be set,
91 * else an exception is thrown.
93 * @param addressbook Address book instance to create
95 * @return Updated address book instance
98 * org.mxchange.addressbook.exceptions.AddressbookNameAlreadyUsedException
99 * If the address book's name has already been used by the user.
101 Addressbook createAddressbook (final Addressbook addressbook) throws AddressbookNameAlreadyUsedException;
104 * Checks whether the given address book id is used (means available).
106 * @param addressbookId Address book id to check
108 * @return Whether the id is valid
110 boolean isAddressbookIdUsed (final Long addressbookId);
113 * Checks if the given address book's name is already used by the user.
115 * @param addressbook Address bok instance to check
117 * @return Whether the name has already been used by the user
119 boolean isAddressbookNameUsed (final Addressbook addressbook);