1 // Do not edit this file! It was generated by Melati POEM's DSD preprocessor.
2
3 package org.melati.poem.generated;
4
5
6 import org.melati.poem.AccessPoemException;
7 import org.melati.poem.Column;
8 import org.melati.poem.ColumnInfo;
9 import org.melati.poem.ColumnInfoTable;
10 import org.melati.poem.DisplayLevel;
11 import org.melati.poem.Field;
12 import org.melati.poem.NoSuchRowPoemException;
13 import org.melati.poem.PoemDatabaseTables;
14 import org.melati.poem.Searchability;
15 import org.melati.poem.StandardIntegrityFix;
16 import org.melati.poem.TableInfo;
17 import org.melati.poem.ValidationPoemException;
18 import org.melati.poem.ValueInfo;
19
20
21 /**
22 * Melati POEM generated abstract base class for a <code>Persistent</code>
23 * <code>columnInfo</code> Object.
24 *
25 * See org.melati.poem.prepro.TableDef#generatePersistentBaseJava
26 */
27 public abstract class ColumnInfoBase extends ValueInfo {
28
29
30 /**
31 * Retrieves the Database object.
32 *
33 * See org.melati.poem.prepro.TableDef#generatePersistentBaseJava
34 * @return the database
35 */
36 public PoemDatabaseTables getPoemDatabaseTables() {
37 return (PoemDatabaseTables)getDatabase();
38 }
39
40
41 /**
42 * Retrieves the <code>ColumnInfoTable</code> table
43 * which this <code>Persistent</code> is from.
44 *
45 * See org.melati.poem.prepro.TableDef#generatePersistentBaseJava
46 * @return the ColumnInfoTable
47 */
48 @SuppressWarnings("unchecked")
49 public ColumnInfoTable<ColumnInfo> getColumnInfoTable() {
50 return (ColumnInfoTable<ColumnInfo>)getTable();
51 }
52
53 @SuppressWarnings("unchecked")
54 private ColumnInfoTable<ColumnInfo> _getColumnInfoTable() {
55 return (ColumnInfoTable<ColumnInfo>)getTable();
56 }
57
58 // Fields in this table
59 /**
60 * id
61 */
62 protected Integer id;
63 /**
64 * Owning table - The table to which the field belongs
65 */
66 protected Integer tableinfo;
67 /**
68 * name - A code-name for the field
69 */
70 protected String name;
71 /**
72 * Display order - A rank determining where the field appears in lists
73 */
74 protected Integer displayorder;
75 /**
76 * User-createable - Whether it makes sense for the user to initialise the
77 * field's value
78 */
79 protected Boolean usercreateable;
80 /**
81 * Display level - A category determining what granularity of report the
82 * field appears in
83 */
84 protected Integer displaylevel;
85 /**
86 * searchability - A category determining what level of searching this field
87 * supports
88 */
89 protected Integer searchability;
90 /**
91 * Display order priority - If present, the level at which lists of records
92 * are sorted by the field
93 */
94 protected Integer displayorderpriority;
95 /**
96 * Sort Descending - Whether when sorting by this column, the sort order
97 * should be reversed
98 */
99 protected Boolean sortdescending;
100 /**
101 * indexed - Whether the field is indexed (ignored if the field is marked
102 * `unique')
103 */
104 protected Boolean indexed;
105 /**
106 * unique - Whether the field is unique (implies that it's `indexed')
107 */
108 protected Boolean unique;
109 /**
110 * Integrity fix - How referential integrity is maintained, what to do when
111 * the object referred to is deleted
112 */
113 protected Integer integrityfix;
114
115
116 /**
117 * Retrieves the <code>Id</code> value, without locking,
118 * for this <code>columnInfo</code> <code>Persistent</code>.
119 *
120 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
121 * @return the Integer id
122 */
123 public Integer getId_unsafe() {
124 return id;
125 }
126
127
128 /**
129 * Sets the <code>Id</code> value directly, without checking,
130 * for this columnInfo <code>Persistent</code>.
131 *
132 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
133 * @param cooked the pre-validated value to set
134 */
135 public void setId_unsafe(Integer cooked) {
136 id = cooked;
137 }
138
139 /**
140 * Retrieves the Id value, with locking, for this
141 * <code>columnInfo</code> <code>Persistent</code>.
142 *
143 * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods
144 * @throws AccessPoemException
145 * if the current <code>AccessToken</code>
146 * does not confer write access rights
147 * @return the value of the field <code>Id</code> for this
148 * <code>columnInfo</code> <code>Persistent</code>
149 */
150
151 public Integer getId()
152 throws AccessPoemException {
153 readLock();
154 return getId_unsafe();
155 }
156
157
158 /**
159 * Sets the <code>Id</code> value, with checking, for this
160 * <code>columnInfo</code> <code>Persistent</code>.
161 *
162 * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods
163 * @param cooked a validated <code>int</code>
164 * @throws AccessPoemException
165 * if the current <code>AccessToken</code>
166 * does not confer write access rights
167 * @throws ValidationPoemException
168 * if the value is not valid
169 */
170 public void setId(Integer cooked)
171 throws AccessPoemException, ValidationPoemException {
172 _getColumnInfoTable().getIdColumn().
173 getType().assertValidCooked(cooked);
174 writeLock();
175 setId_unsafe(cooked);
176 }
177
178 /**
179 * Sets the <code>Id</code> value, with checking, for this
180 * <code>columnInfo</code> <code>Persistent</code>.
181 *
182 * Generated by org.melati.poem.prepro.IntegerFieldDef#generateBaseMethods
183 * @param cooked a validated <code>int</code>
184 * @throws AccessPoemException
185 * if the current <code>AccessToken</code>
186 * does not confer write access rights
187 * @throws ValidationPoemException
188 * if the value is not valid
189 */
190
191 public final void setId(int cooked)
192 throws AccessPoemException, ValidationPoemException {
193 setId(new Integer(cooked));
194 }
195
196
197 /**
198 * Retrieves the <code>Id</code> value as a <code>Field</code>
199 * from this <code>columnInfo</code> <code>Persistent</code>.
200 *
201 * see org.melati.poem.prepro.FieldDef#generateFieldCreator
202 * @throws AccessPoemException
203 * if the current <code>AccessToken</code>
204 * does not confer write access rights
205 * @return the Integer id
206 */
207 public Field<Integer> getIdField() throws AccessPoemException {
208 Column<Integer> c = _getColumnInfoTable().getIdColumn();
209 return new Field<Integer>((Integer)c.getRaw(this), c);
210 }
211
212
213 /**
214 * Retrieves the <code>Tableinfo</code> value, without locking,
215 * for this <code>columnInfo</code> <code>Persistent</code>.
216 *
217 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
218 * @return the Integer tableinfo
219 */
220 public Integer getTableinfo_unsafe() {
221 return tableinfo;
222 }
223
224
225 /**
226 * Sets the <code>Tableinfo</code> value directly, without checking,
227 * for this columnInfo <code>Persistent</code>.
228 *
229 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
230 * @param cooked the pre-validated value to set
231 */
232 public void setTableinfo_unsafe(Integer cooked) {
233 tableinfo = cooked;
234 }
235
236 /**
237 * Retrieves the Table Row Object ID.
238 *
239 * Generated by org.melati.poem.prepro.ReferenceFieldDef#generateBaseMethods
240 * @throws AccessPoemException
241 * if the current <code>AccessToken</code>
242 * does not confer read access rights
243 * @return the TROID as an <code>Integer</code>
244 */
245
246 public Integer getTableinfoTroid()
247 throws AccessPoemException {
248 readLock();
249 return getTableinfo_unsafe();
250 }
251
252
253 /**
254 * Sets the Table Row Object ID.
255 *
256 * Generated by org.melati.poem.prepro.ReferenceFieldDef#generateBaseMethods
257 * @param raw a Table Row Object Id
258 * @throws AccessPoemException
259 * if the current <code>AccessToken</code>
260 * does not confer write access rights
261 */
262 public void setTableinfoTroid(Integer raw)
263 throws AccessPoemException {
264 setTableinfo(raw == null ? null :
265 getPoemDatabaseTables().getTableInfoTable().getTableInfoObject(raw));
266 }
267
268
269 /**
270 * Retrieves the <code>Tableinfo</code> object referred to.
271 *
272 * Generated by org.melati.poem.prepro.ReferenceFieldDef#generateBaseMethods
273 * @throws AccessPoemException
274 * if the current <code>AccessToken</code>
275 * does not confer read access rights
276 * @throws NoSuchRowPoemException
277 * if the <code>Persistent</code> has yet to be allocated a TROID
278 * @return the <code>Tableinfo</code> as a <code>TableInfo</code>
279 */
280 public TableInfo getTableinfo()
281 throws AccessPoemException, NoSuchRowPoemException {
282 Integer troid = getTableinfoTroid();
283 return troid == null ? null :
284 getPoemDatabaseTables().getTableInfoTable().getTableInfoObject(troid);
285 }
286
287
288 /**
289 * Set the Tableinfo.
290 *
291 * Generated by org.melati.poem.prepro.ReferenceFieldDef#generateBaseMethods
292 * @param cooked a validated <code>TableInfo</code>
293 * @throws AccessPoemException
294 * if the current <code>AccessToken</code>
295 * does not confer write access rights
296 */
297 public void setTableinfo(TableInfo cooked)
298 throws AccessPoemException {
299 _getColumnInfoTable().
300 getTableinfoColumn().
301 getType().assertValidCooked(cooked);
302 writeLock();
303 if (cooked == null)
304 setTableinfo_unsafe(null);
305 else {
306 cooked.existenceLock();
307 setTableinfo_unsafe(cooked.troid());
308 }
309 }
310
311
312 /**
313 * Retrieves the <code>Tableinfo</code> value as a <code>Field</code>
314 * from this <code>columnInfo</code> <code>Persistent</code>.
315 *
316 * see org.melati.poem.prepro.FieldDef#generateFieldCreator
317 * @throws AccessPoemException
318 * if the current <code>AccessToken</code>
319 * does not confer write access rights
320 * @return the Integer tableinfo
321 */
322 public Field<Integer> getTableinfoField() throws AccessPoemException {
323 Column<Integer> c = _getColumnInfoTable().getTableinfoColumn();
324 return new Field<Integer>((Integer)c.getRaw(this), c);
325 }
326
327
328 /**
329 * Retrieves the <code>Name</code> value, without locking,
330 * for this <code>columnInfo</code> <code>Persistent</code>.
331 *
332 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
333 * @return the String name
334 */
335 public String getName_unsafe() {
336 return name;
337 }
338
339
340 /**
341 * Sets the <code>Name</code> value directly, without checking,
342 * for this columnInfo <code>Persistent</code>.
343 *
344 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
345 * @param cooked the pre-validated value to set
346 */
347 public void setName_unsafe(String cooked) {
348 name = cooked;
349 }
350
351 /**
352 * Retrieves the Name value, with locking, for this
353 * <code>columnInfo</code> <code>Persistent</code>.
354 * Field description:
355 * A code-name for the field
356 *
357 * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods
358 * @throws AccessPoemException
359 * if the current <code>AccessToken</code>
360 * does not confer write access rights
361 * @return the value of the field <code>Name</code> for this
362 * <code>columnInfo</code> <code>Persistent</code>
363 */
364
365 public String getName()
366 throws AccessPoemException {
367 readLock();
368 return getName_unsafe();
369 }
370
371
372 /**
373 * Sets the <code>Name</code> value, with checking, for this
374 * <code>columnInfo</code> <code>Persistent</code>.
375 * Field description:
376 * A code-name for the field
377 *
378 * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods
379 * @param cooked a validated <code>int</code>
380 * @throws AccessPoemException
381 * if the current <code>AccessToken</code>
382 * does not confer write access rights
383 * @throws ValidationPoemException
384 * if the value is not valid
385 */
386 public void setName(String cooked)
387 throws AccessPoemException, ValidationPoemException {
388 _getColumnInfoTable().getNameColumn().
389 getType().assertValidCooked(cooked);
390 writeLock();
391 setName_unsafe(cooked);
392 }
393
394
395 /**
396 * Retrieves the <code>Name</code> value as a <code>Field</code>
397 * from this <code>columnInfo</code> <code>Persistent</code>.
398 *
399 * see org.melati.poem.prepro.FieldDef#generateFieldCreator
400 * @throws AccessPoemException
401 * if the current <code>AccessToken</code>
402 * does not confer write access rights
403 * @return the String name
404 */
405 public Field<String> getNameField() throws AccessPoemException {
406 Column<String> c = _getColumnInfoTable().getNameColumn();
407 return new Field<String>((String)c.getRaw(this), c);
408 }
409
410
411 /**
412 * Retrieves the <code>Displayorder</code> value, without locking,
413 * for this <code>columnInfo</code> <code>Persistent</code>.
414 *
415 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
416 * @return the Integer displayorder
417 */
418 public Integer getDisplayorder_unsafe() {
419 return displayorder;
420 }
421
422
423 /**
424 * Sets the <code>Displayorder</code> value directly, without checking,
425 * for this columnInfo <code>Persistent</code>.
426 *
427 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
428 * @param cooked the pre-validated value to set
429 */
430 public void setDisplayorder_unsafe(Integer cooked) {
431 displayorder = cooked;
432 }
433
434 /**
435 * Retrieves the Displayorder value, with locking, for this
436 * <code>columnInfo</code> <code>Persistent</code>.
437 * Field description:
438 * A rank determining where the field appears in lists
439 *
440 * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods
441 * @throws AccessPoemException
442 * if the current <code>AccessToken</code>
443 * does not confer write access rights
444 * @return the value of the field <code>Displayorder</code> for this
445 * <code>columnInfo</code> <code>Persistent</code>
446 */
447
448 public Integer getDisplayorder()
449 throws AccessPoemException {
450 readLock();
451 return getDisplayorder_unsafe();
452 }
453
454
455 /**
456 * Sets the <code>Displayorder</code> value, with checking, for this
457 * <code>columnInfo</code> <code>Persistent</code>.
458 * Field description:
459 * A rank determining where the field appears in lists
460 *
461 * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods
462 * @param cooked a validated <code>int</code>
463 * @throws AccessPoemException
464 * if the current <code>AccessToken</code>
465 * does not confer write access rights
466 * @throws ValidationPoemException
467 * if the value is not valid
468 */
469 public void setDisplayorder(Integer cooked)
470 throws AccessPoemException, ValidationPoemException {
471 _getColumnInfoTable().getDisplayorderColumn().
472 getType().assertValidCooked(cooked);
473 writeLock();
474 setDisplayorder_unsafe(cooked);
475 }
476
477 /**
478 * Sets the <code>Displayorder</code> value, with checking, for this
479 * <code>columnInfo</code> <code>Persistent</code>.
480 * Field description:
481 * A rank determining where the field appears in lists
482 *
483 *
484 * Generated by org.melati.poem.prepro.IntegerFieldDef#generateBaseMethods
485 * @param cooked a validated <code>int</code>
486 * @throws AccessPoemException
487 * if the current <code>AccessToken</code>
488 * does not confer write access rights
489 * @throws ValidationPoemException
490 * if the value is not valid
491 */
492
493 public final void setDisplayorder(int cooked)
494 throws AccessPoemException, ValidationPoemException {
495 setDisplayorder(new Integer(cooked));
496 }
497
498
499 /**
500 * Retrieves the <code>Displayorder</code> value as a <code>Field</code>
501 * from this <code>columnInfo</code> <code>Persistent</code>.
502 *
503 * see org.melati.poem.prepro.FieldDef#generateFieldCreator
504 * @throws AccessPoemException
505 * if the current <code>AccessToken</code>
506 * does not confer write access rights
507 * @return the Integer displayorder
508 */
509 public Field<Integer> getDisplayorderField() throws AccessPoemException {
510 Column<Integer> c = _getColumnInfoTable().getDisplayorderColumn();
511 return new Field<Integer>((Integer)c.getRaw(this), c);
512 }
513
514
515 /**
516 * Retrieves the <code>Usercreateable</code> value, without locking,
517 * for this <code>columnInfo</code> <code>Persistent</code>.
518 *
519 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
520 * @return the Boolean usercreateable
521 */
522 public Boolean getUsercreateable_unsafe() {
523 return usercreateable;
524 }
525
526
527 /**
528 * Sets the <code>Usercreateable</code> value directly, without checking,
529 * for this columnInfo <code>Persistent</code>.
530 *
531 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
532 * @param cooked the pre-validated value to set
533 */
534 public void setUsercreateable_unsafe(Boolean cooked) {
535 usercreateable = cooked;
536 }
537
538 /**
539 * Retrieves the Usercreateable value, with locking, for this
540 * <code>columnInfo</code> <code>Persistent</code>.
541 * Field description:
542 * Whether it makes sense for the user to initialise the field's value
543 *
544 * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods
545 * @throws AccessPoemException
546 * if the current <code>AccessToken</code>
547 * does not confer write access rights
548 * @return the value of the field <code>Usercreateable</code> for this
549 * <code>columnInfo</code> <code>Persistent</code>
550 */
551
552 public Boolean getUsercreateable()
553 throws AccessPoemException {
554 readLock();
555 return getUsercreateable_unsafe();
556 }
557
558
559 /**
560 * Sets the <code>Usercreateable</code> value, with checking, for this
561 * <code>columnInfo</code> <code>Persistent</code>.
562 * Field description:
563 * Whether it makes sense for the user to initialise the field's value
564 *
565 * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods
566 * @param cooked a validated <code>int</code>
567 * @throws AccessPoemException
568 * if the current <code>AccessToken</code>
569 * does not confer write access rights
570 * @throws ValidationPoemException
571 * if the value is not valid
572 */
573 public void setUsercreateable(Boolean cooked)
574 throws AccessPoemException, ValidationPoemException {
575 _getColumnInfoTable().getUsercreateableColumn().
576 getType().assertValidCooked(cooked);
577 writeLock();
578 setUsercreateable_unsafe(cooked);
579 }
580
581 /**
582 * Sets the <code>Usercreateable</code> value, with checking,
583 * from a <code>boolean</code>, for this
584 * <code>columnInfo</code> <code>Persistent</code>.
585 * Field description:
586 * Whether it makes sense for the user to initialise the field's value
587 *
588 *
589 * Generated by org.melati.poem.prepro.BooleanFieldDef#generateBaseMethods
590 * @param cooked a <code>boolean</code>
591 * @throws AccessPoemException
592 * if the current <code>AccessToken</code>
593 * does not confer write access rights
594 * @throws ValidationPoemException
595 * if the value is not valid
596 */
597
598 public final void setUsercreateable(boolean cooked)
599 throws AccessPoemException, ValidationPoemException {
600 setUsercreateable(cooked ? Boolean.TRUE : Boolean.FALSE);
601 }
602
603
604 /**
605 * Retrieves the <code>Usercreateable</code> value as a <code>Field</code>
606 * from this <code>columnInfo</code> <code>Persistent</code>.
607 *
608 * see org.melati.poem.prepro.FieldDef#generateFieldCreator
609 * @throws AccessPoemException
610 * if the current <code>AccessToken</code>
611 * does not confer write access rights
612 * @return the Boolean usercreateable
613 */
614 public Field<Boolean> getUsercreateableField() throws AccessPoemException {
615 Column<Boolean> c = _getColumnInfoTable().getUsercreateableColumn();
616 return new Field<Boolean>((Boolean)c.getRaw(this), c);
617 }
618
619
620 /**
621 * Retrieves the <code>Displaylevel</code> value, without locking,
622 * for this <code>columnInfo</code> <code>Persistent</code>.
623 *
624 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
625 * @return the Integer displaylevel
626 */
627 public Integer getDisplaylevel_unsafe() {
628 return displaylevel;
629 }
630
631
632 /**
633 * Sets the <code>Displaylevel</code> value directly, without checking,
634 * for this columnInfo <code>Persistent</code>.
635 *
636 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
637 * @param cooked the pre-validated value to set
638 */
639 public void setDisplaylevel_unsafe(Integer cooked) {
640 displaylevel = cooked;
641 }
642
643 /**
644 * Retrieves the Displaylevel index value
645 * of this <code>Persistent</code>.
646 *
647 * Field description:
648 * A category determining what granularity of report the field appears in
649 *
650 * Generated by org.melati.poem.prepro.DisplayLevelFieldDef#generateBaseMethods
651 * @throws AccessPoemException
652 * if the current <code>AccessToken</code>
653 * does not confer read access rights
654 * @return the Integer displaylevel
655 */
656
657 public Integer getDisplaylevelIndex()
658 throws AccessPoemException {
659 readLock();
660 return getDisplaylevel_unsafe();
661 }
662
663
664 /**
665 * Sets the <code>Displaylevel</code> index value, with checking,
666 * for this <code>Persistent</code>.
667 * Field description:
668 * A category determining what granularity of report the field appears in
669 *
670 *
671 * Generated by org.melati.poem.prepro.DisplayLevelFieldDef#generateBaseMethods
672 * @param raw the value to set
673 * @throws AccessPoemException
674 * if the current <code>AccessToken</code>
675 * does not confer write access rights
676 */
677 public void setDisplaylevelIndex(Integer raw)
678 throws AccessPoemException {
679 getColumnInfoTable().getDisplaylevelColumn().getType().assertValidRaw(raw);
680 writeLock();
681 setDisplaylevel_unsafe(raw);
682 }
683
684
685 /**
686 * Retrieves the Displaylevel value
687 * of this <code>Persistent</code>.
688 * Field description:
689 * A category determining what granularity of report the field appears in
690 *
691 *
692 * Generated by org.melati.poem.prepro.DisplayLevelFieldDef#generateBaseMethods
693 * @throws AccessPoemException
694 * if the current <code>AccessToken</code>
695 * does not confer read access rights
696 * @return the DisplayLevel
697 */
698 public DisplayLevel getDisplaylevel()
699 throws AccessPoemException {
700 Integer index = getDisplaylevelIndex();
701 return index == null ? null :
702 DisplayLevel.forIndex(index.intValue());
703 }
704
705
706 /**
707 * Sets the <code>Displaylevel</code> value, with checking, for the <code>Persistent</code> argument.
708 * Field description:
709 * A category determining what granularity of report the field appears in
710 *
711 *
712 * Generated by org.melati.poem.prepro.DisplayLevelFieldDef#generateBaseMethods
713 * @param cooked the value to set
714 * @throws AccessPoemException
715 * if the current <code>AccessToken</code>
716 * does not confer write access rights
717 */
718 public void setDisplaylevel(DisplayLevel cooked)
719 throws AccessPoemException {
720 setDisplaylevelIndex(cooked == null ? null : cooked.index);
721 }
722
723
724 /**
725 * Retrieves the <code>Displaylevel</code> value as a <code>Field</code>
726 * from this <code>columnInfo</code> <code>Persistent</code>.
727 *
728 * see org.melati.poem.prepro.FieldDef#generateFieldCreator
729 * @throws AccessPoemException
730 * if the current <code>AccessToken</code>
731 * does not confer write access rights
732 * @return the Integer displaylevel
733 */
734 public Field<Integer> getDisplaylevelField() throws AccessPoemException {
735 Column<Integer> c = _getColumnInfoTable().getDisplaylevelColumn();
736 return new Field<Integer>((Integer)c.getRaw(this), c);
737 }
738
739
740 /**
741 * Retrieves the <code>Searchability</code> value, without locking,
742 * for this <code>columnInfo</code> <code>Persistent</code>.
743 *
744 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
745 * @return the Integer searchability
746 */
747 public Integer getSearchability_unsafe() {
748 return searchability;
749 }
750
751
752 /**
753 * Sets the <code>Searchability</code> value directly, without checking,
754 * for this columnInfo <code>Persistent</code>.
755 *
756 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
757 * @param cooked the pre-validated value to set
758 */
759 public void setSearchability_unsafe(Integer cooked) {
760 searchability = cooked;
761 }
762
763 /**
764 * Retrieves the Searchability index value
765 * of this <code>Persistent</code>.
766 * Field description:
767 * A category determining what level of searching this field supports
768 *
769 *
770 * Generated by org.melati.poem.prepro.SearchabiltyFieldDef#generateBaseMethods
771 * @throws AccessPoemException
772 * if the current <code>AccessToken</code>
773 * does not confer read access rights
774 * @return the Integer searchability
775 */
776
777 public Integer getSearchabilityIndex()
778 throws AccessPoemException {
779 readLock();
780 return getSearchability_unsafe();
781 }
782
783
784 /**
785 * Sets the <code>Searchability</code> index value, with checking, for this <code>Persistent</code>.
786 * Field description:
787 * A category determining what level of searching this field supports
788 *
789 *
790 * Generated by org.melati.poem.prepro.SearchabiltyFieldDef#generateBaseMethods
791 * @param raw the value to set
792 * @throws AccessPoemException
793 * if the current <code>AccessToken</code>
794 * does not confer write access rights
795 */
796 public void setSearchabilityIndex(Integer raw)
797 throws AccessPoemException {
798 getColumnInfoTable().getSearchabilityColumn().getType().assertValidRaw(raw);
799 writeLock();
800 setSearchability_unsafe(raw);
801 }
802
803
804 /**
805 * Retrieves the Searchability value
806 * of this <code>Persistent</code>.
807 * Field description:
808 * A category determining what level of searching this field supports
809 *
810 *
811 * Generated by org.melati.poem.prepro.SearchabiltyFieldDef#generateBaseMethods
812 * @throws AccessPoemException
813 * if the current <code>AccessToken</code>
814 * does not confer read access rights
815 * @return the Searchability
816 */
817 public Searchability getSearchability()
818 throws AccessPoemException {
819 Integer index = getSearchabilityIndex();
820 return index == null ? null :
821 Searchability.forIndex(index.intValue());
822 }
823
824
825 /**
826 * Sets the <code>Searchability</code> value, with checking, for the <code>Persistent</code> argument.
827 * Field description:
828 * A category determining what level of searching this field supports
829 *
830 *
831 * Generated by org.melati.poem.prepro.SearchabiltyFieldDef#generateBaseMethods
832 * @param cooked the value to set
833 * @throws AccessPoemException
834 * if the current <code>AccessToken</code>
835 * does not confer write access rights
836 */
837 public void setSearchability(Searchability cooked)
838 throws AccessPoemException {
839 setSearchabilityIndex(cooked == null ? null : cooked.index);
840 }
841
842
843 /**
844 * Retrieves the <code>Searchability</code> value as a <code>Field</code>
845 * from this <code>columnInfo</code> <code>Persistent</code>.
846 *
847 * see org.melati.poem.prepro.FieldDef#generateFieldCreator
848 * @throws AccessPoemException
849 * if the current <code>AccessToken</code>
850 * does not confer write access rights
851 * @return the Integer searchability
852 */
853 public Field<Integer> getSearchabilityField() throws AccessPoemException {
854 Column<Integer> c = _getColumnInfoTable().getSearchabilityColumn();
855 return new Field<Integer>((Integer)c.getRaw(this), c);
856 }
857
858
859 /**
860 * Retrieves the <code>Displayorderpriority</code> value, without locking,
861 * for this <code>columnInfo</code> <code>Persistent</code>.
862 *
863 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
864 * @return the Integer displayorderpriority
865 */
866 public Integer getDisplayorderpriority_unsafe() {
867 return displayorderpriority;
868 }
869
870
871 /**
872 * Sets the <code>Displayorderpriority</code> value directly, without checking,
873 * for this columnInfo <code>Persistent</code>.
874 *
875 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
876 * @param cooked the pre-validated value to set
877 */
878 public void setDisplayorderpriority_unsafe(Integer cooked) {
879 displayorderpriority = cooked;
880 }
881
882 /**
883 * Retrieves the Displayorderpriority value, with locking, for this
884 * <code>columnInfo</code> <code>Persistent</code>.
885 * Field description:
886 * If present, the level at which lists of records are sorted by the field
887 *
888 * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods
889 * @throws AccessPoemException
890 * if the current <code>AccessToken</code>
891 * does not confer write access rights
892 * @return the value of the field <code>Displayorderpriority</code> for this
893 * <code>columnInfo</code> <code>Persistent</code>
894 */
895
896 public Integer getDisplayorderpriority()
897 throws AccessPoemException {
898 readLock();
899 return getDisplayorderpriority_unsafe();
900 }
901
902
903 /**
904 * Sets the <code>Displayorderpriority</code> value, with checking, for this
905 * <code>columnInfo</code> <code>Persistent</code>.
906 * Field description:
907 * If present, the level at which lists of records are sorted by the field
908 *
909 * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods
910 * @param cooked a validated <code>int</code>
911 * @throws AccessPoemException
912 * if the current <code>AccessToken</code>
913 * does not confer write access rights
914 * @throws ValidationPoemException
915 * if the value is not valid
916 */
917 public void setDisplayorderpriority(Integer cooked)
918 throws AccessPoemException, ValidationPoemException {
919 _getColumnInfoTable().getDisplayorderpriorityColumn().
920 getType().assertValidCooked(cooked);
921 writeLock();
922 setDisplayorderpriority_unsafe(cooked);
923 }
924
925 /**
926 * Sets the <code>Displayorderpriority</code> value, with checking, for this
927 * <code>columnInfo</code> <code>Persistent</code>.
928 * Field description:
929 * If present, the level at which lists of records are sorted by the field
930 *
931 *
932 * Generated by org.melati.poem.prepro.IntegerFieldDef#generateBaseMethods
933 * @param cooked a validated <code>int</code>
934 * @throws AccessPoemException
935 * if the current <code>AccessToken</code>
936 * does not confer write access rights
937 * @throws ValidationPoemException
938 * if the value is not valid
939 */
940
941 public final void setDisplayorderpriority(int cooked)
942 throws AccessPoemException, ValidationPoemException {
943 setDisplayorderpriority(new Integer(cooked));
944 }
945
946
947 /**
948 * Retrieves the <code>Displayorderpriority</code> value as a <code>Field</code>
949 * from this <code>columnInfo</code> <code>Persistent</code>.
950 *
951 * see org.melati.poem.prepro.FieldDef#generateFieldCreator
952 * @throws AccessPoemException
953 * if the current <code>AccessToken</code>
954 * does not confer write access rights
955 * @return the Integer displayorderpriority
956 */
957 public Field<Integer> getDisplayorderpriorityField() throws AccessPoemException {
958 Column<Integer> c = _getColumnInfoTable().getDisplayorderpriorityColumn();
959 return new Field<Integer>((Integer)c.getRaw(this), c);
960 }
961
962
963 /**
964 * Retrieves the <code>Sortdescending</code> value, without locking,
965 * for this <code>columnInfo</code> <code>Persistent</code>.
966 *
967 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
968 * @return the Boolean sortdescending
969 */
970 public Boolean getSortdescending_unsafe() {
971 return sortdescending;
972 }
973
974
975 /**
976 * Sets the <code>Sortdescending</code> value directly, without checking,
977 * for this columnInfo <code>Persistent</code>.
978 *
979 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
980 * @param cooked the pre-validated value to set
981 */
982 public void setSortdescending_unsafe(Boolean cooked) {
983 sortdescending = cooked;
984 }
985
986 /**
987 * Retrieves the Sortdescending value, with locking, for this
988 * <code>columnInfo</code> <code>Persistent</code>.
989 * Field description:
990 * Whether when sorting by this column, the sort order should be reversed
991 *
992 * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods
993 * @throws AccessPoemException
994 * if the current <code>AccessToken</code>
995 * does not confer write access rights
996 * @return the value of the field <code>Sortdescending</code> for this
997 * <code>columnInfo</code> <code>Persistent</code>
998 */
999
1000 public Boolean getSortdescending()
1001 throws AccessPoemException {
1002 readLock();
1003 return getSortdescending_unsafe();
1004 }
1005
1006
1007 /**
1008 * Sets the <code>Sortdescending</code> value, with checking, for this
1009 * <code>columnInfo</code> <code>Persistent</code>.
1010 * Field description:
1011 * Whether when sorting by this column, the sort order should be reversed
1012 *
1013 * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods
1014 * @param cooked a validated <code>int</code>
1015 * @throws AccessPoemException
1016 * if the current <code>AccessToken</code>
1017 * does not confer write access rights
1018 * @throws ValidationPoemException
1019 * if the value is not valid
1020 */
1021 public void setSortdescending(Boolean cooked)
1022 throws AccessPoemException, ValidationPoemException {
1023 _getColumnInfoTable().getSortdescendingColumn().
1024 getType().assertValidCooked(cooked);
1025 writeLock();
1026 setSortdescending_unsafe(cooked);
1027 }
1028
1029 /**
1030 * Sets the <code>Sortdescending</code> value, with checking,
1031 * from a <code>boolean</code>, for this
1032 * <code>columnInfo</code> <code>Persistent</code>.
1033 * Field description:
1034 * Whether when sorting by this column, the sort order should be reversed
1035 *
1036 *
1037 * Generated by org.melati.poem.prepro.BooleanFieldDef#generateBaseMethods
1038 * @param cooked a <code>boolean</code>
1039 * @throws AccessPoemException
1040 * if the current <code>AccessToken</code>
1041 * does not confer write access rights
1042 * @throws ValidationPoemException
1043 * if the value is not valid
1044 */
1045
1046 public final void setSortdescending(boolean cooked)
1047 throws AccessPoemException, ValidationPoemException {
1048 setSortdescending(cooked ? Boolean.TRUE : Boolean.FALSE);
1049 }
1050
1051
1052 /**
1053 * Retrieves the <code>Sortdescending</code> value as a <code>Field</code>
1054 * from this <code>columnInfo</code> <code>Persistent</code>.
1055 *
1056 * see org.melati.poem.prepro.FieldDef#generateFieldCreator
1057 * @throws AccessPoemException
1058 * if the current <code>AccessToken</code>
1059 * does not confer write access rights
1060 * @return the Boolean sortdescending
1061 */
1062 public Field<Boolean> getSortdescendingField() throws AccessPoemException {
1063 Column<Boolean> c = _getColumnInfoTable().getSortdescendingColumn();
1064 return new Field<Boolean>((Boolean)c.getRaw(this), c);
1065 }
1066
1067
1068 /**
1069 * Retrieves the <code>Indexed</code> value, without locking,
1070 * for this <code>columnInfo</code> <code>Persistent</code>.
1071 *
1072 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
1073 * @return the Boolean indexed
1074 */
1075 public Boolean getIndexed_unsafe() {
1076 return indexed;
1077 }
1078
1079
1080 /**
1081 * Sets the <code>Indexed</code> value directly, without checking,
1082 * for this columnInfo <code>Persistent</code>.
1083 *
1084 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
1085 * @param cooked the pre-validated value to set
1086 */
1087 public void setIndexed_unsafe(Boolean cooked) {
1088 indexed = cooked;
1089 }
1090
1091 /**
1092 * Retrieves the Indexed value, with locking, for this
1093 * <code>columnInfo</code> <code>Persistent</code>.
1094 * Field description:
1095 * Whether the field is indexed (ignored if the field is marked `unique')
1096 *
1097 * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods
1098 * @throws AccessPoemException
1099 * if the current <code>AccessToken</code>
1100 * does not confer write access rights
1101 * @return the value of the field <code>Indexed</code> for this
1102 * <code>columnInfo</code> <code>Persistent</code>
1103 */
1104
1105 public Boolean getIndexed()
1106 throws AccessPoemException {
1107 readLock();
1108 return getIndexed_unsafe();
1109 }
1110
1111
1112 /**
1113 * Sets the <code>Indexed</code> value, with checking, for this
1114 * <code>columnInfo</code> <code>Persistent</code>.
1115 * Field description:
1116 * Whether the field is indexed (ignored if the field is marked `unique')
1117 *
1118 * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods
1119 * @param cooked a validated <code>int</code>
1120 * @throws AccessPoemException
1121 * if the current <code>AccessToken</code>
1122 * does not confer write access rights
1123 * @throws ValidationPoemException
1124 * if the value is not valid
1125 */
1126 public void setIndexed(Boolean cooked)
1127 throws AccessPoemException, ValidationPoemException {
1128 _getColumnInfoTable().getIndexedColumn().
1129 getType().assertValidCooked(cooked);
1130 writeLock();
1131 setIndexed_unsafe(cooked);
1132 }
1133
1134 /**
1135 * Sets the <code>Indexed</code> value, with checking,
1136 * from a <code>boolean</code>, for this
1137 * <code>columnInfo</code> <code>Persistent</code>.
1138 * Field description:
1139 * Whether the field is indexed (ignored if the field is marked `unique')
1140 *
1141 *
1142 * Generated by org.melati.poem.prepro.BooleanFieldDef#generateBaseMethods
1143 * @param cooked a <code>boolean</code>
1144 * @throws AccessPoemException
1145 * if the current <code>AccessToken</code>
1146 * does not confer write access rights
1147 * @throws ValidationPoemException
1148 * if the value is not valid
1149 */
1150
1151 public final void setIndexed(boolean cooked)
1152 throws AccessPoemException, ValidationPoemException {
1153 setIndexed(cooked ? Boolean.TRUE : Boolean.FALSE);
1154 }
1155
1156
1157 /**
1158 * Retrieves the <code>Indexed</code> value as a <code>Field</code>
1159 * from this <code>columnInfo</code> <code>Persistent</code>.
1160 *
1161 * see org.melati.poem.prepro.FieldDef#generateFieldCreator
1162 * @throws AccessPoemException
1163 * if the current <code>AccessToken</code>
1164 * does not confer write access rights
1165 * @return the Boolean indexed
1166 */
1167 public Field<Boolean> getIndexedField() throws AccessPoemException {
1168 Column<Boolean> c = _getColumnInfoTable().getIndexedColumn();
1169 return new Field<Boolean>((Boolean)c.getRaw(this), c);
1170 }
1171
1172
1173 /**
1174 * Retrieves the <code>Unique</code> value, without locking,
1175 * for this <code>columnInfo</code> <code>Persistent</code>.
1176 *
1177 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
1178 * @return the Boolean unique
1179 */
1180 public Boolean getUnique_unsafe() {
1181 return unique;
1182 }
1183
1184
1185 /**
1186 * Sets the <code>Unique</code> value directly, without checking,
1187 * for this columnInfo <code>Persistent</code>.
1188 *
1189 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
1190 * @param cooked the pre-validated value to set
1191 */
1192 public void setUnique_unsafe(Boolean cooked) {
1193 unique = cooked;
1194 }
1195
1196 /**
1197 * Retrieves the Unique value, with locking, for this
1198 * <code>columnInfo</code> <code>Persistent</code>.
1199 * Field description:
1200 * Whether the field is unique (implies that it's `indexed')
1201 *
1202 * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods
1203 * @throws AccessPoemException
1204 * if the current <code>AccessToken</code>
1205 * does not confer write access rights
1206 * @return the value of the field <code>Unique</code> for this
1207 * <code>columnInfo</code> <code>Persistent</code>
1208 */
1209
1210 public Boolean getUnique()
1211 throws AccessPoemException {
1212 readLock();
1213 return getUnique_unsafe();
1214 }
1215
1216
1217 /**
1218 * Sets the <code>Unique</code> value, with checking, for this
1219 * <code>columnInfo</code> <code>Persistent</code>.
1220 * Field description:
1221 * Whether the field is unique (implies that it's `indexed')
1222 *
1223 * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods
1224 * @param cooked a validated <code>int</code>
1225 * @throws AccessPoemException
1226 * if the current <code>AccessToken</code>
1227 * does not confer write access rights
1228 * @throws ValidationPoemException
1229 * if the value is not valid
1230 */
1231 public void setUnique(Boolean cooked)
1232 throws AccessPoemException, ValidationPoemException {
1233 _getColumnInfoTable().getUniqueColumn().
1234 getType().assertValidCooked(cooked);
1235 writeLock();
1236 setUnique_unsafe(cooked);
1237 }
1238
1239 /**
1240 * Sets the <code>Unique</code> value, with checking,
1241 * from a <code>boolean</code>, for this
1242 * <code>columnInfo</code> <code>Persistent</code>.
1243 * Field description:
1244 * Whether the field is unique (implies that it's `indexed')
1245 *
1246 *
1247 * Generated by org.melati.poem.prepro.BooleanFieldDef#generateBaseMethods
1248 * @param cooked a <code>boolean</code>
1249 * @throws AccessPoemException
1250 * if the current <code>AccessToken</code>
1251 * does not confer write access rights
1252 * @throws ValidationPoemException
1253 * if the value is not valid
1254 */
1255
1256 public final void setUnique(boolean cooked)
1257 throws AccessPoemException, ValidationPoemException {
1258 setUnique(cooked ? Boolean.TRUE : Boolean.FALSE);
1259 }
1260
1261
1262 /**
1263 * Retrieves the <code>Unique</code> value as a <code>Field</code>
1264 * from this <code>columnInfo</code> <code>Persistent</code>.
1265 *
1266 * see org.melati.poem.prepro.FieldDef#generateFieldCreator
1267 * @throws AccessPoemException
1268 * if the current <code>AccessToken</code>
1269 * does not confer write access rights
1270 * @return the Boolean unique
1271 */
1272 public Field<Boolean> getUniqueField() throws AccessPoemException {
1273 Column<Boolean> c = _getColumnInfoTable().getUniqueColumn();
1274 return new Field<Boolean>((Boolean)c.getRaw(this), c);
1275 }
1276
1277
1278 /**
1279 * Retrieves the <code>Integrityfix</code> value, without locking,
1280 * for this <code>columnInfo</code> <code>Persistent</code>.
1281 *
1282 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
1283 * @return the Integer integrityfix
1284 */
1285 public Integer getIntegrityfix_unsafe() {
1286 return integrityfix;
1287 }
1288
1289
1290 /**
1291 * Sets the <code>Integrityfix</code> value directly, without checking,
1292 * for this columnInfo <code>Persistent</code>.
1293 *
1294 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
1295 * @param cooked the pre-validated value to set
1296 */
1297 public void setIntegrityfix_unsafe(Integer cooked) {
1298 integrityfix = cooked;
1299 }
1300
1301 /**
1302 * Retrieves the Integrityfix index value
1303 * of this <code>Persistent</code>.
1304 * Field description:
1305 * How referential integrity is maintained, what to do when the object
1306 * referred to is deleted
1307 *
1308 *
1309 * Generated by org.melati.poem.prepro.IntegrityFixFieldDef#generateBaseMethods
1310 * @throws AccessPoemException
1311 * if the current <code>AccessToken</code>
1312 * does not confer read access rights
1313 * @return the Integer integrityfix
1314 */
1315
1316 public Integer getIntegrityfixIndex()
1317 throws AccessPoemException {
1318 readLock();
1319 return getIntegrityfix_unsafe();
1320 }
1321
1322
1323 /**
1324 * Sets the <code>Integrityfix</code> index value, with checking,
1325 for this <code>Persistent</code>.
1326 * Field description:
1327 * How referential integrity is maintained, what to do when the object
1328 * referred to is deleted
1329 *
1330 *
1331 * Generated by org.melati.poem.prepro.IntegrityFixFieldDef#generateBaseMethods
1332 * @param raw the value to set
1333 * @throws AccessPoemException
1334 * if the current <code>AccessToken</code>
1335 * does not confer write access rights
1336 */
1337 public void setIntegrityfixIndex(Integer raw)
1338 throws AccessPoemException {
1339 getColumnInfoTable().getIntegrityfixColumn().getType().assertValidRaw(raw);
1340 writeLock();
1341 setIntegrityfix_unsafe(raw);
1342 }
1343
1344
1345 /**
1346 * Retrieves the Integrityfix value
1347 * of this <code>Persistent</code>.
1348 * Field description:
1349 * How referential integrity is maintained, what to do when the object
1350 * referred to is deleted
1351 *
1352 * Generated by org.melati.poem.prepro.IntegrityFixFieldDef#generateBaseMethods
1353 * @throws AccessPoemException
1354 * if the current <code>AccessToken</code>
1355 * does not confer read access rights
1356 * @return the StandardIntegrityFix
1357 */
1358 public StandardIntegrityFix getIntegrityfix()
1359 throws AccessPoemException {
1360 Integer index = getIntegrityfixIndex();
1361 return index == null ? null :
1362 StandardIntegrityFix.forIndex(index.intValue());
1363 }
1364
1365
1366 /**
1367 * Sets the <code>Integrityfix</code> value, with checking,
1368 for the <code>Persistent</code> argument.
1369 * Field description:
1370 * How referential integrity is maintained, what to do when the object
1371 * referred to is deleted
1372 *
1373 *
1374 * Generated by org.melati.poem.prepro.IntegrityFixFieldDef#generateBaseMethods
1375 * @param cooked the value to set
1376 * @throws AccessPoemException
1377 * if the current <code>AccessToken</code>
1378 * does not confer write access rights
1379 */
1380 public void setIntegrityfix(StandardIntegrityFix cooked)
1381 throws AccessPoemException {
1382 setIntegrityfixIndex(cooked == null ? null : cooked.getIndex());
1383 }
1384
1385
1386 /**
1387 * Retrieves the <code>Integrityfix</code> value as a <code>Field</code>
1388 * from this <code>columnInfo</code> <code>Persistent</code>.
1389 *
1390 * see org.melati.poem.prepro.FieldDef#generateFieldCreator
1391 * @throws AccessPoemException
1392 * if the current <code>AccessToken</code>
1393 * does not confer write access rights
1394 * @return the Integer integrityfix
1395 */
1396 public Field<Integer> getIntegrityfixField() throws AccessPoemException {
1397 Column<Integer> c = _getColumnInfoTable().getIntegrityfixColumn();
1398 return new Field<Integer>((Integer)c.getRaw(this), c);
1399 }
1400
1401 }
1402