1
2
3 package org.paneris.jammyjoes.model.generated;
4
5
6 import org.melati.poem.AccessPoemException;
7 import org.melati.poem.Column;
8 import org.melati.poem.Field;
9 import org.melati.poem.JdbcPersistent;
10 import org.melati.poem.NoSuchRowPoemException;
11 import org.melati.poem.ValidationPoemException;
12 import org.paneris.jammyjoes.model.DeliveryCarrier;
13 import org.paneris.jammyjoes.model.DeliveryChargeTable;
14 import org.paneris.jammyjoes.model.DeliveryZone;
15 import org.paneris.jammyjoes.model.JammyjoesDatabaseTables;
16
17
18 /**
19 * Melati POEM generated abstract base class for a <code>Persistent</code>
20 * <code>DeliveryCharge</code> Object.
21 *
22 * @generator org.melati.poem.prepro.TableDef#generatePersistentBaseJava
23 */
24 public abstract class DeliveryChargeBase extends JdbcPersistent {
25
26
27 /**
28 * Retrieves the Database object.
29 *
30 * @generator org.melati.poem.prepro.TableDef#generatePersistentBaseJava
31 * @return the database
32 */
33 public JammyjoesDatabaseTables getJammyjoesDatabaseTables() {
34 return (JammyjoesDatabaseTables)getDatabase();
35 }
36
37
38 /**
39 * Retrieves the <code>DeliveryChargeTable</code> table
40 * which this <code>Persistent</code> is from.
41 *
42 * @generator org.melati.poem.prepro.TableDef#generatePersistentBaseJava
43 * @return the DeliveryChargeTable
44 */
45 public DeliveryChargeTable getDeliveryChargeTable() {
46 return (DeliveryChargeTable)getTable();
47 }
48
49 private DeliveryChargeTable _getDeliveryChargeTable() {
50 return (DeliveryChargeTable)getTable();
51 }
52
53
54 /**
55 * id
56 */
57 protected Integer id;
58 /**
59 * Delivery Zone - The Delivery Zone
60 */
61 protected Integer zone;
62 /**
63 * Max Weight in grammes or Min Value in Pounds and Pence
64 */
65 protected Double weight;
66 /**
67 * Cost - The Cost to deliver this weight to this zone
68 */
69 protected Double cost;
70 /**
71 * Delivery Carrier - The Delivery Carrier
72 */
73 protected Integer carrier;
74
75
76 /**
77 * Retrieves the <code>Id</code> value, without locking,
78 * for this <code>DeliveryCharge</code> <code>Persistent</code>.
79 *
80 * @generator org.melati.poem.prepro.FieldDef#generateBaseMethods
81 * @return the Integer id
82 */
83 public Integer getId_unsafe() {
84 return id;
85 }
86
87
88 /**
89 * Sets the <code>Id</code> value directly, without checking,
90 * for this DeliveryCharge <code>Persistent</code>.
91 *
92 * @generator org.melati.poem.prepro.FieldDef#generateBaseMethods
93 * @param cooked the pre-validated value to set
94 */
95 public void setId_unsafe(Integer cooked) {
96 id = cooked;
97 }
98
99 /**
100 * Retrieves the Id value, with locking, for this
101 * <code>DeliveryCharge</code> <code>Persistent</code>.
102 *
103 * @generator org.melati.poem.prepro.AtomFieldDef#generateBaseMethods
104 * @throws AccessPoemException
105 * if the current <code>AccessToken</code>
106 * does not confer write access rights
107 * @return the value of the field <code>Id</code> for this
108 * <code>DeliveryCharge</code> <code>Persistent</code>
109 */
110
111 public Integer getId()
112 throws AccessPoemException {
113 readLock();
114 return getId_unsafe();
115 }
116
117
118 /**
119 * Sets the <code>Id</code> value, with checking, for this
120 * <code>DeliveryCharge</code> <code>Persistent</code>.
121 *
122 * @generator org.melati.poem.prepro.AtomFieldDef#generateBaseMethods
123 * @param cooked a validated <code>int</code>
124 * @throws AccessPoemException
125 * if the current <code>AccessToken</code>
126 * does not confer write access rights
127 * @throws ValidationPoemException
128 * if the value is not valid
129 */
130 public void setId(Integer cooked)
131 throws AccessPoemException, ValidationPoemException {
132 _getDeliveryChargeTable().getIdColumn().
133 getType().assertValidCooked(cooked);
134 writeLock();
135 setId_unsafe(cooked);
136 }
137
138 /**
139 * Sets the <code>Id</code> value, with checking, for this
140 * <code>DeliveryCharge</code> <code>Persistent</code>.
141 *
142 * @generator org.melati.poem.prepro.IntegerFieldDef#generateBaseMethods
143 * @param cooked a validated <code>int</code>
144 * @throws AccessPoemException
145 * if the current <code>AccessToken</code>
146 * does not confer write access rights
147 * @throws ValidationPoemException
148 * if the value is not valid
149 */
150
151 public final void setId(int cooked)
152 throws AccessPoemException, ValidationPoemException {
153 setId(new Integer(cooked));
154 }
155
156
157 /**
158 * Retrieves the <code>Id</code> value as a <code>Field</code>
159 * from this <code>DeliveryCharge</code> <code>Persistent</code>.
160 *
161 * @generator org.melati.poem.prepro.FieldDef#generateFieldCreator
162 * @throws AccessPoemException
163 * if the current <code>AccessToken</code>
164 * does not confer write access rights
165 * @return the Integer id
166 */
167 public Field getIdField() throws AccessPoemException {
168 Column c = _getDeliveryChargeTable().getIdColumn();
169 return new Field(c.getRaw(this), c);
170 }
171
172
173 /**
174 * Retrieves the <code>Zone</code> value, without locking,
175 * for this <code>DeliveryCharge</code> <code>Persistent</code>.
176 *
177 * @generator org.melati.poem.prepro.FieldDef#generateBaseMethods
178 * @return the Integer zone
179 */
180 public Integer getZone_unsafe() {
181 return zone;
182 }
183
184
185 /**
186 * Sets the <code>Zone</code> value directly, without checking,
187 * for this DeliveryCharge <code>Persistent</code>.
188 *
189 * @generator org.melati.poem.prepro.FieldDef#generateBaseMethods
190 * @param cooked the pre-validated value to set
191 */
192 public void setZone_unsafe(Integer cooked) {
193 zone = cooked;
194 }
195
196 /**
197 * Retrieves the Table Row Object ID.
198 *
199 * @generator org.melati.poem.prepro.ReferenceFieldDef#generateBaseMethods
200 * @throws AccessPoemException
201 * if the current <code>AccessToken</code>
202 * does not confer read access rights
203 * @return the TROID as an <code>Integer</code>
204 */
205
206 public Integer getZoneTroid()
207 throws AccessPoemException {
208 readLock();
209 return getZone_unsafe();
210 }
211
212
213 /**
214 * Sets the Table Row Object ID.
215 *
216 * @generator org.melati.poem.prepro.ReferenceFieldDef#generateBaseMethods
217 * @param raw a Table Row Object Id
218 * @throws AccessPoemException
219 * if the current <code>AccessToken</code>
220 * does not confer write access rights
221 */
222 public void setZoneTroid(Integer raw)
223 throws AccessPoemException {
224 setZone(raw == null ? null :
225 getJammyjoesDatabaseTables().getDeliveryZoneTable().getDeliveryZoneObject(raw));
226 }
227
228
229 /**
230 * Retrieves the <code>Zone</code> object referred to.
231 *
232 * @generator org.melati.poem.prepro.ReferenceFieldDef#generateBaseMethods
233 * @throws AccessPoemException
234 * if the current <code>AccessToken</code>
235 * does not confer read access rights
236 * @throws NoSuchRowPoemException
237 * if the <code>Persistent</code> has yet to be allocated a TROID
238 * @return the <code>Zone</code> as a <code>DeliveryZone</code>
239 */
240 public DeliveryZone getZone()
241 throws AccessPoemException, NoSuchRowPoemException {
242 Integer troid = getZoneTroid();
243 return troid == null ? null :
244 getJammyjoesDatabaseTables().getDeliveryZoneTable().getDeliveryZoneObject(troid);
245 }
246
247
248 /**
249 * Set the Zone.
250 *
251 * @generator org.melati.poem.prepro.ReferenceFieldDef#generateBaseMethods
252 * @param cooked a validated <code>DeliveryZone</code>
253 * @throws AccessPoemException
254 * if the current <code>AccessToken</code>
255 * does not confer write access rights
256 */
257 public void setZone(DeliveryZone cooked)
258 throws AccessPoemException {
259 _getDeliveryChargeTable().
260 getZoneColumn().
261 getType().assertValidCooked(cooked);
262 writeLock();
263 if (cooked == null)
264 setZone_unsafe(null);
265 else {
266 cooked.existenceLock();
267 setZone_unsafe(cooked.troid());
268 }
269 }
270
271
272 /**
273 * Retrieves the <code>Zone</code> value as a <code>Field</code>
274 * from this <code>DeliveryCharge</code> <code>Persistent</code>.
275 *
276 * @generator org.melati.poem.prepro.FieldDef#generateFieldCreator
277 * @throws AccessPoemException
278 * if the current <code>AccessToken</code>
279 * does not confer write access rights
280 * @return the Integer zone
281 */
282 public Field getZoneField() throws AccessPoemException {
283 Column c = _getDeliveryChargeTable().getZoneColumn();
284 return new Field(c.getRaw(this), c);
285 }
286
287
288 /**
289 * Retrieves the <code>Weight</code> value, without locking,
290 * for this <code>DeliveryCharge</code> <code>Persistent</code>.
291 *
292 * @generator org.melati.poem.prepro.FieldDef#generateBaseMethods
293 * @return the Double weight
294 */
295 public Double getWeight_unsafe() {
296 return weight;
297 }
298
299
300 /**
301 * Sets the <code>Weight</code> value directly, without checking,
302 * for this DeliveryCharge <code>Persistent</code>.
303 *
304 * @generator org.melati.poem.prepro.FieldDef#generateBaseMethods
305 * @param cooked the pre-validated value to set
306 */
307 public void setWeight_unsafe(Double cooked) {
308 weight = cooked;
309 }
310
311 /**
312 * Retrieves the Weight value, with locking, for this
313 * <code>DeliveryCharge</code> <code>Persistent</code>.
314 *
315 * @generator org.melati.poem.prepro.AtomFieldDef#generateBaseMethods
316 * @throws AccessPoemException
317 * if the current <code>AccessToken</code>
318 * does not confer write access rights
319 * @return the value of the field <code>Weight</code> for this
320 * <code>DeliveryCharge</code> <code>Persistent</code>
321 */
322
323 public Double getWeight()
324 throws AccessPoemException {
325 readLock();
326 return getWeight_unsafe();
327 }
328
329
330 /**
331 * Sets the <code>Weight</code> value, with checking, for this
332 * <code>DeliveryCharge</code> <code>Persistent</code>.
333 *
334 * @generator org.melati.poem.prepro.AtomFieldDef#generateBaseMethods
335 * @param cooked a validated <code>int</code>
336 * @throws AccessPoemException
337 * if the current <code>AccessToken</code>
338 * does not confer write access rights
339 * @throws ValidationPoemException
340 * if the value is not valid
341 */
342 public void setWeight(Double cooked)
343 throws AccessPoemException, ValidationPoemException {
344 _getDeliveryChargeTable().getWeightColumn().
345 getType().assertValidCooked(cooked);
346 writeLock();
347 setWeight_unsafe(cooked);
348 }
349
350 /**
351 * Sets the <code>Weight</code> value, with checking, for this <code>DeliveryCharge</code> <code>Persistent</code>.
352 *
353 * @generator org.melati.poem.prepro.DoubleFieldDef#generateBaseMethods
354 * @param cooked a validated <code>int</code>
355 * @throws AccessPoemException
356 * if the current <code>AccessToken</code>
357 * does not confer write access rights
358 * @throws ValidationPoemException
359 * if the value is not valid
360 */
361
362 public final void setWeight(double cooked)
363 throws AccessPoemException, ValidationPoemException {
364 setWeight(new Double(cooked));
365 }
366
367
368 /**
369 * Retrieves the <code>Weight</code> value as a <code>Field</code>
370 * from this <code>DeliveryCharge</code> <code>Persistent</code>.
371 *
372 * @generator org.melati.poem.prepro.FieldDef#generateFieldCreator
373 * @throws AccessPoemException
374 * if the current <code>AccessToken</code>
375 * does not confer write access rights
376 * @return the Double weight
377 */
378 public Field getWeightField() throws AccessPoemException {
379 Column c = _getDeliveryChargeTable().getWeightColumn();
380 return new Field(c.getRaw(this), c);
381 }
382
383
384 /**
385 * Retrieves the <code>Cost</code> value, without locking,
386 * for this <code>DeliveryCharge</code> <code>Persistent</code>.
387 *
388 * @generator org.melati.poem.prepro.FieldDef#generateBaseMethods
389 * @return the Double cost
390 */
391 public Double getCost_unsafe() {
392 return cost;
393 }
394
395
396 /**
397 * Sets the <code>Cost</code> value directly, without checking,
398 * for this DeliveryCharge <code>Persistent</code>.
399 *
400 * @generator org.melati.poem.prepro.FieldDef#generateBaseMethods
401 * @param cooked the pre-validated value to set
402 */
403 public void setCost_unsafe(Double cooked) {
404 cost = cooked;
405 }
406
407 /**
408 * Retrieves the Cost value, with locking, for this
409 * <code>DeliveryCharge</code> <code>Persistent</code>.
410 * Field description:
411 * The Cost to deliver this weight to this zone
412 *
413 * @generator org.melati.poem.prepro.AtomFieldDef#generateBaseMethods
414 * @throws AccessPoemException
415 * if the current <code>AccessToken</code>
416 * does not confer write access rights
417 * @return the value of the field <code>Cost</code> for this
418 * <code>DeliveryCharge</code> <code>Persistent</code>
419 */
420
421 public Double getCost()
422 throws AccessPoemException {
423 readLock();
424 return getCost_unsafe();
425 }
426
427
428 /**
429 * Sets the <code>Cost</code> value, with checking, for this
430 * <code>DeliveryCharge</code> <code>Persistent</code>.
431 * Field description:
432 * The Cost to deliver this weight to this zone
433 *
434 * @generator org.melati.poem.prepro.AtomFieldDef#generateBaseMethods
435 * @param cooked a validated <code>int</code>
436 * @throws AccessPoemException
437 * if the current <code>AccessToken</code>
438 * does not confer write access rights
439 * @throws ValidationPoemException
440 * if the value is not valid
441 */
442 public void setCost(Double cooked)
443 throws AccessPoemException, ValidationPoemException {
444 _getDeliveryChargeTable().getCostColumn().
445 getType().assertValidCooked(cooked);
446 writeLock();
447 setCost_unsafe(cooked);
448 }
449
450 /**
451 * Sets the <code>Cost</code> value, with checking, for this <code>DeliveryCharge</code> <code>Persistent</code>.
452 * Field description:
453 * The Cost to deliver this weight to this zone
454 *
455 *
456 * @generator org.melati.poem.prepro.DoubleFieldDef#generateBaseMethods
457 * @param cooked a validated <code>int</code>
458 * @throws AccessPoemException
459 * if the current <code>AccessToken</code>
460 * does not confer write access rights
461 * @throws ValidationPoemException
462 * if the value is not valid
463 */
464
465 public final void setCost(double cooked)
466 throws AccessPoemException, ValidationPoemException {
467 setCost(new Double(cooked));
468 }
469
470
471 /**
472 * Retrieves the <code>Cost</code> value as a <code>Field</code>
473 * from this <code>DeliveryCharge</code> <code>Persistent</code>.
474 *
475 * @generator org.melati.poem.prepro.FieldDef#generateFieldCreator
476 * @throws AccessPoemException
477 * if the current <code>AccessToken</code>
478 * does not confer write access rights
479 * @return the Double cost
480 */
481 public Field getCostField() throws AccessPoemException {
482 Column c = _getDeliveryChargeTable().getCostColumn();
483 return new Field(c.getRaw(this), c);
484 }
485
486
487 /**
488 * Retrieves the <code>Carrier</code> value, without locking,
489 * for this <code>DeliveryCharge</code> <code>Persistent</code>.
490 *
491 * @generator org.melati.poem.prepro.FieldDef#generateBaseMethods
492 * @return the Integer carrier
493 */
494 public Integer getCarrier_unsafe() {
495 return carrier;
496 }
497
498
499 /**
500 * Sets the <code>Carrier</code> value directly, without checking,
501 * for this DeliveryCharge <code>Persistent</code>.
502 *
503 * @generator org.melati.poem.prepro.FieldDef#generateBaseMethods
504 * @param cooked the pre-validated value to set
505 */
506 public void setCarrier_unsafe(Integer cooked) {
507 carrier = cooked;
508 }
509
510 /**
511 * Retrieves the Table Row Object ID.
512 *
513 * @generator org.melati.poem.prepro.ReferenceFieldDef#generateBaseMethods
514 * @throws AccessPoemException
515 * if the current <code>AccessToken</code>
516 * does not confer read access rights
517 * @return the TROID as an <code>Integer</code>
518 */
519
520 public Integer getCarrierTroid()
521 throws AccessPoemException {
522 readLock();
523 return getCarrier_unsafe();
524 }
525
526
527 /**
528 * Sets the Table Row Object ID.
529 *
530 * @generator org.melati.poem.prepro.ReferenceFieldDef#generateBaseMethods
531 * @param raw a Table Row Object Id
532 * @throws AccessPoemException
533 * if the current <code>AccessToken</code>
534 * does not confer write access rights
535 */
536 public void setCarrierTroid(Integer raw)
537 throws AccessPoemException {
538 setCarrier(raw == null ? null :
539 getJammyjoesDatabaseTables().getDeliveryCarrierTable().getDeliveryCarrierObject(raw));
540 }
541
542
543 /**
544 * Retrieves the <code>Carrier</code> object referred to.
545 *
546 * @generator org.melati.poem.prepro.ReferenceFieldDef#generateBaseMethods
547 * @throws AccessPoemException
548 * if the current <code>AccessToken</code>
549 * does not confer read access rights
550 * @throws NoSuchRowPoemException
551 * if the <code>Persistent</code> has yet to be allocated a TROID
552 * @return the <code>Carrier</code> as a <code>DeliveryCarrier</code>
553 */
554 public DeliveryCarrier getCarrier()
555 throws AccessPoemException, NoSuchRowPoemException {
556 Integer troid = getCarrierTroid();
557 return troid == null ? null :
558 getJammyjoesDatabaseTables().getDeliveryCarrierTable().getDeliveryCarrierObject(troid);
559 }
560
561
562 /**
563 * Set the Carrier.
564 *
565 * @generator org.melati.poem.prepro.ReferenceFieldDef#generateBaseMethods
566 * @param cooked a validated <code>DeliveryCarrier</code>
567 * @throws AccessPoemException
568 * if the current <code>AccessToken</code>
569 * does not confer write access rights
570 */
571 public void setCarrier(DeliveryCarrier cooked)
572 throws AccessPoemException {
573 _getDeliveryChargeTable().
574 getCarrierColumn().
575 getType().assertValidCooked(cooked);
576 writeLock();
577 if (cooked == null)
578 setCarrier_unsafe(null);
579 else {
580 cooked.existenceLock();
581 setCarrier_unsafe(cooked.troid());
582 }
583 }
584
585
586 /**
587 * Retrieves the <code>Carrier</code> value as a <code>Field</code>
588 * from this <code>DeliveryCharge</code> <code>Persistent</code>.
589 *
590 * @generator org.melati.poem.prepro.FieldDef#generateFieldCreator
591 * @throws AccessPoemException
592 * if the current <code>AccessToken</code>
593 * does not confer write access rights
594 * @return the Integer carrier
595 */
596 public Field getCarrierField() throws AccessPoemException {
597 Column c = _getDeliveryChargeTable().getCarrierColumn();
598 return new Field(c.getRaw(this), c);
599 }
600 }
601