View Javadoc

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