summaryrefslogtreecommitdiff
path: root/java/demo/Freeze/library/Library.ice
blob: 6faa6e3f8e9df32879fd43e01f8075ebedd54239 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
// **********************************************************************
//
// Copyright (c) 2003-2009 ZeroC, Inc. All rights reserved.
//
// This copy of Ice is licensed to you under the terms described in the
// ICE_LICENSE file included in this distribution.
//
// **********************************************************************

#ifndef LIBRARY_ICE
#define LIBRARY_ICE

module Demo
{

/**
 *
 * This exception is raised in the case of a database failure.
 *
 **/
exception DatabaseException
{
    string message;
};

/**
 *
 * This exception is raised if the book already exists.
 *
 **/
exception BookExistsException
{
};

/**
 *
 * This exception is raised if a book has already been rented.
 *
 **/
exception BookRentedException
{
};

/**
 *
 * This exception is raised if the book has not been rented.
 *
 **/
exception BookNotRentedException
{
};

/**
 *
 * A description of a book.
 *
 **/
struct BookDescription
{
    /** The ISBN number of the book.  */
    string isbn;

    /** The title of the book. */
    string title;

    /** The authors of the book. */
    string authors;
};

/**
 *
 * This class represents a book.
 *
 **/
class Book
{
    /**
     *
     * Get a description of the book.
     *
     * @return The book description.
     *
     **/
    idempotent BookDescription getBookDescription();

    /**
     *
     * Destroy the book.
     *
     * @throws DatabaseException Raised if there is a problem with the
     * database system.
     *
     **/
    ["freeze:write"] void destroy()
        throws DatabaseException;

    /**
     *
     * Rent the book to the specified customer.
     *
     * @param name The name of the customer.
     *
     * @throws BookRentedException Raised if the book has already been
     * rented.
     *
     **/
    ["freeze:write"] void rentBook(string name)
        throws BookRentedException;

    /**
     *
     * Get the name of the renter.
     *
     * @return The name the current rental customer.
     *
     * @throws BookNotRentedException Raised if the book is not
     * currently rented.
     *
     **/
    idempotent string getRenterName()
        throws BookNotRentedException;

    /**
     *
     * Return the book.
     *
     * @throws BookNotRentedException Raised if the book is not
     * currently rented.
     *
     **/
    ["freeze:write"] void returnBook()
        throws BookNotRentedException;

    /**
     *
     * The description for this book. Once a book has been created
     * this information is immutable.
     *
     **/
    BookDescription description;

    /**
     *
     * The name of the current rental customer, or the empty string if
     * the book is not currently rented.
     *
     **/
    string rentalCustomerName;
};

/**
 *
 * A sequence of book proxies.
 *
 **/
sequence<Book*> BookPrxSeq;

/**
 *
 * This interface represents a library.
 *
 **/
interface Library
{
    /**
     *
     * Create a book with the given description.
     *
     * @param description The book description.
     *
     * @return A proxy for the new book.
     *
     * @throws DatabaseException Raised if there is a problem with the
     * database.
     *
     * @throws BookExistsException Raised if the book already exists.
     *
     **/
    Book* createBook(BookDescription description)
        throws DatabaseException, BookExistsException;

    /**
     *
     * Find a book by its ISBN number.
     *
     * @param isbn The ISBN number.
     *
     * @return The result of the search, or an null proxy if the book
     * was not found.
     *
     * @throws DatabaseException Raised if there is a problem with the database.
     *
     **/
    idempotent Book* findByIsbn(string isbn)
        throws DatabaseException;

    /**
     *
     * Find all books with a given authors.
     *
     * @param title The search parameters.
     *
     * @return The result of the search, or an empty sequence if no
     * books were found.
     *
     * @throws DatabaseException Raised if there is a problem with the database.
     *
     **/
    idempotent BookPrxSeq findByAuthors(string authors)
        throws DatabaseException;

    /**
     *
     * Set the evictor size.
     *
     * @param size The new size for the evictor.
     *
     * @throws DatabaseException Raised if there is a problem with the
     * database.
     *
     **/
    idempotent void setEvictorSize(int size)
        throws DatabaseException;

    /**
     *
     * Shutdown the server.
     *
     **/
    void shutdown();
};

};

#endif