// Do not edit this file!  It was generated by Melati POEM's DSD preprocessor.

 package org.paneris.bibliomania.generated;

 import java.sql.Timestamp;

 import java.util.Collections;

 import java.util.Enumeration;

 import java.util.List;

 import org.melati.poem.AccessPoemException;

 import org.melati.poem.CachedSelection;

 import org.melati.poem.Column;

 import org.melati.poem.Field;

 import org.melati.poem.JdbcPersistent;

 import org.melati.poem.ValidationPoemException;

 import org.melati.poem.util.EmptyEnumeration;

 import org.paneris.bibliomania.BibliomaniaDatabaseTables;

 import org.paneris.bibliomania.Campaign;

 import org.paneris.bibliomania.CampaignTable;

 import org.paneris.bibliomania.CampaignUser;

 /**

  * Melati POEM generated abstract base class for a <code>Persistent</code> 

  * <code>Campaign</code> Object.

  *

  * see org.melati.poem.prepro.TableDef#generatePersistentBaseJava 

  */

 public abstract class CampaignBase extends JdbcPersistent {

  /**

   * Retrieves the Database object.

   * 

   * see org.melati.poem.prepro.TableDef#generatePersistentBaseJava 

   * @return the database

   */

   public BibliomaniaDatabaseTables getBibliomaniaDatabaseTables() {

     return (BibliomaniaDatabaseTables)getDatabase();

   }

  /**

   * Retrieves the  <code>CampaignTable</code> table 

   * which this <code>Persistent</code> is from.

   * 

   * see org.melati.poem.prepro.TableDef#generatePersistentBaseJava 

   * @return the CampaignTable

   */

   @SuppressWarnings("unchecked")

   public CampaignTable<Campaign> getCampaignTable() {

     return (CampaignTable<Campaign>)getTable();

   }

   @SuppressWarnings("unchecked")

   private CampaignTable<Campaign> _getCampaignTable() {

     return (CampaignTable<Campaign>)getTable();

   }

   // Fields in this table 

  /**

   * id 

   */

   protected Integer id;

  /**

   * Display name - The Campaign's name 

   */

   protected String displayname;

  /**

   * Date Created - When this Campaign was created 

   */

   protected Timestamp created;

  /**

   * Date Last Run - When the users in this his Campaign were last emailed 

   */

   protected Timestamp lastrun;

  /**

   * Output - The file containing the output from the last run 

   */

   protected String output;

  /**

   * comment - Any comments on this Campaign 

   */

   protected String comment;

  /**

   * template - A template for the email to be sent 

   */

   protected String template;

  /**

   * Retrieves the <code>Id</code> value, without locking, 

   * for this <code>Campaign</code> <code>Persistent</code>.

   *

   * see org.melati.poem.prepro.FieldDef#generateBaseMethods 

   * @return the Integer id

   */

   public Integer getId_unsafe() {

     return id;

   }

  /**

   * Sets the <code>Id</code> value directly, without checking, 

   * for this Campaign <code>Persistent</code>.

   * 

   * see org.melati.poem.prepro.FieldDef#generateBaseMethods 

   * @param cooked  the pre-validated value to set

   */

   public void setId_unsafe(Integer cooked) {

     id = cooked;

   }

  /**

   * Retrieves the Id value, with locking, for this 

   * <code>Campaign</code> <code>Persistent</code>.

   * 

   * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods 

   * @throws AccessPoemException 

   *         if the current <code>AccessToken</code> 

   *         does not confer write access rights 

   * @return the value of the field <code>Id</code> for this 

   *         <code>Campaign</code> <code>Persistent</code>  

   */

   public Integer getId()

       throws AccessPoemException {

     readLock();

     return getId_unsafe();

   }

  /**

   * Sets the <code>Id</code> value, with checking, for this 

   * <code>Campaign</code> <code>Persistent</code>.

   * 

   * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods  

   * @param cooked  a validated <code>int</code> 

   * @throws AccessPoemException 

   *         if the current <code>AccessToken</code> 

   *         does not confer write access rights

   * @throws ValidationPoemException 

   *         if the value is not valid

   */

   public void setId(Integer cooked)

       throws AccessPoemException, ValidationPoemException {

     _getCampaignTable().getIdColumn().

       getType().assertValidCooked(cooked);

     writeLock();

     setId_unsafe(cooked);

   }

  /**

   * Sets the <code>Id</code> value, with checking, for this 

   * <code>Campaign</code> <code>Persistent</code>.

   * 

   * Generated by org.melati.poem.prepro.IntegerFieldDef#generateBaseMethods 

   * @param cooked  a validated <code>int</code>

   * @throws AccessPoemException 

   *         if the current <code>AccessToken</code> 

   *         does not confer write access rights

   * @throws ValidationPoemException 

   *         if the value is not valid

   */

   public final void setId(int cooked)

       throws AccessPoemException, ValidationPoemException {

     setId(new Integer(cooked));

   }

  /**

   * Retrieves the <code>Id</code> value as a <code>Field</code>

   * from this <code>Campaign</code> <code>Persistent</code>.

   * 

   * see org.melati.poem.prepro.FieldDef#generateFieldCreator 

   * @throws AccessPoemException 

   *         if the current <code>AccessToken</code> 

   *         does not confer write access rights

   * @return the Integer id

   */

   public Field<Integer> getIdField() throws AccessPoemException {

     Column<Integer> c = _getCampaignTable().getIdColumn();

     return new Field<Integer>((Integer)c.getRaw(this), c);

   }

  /**

   * Retrieves the <code>Displayname</code> value, without locking, 

   * for this <code>Campaign</code> <code>Persistent</code>.

   *

   * see org.melati.poem.prepro.FieldDef#generateBaseMethods 

   * @return the String displayname

   */

   public String getDisplayname_unsafe() {

     return displayname;

   }

  /**

   * Sets the <code>Displayname</code> value directly, without checking, 

   * for this Campaign <code>Persistent</code>.

   * 

   * see org.melati.poem.prepro.FieldDef#generateBaseMethods 

   * @param cooked  the pre-validated value to set

   */

   public void setDisplayname_unsafe(String cooked) {

     displayname = cooked;

   }

  /**

   * Retrieves the Displayname value, with locking, for this 

   * <code>Campaign</code> <code>Persistent</code>.

   * Field description: 

   *   The Campaign's name 

   * 

   * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods 

   * @throws AccessPoemException 

   *         if the current <code>AccessToken</code> 

   *         does not confer write access rights 

   * @return the value of the field <code>Displayname</code> for this 

   *         <code>Campaign</code> <code>Persistent</code>  

   */

   public String getDisplayname()

       throws AccessPoemException {

     readLock();

     return getDisplayname_unsafe();

   }

  /**

   * Sets the <code>Displayname</code> value, with checking, for this 

   * <code>Campaign</code> <code>Persistent</code>.

   * Field description: 

   *   The Campaign's name 

   * 

   * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods  

   * @param cooked  a validated <code>int</code> 

   * @throws AccessPoemException 

   *         if the current <code>AccessToken</code> 

   *         does not confer write access rights

   * @throws ValidationPoemException 

   *         if the value is not valid

   */

   public void setDisplayname(String cooked)

       throws AccessPoemException, ValidationPoemException {

     _getCampaignTable().getDisplaynameColumn().

       getType().assertValidCooked(cooked);

     writeLock();

     setDisplayname_unsafe(cooked);

   }

  /**

   * Retrieves the <code>Displayname</code> value as a <code>Field</code>

   * from this <code>Campaign</code> <code>Persistent</code>.

   * 

   * see org.melati.poem.prepro.FieldDef#generateFieldCreator 

   * @throws AccessPoemException 

   *         if the current <code>AccessToken</code> 

   *         does not confer write access rights

   * @return the String displayname

   */

   public Field<String> getDisplaynameField() throws AccessPoemException {

     Column<String> c = _getCampaignTable().getDisplaynameColumn();

     return new Field<String>((String)c.getRaw(this), c);

   }

  /**

   * Retrieves the <code>Created</code> value, without locking, 

   * for this <code>Campaign</code> <code>Persistent</code>.

   *

   * see org.melati.poem.prepro.FieldDef#generateBaseMethods 

   * @return the Timestamp created

   */

   public Timestamp getCreated_unsafe() {

     return created;

   }

  /**

   * Sets the <code>Created</code> value directly, without checking, 

   * for this Campaign <code>Persistent</code>.

   * 

   * see org.melati.poem.prepro.FieldDef#generateBaseMethods 

   * @param cooked  the pre-validated value to set

   */

   public void setCreated_unsafe(Timestamp cooked) {

     created = cooked;

   }

  /**

   * Retrieves the Created value, with locking, for this 

   * <code>Campaign</code> <code>Persistent</code>.

   * Field description: 

   *   When this Campaign was created 

   * 

   * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods 

   * @throws AccessPoemException 

   *         if the current <code>AccessToken</code> 

   *         does not confer write access rights 

   * @return the value of the field <code>Created</code> for this 

   *         <code>Campaign</code> <code>Persistent</code>  

   */

   public Timestamp getCreated()

       throws AccessPoemException {

     readLock();

     return getCreated_unsafe();

   }

  /**

   * Sets the <code>Created</code> value, with checking, for this 

   * <code>Campaign</code> <code>Persistent</code>.

   * Field description: 

   *   When this Campaign was created 

   * 

   * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods  

   * @param cooked  a validated <code>int</code> 

   * @throws AccessPoemException 

   *         if the current <code>AccessToken</code> 

   *         does not confer write access rights

   * @throws ValidationPoemException 

   *         if the value is not valid

   */

   public void setCreated(Timestamp cooked)

       throws AccessPoemException, ValidationPoemException {

     _getCampaignTable().getCreatedColumn().

       getType().assertValidCooked(cooked);

     writeLock();

     setCreated_unsafe(cooked);

   }

  /**

   * Retrieves the <code>Created</code> value as a <code>Field</code>

   * from this <code>Campaign</code> <code>Persistent</code>.

   * 

   * see org.melati.poem.prepro.FieldDef#generateFieldCreator 

   * @throws AccessPoemException 

   *         if the current <code>AccessToken</code> 

   *         does not confer write access rights

   * @return the Timestamp created

   */

   public Field<Timestamp> getCreatedField() throws AccessPoemException {

     Column<Timestamp> c = _getCampaignTable().getCreatedColumn();

     return new Field<Timestamp>((Timestamp)c.getRaw(this), c);

   }

  /**

   * Retrieves the <code>Lastrun</code> value, without locking, 

   * for this <code>Campaign</code> <code>Persistent</code>.

   *

   * see org.melati.poem.prepro.FieldDef#generateBaseMethods 

   * @return the Timestamp lastrun

   */

   public Timestamp getLastrun_unsafe() {

     return lastrun;

   }

  /**

   * Sets the <code>Lastrun</code> value directly, without checking, 

   * for this Campaign <code>Persistent</code>.

   * 

   * see org.melati.poem.prepro.FieldDef#generateBaseMethods 

   * @param cooked  the pre-validated value to set

   */

   public void setLastrun_unsafe(Timestamp cooked) {

     lastrun = cooked;

   }

  /**

   * Retrieves the Lastrun value, with locking, for this 

   * <code>Campaign</code> <code>Persistent</code>.

   * Field description: 

   *   When the users in this his Campaign were last emailed 

   * 

   * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods 

   * @throws AccessPoemException 

   *         if the current <code>AccessToken</code> 

   *         does not confer write access rights 

   * @return the value of the field <code>Lastrun</code> for this 

   *         <code>Campaign</code> <code>Persistent</code>  

   */

   public Timestamp getLastrun()

       throws AccessPoemException {

     readLock();

     return getLastrun_unsafe();

   }

  /**

   * Sets the <code>Lastrun</code> value, with checking, for this 

   * <code>Campaign</code> <code>Persistent</code>.

   * Field description: 

   *   When the users in this his Campaign were last emailed 

   * 

   * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods  

   * @param cooked  a validated <code>int</code> 

   * @throws AccessPoemException 

   *         if the current <code>AccessToken</code> 

   *         does not confer write access rights

   * @throws ValidationPoemException 

   *         if the value is not valid

   */

   public void setLastrun(Timestamp cooked)

       throws AccessPoemException, ValidationPoemException {

     _getCampaignTable().getLastrunColumn().

       getType().assertValidCooked(cooked);

     writeLock();

     setLastrun_unsafe(cooked);

   }

  /**

   * Retrieves the <code>Lastrun</code> value as a <code>Field</code>

   * from this <code>Campaign</code> <code>Persistent</code>.

   * 

   * see org.melati.poem.prepro.FieldDef#generateFieldCreator 

   * @throws AccessPoemException 

   *         if the current <code>AccessToken</code> 

   *         does not confer write access rights

   * @return the Timestamp lastrun

   */

   public Field<Timestamp> getLastrunField() throws AccessPoemException {

     Column<Timestamp> c = _getCampaignTable().getLastrunColumn();

     return new Field<Timestamp>((Timestamp)c.getRaw(this), c);

   }

  /**

   * Retrieves the <code>Output</code> value, without locking, 

   * for this <code>Campaign</code> <code>Persistent</code>.

   *

   * see org.melati.poem.prepro.FieldDef#generateBaseMethods 

   * @return the String output

   */

   public String getOutput_unsafe() {

     return output;

   }

  /**

   * Sets the <code>Output</code> value directly, without checking, 

   * for this Campaign <code>Persistent</code>.

   * 

   * see org.melati.poem.prepro.FieldDef#generateBaseMethods 

   * @param cooked  the pre-validated value to set

   */

   public void setOutput_unsafe(String cooked) {

     output = cooked;

   }

  /**

   * Retrieves the Output value, with locking, for this 

   * <code>Campaign</code> <code>Persistent</code>.

   * Field description: 

   *   The file containing the output from the last run 

   * 

   * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods 

   * @throws AccessPoemException 

   *         if the current <code>AccessToken</code> 

   *         does not confer write access rights 

   * @return the value of the field <code>Output</code> for this 

   *         <code>Campaign</code> <code>Persistent</code>  

   */

   public String getOutput()

       throws AccessPoemException {

     readLock();

     return getOutput_unsafe();

   }

  /**

   * Sets the <code>Output</code> value, with checking, for this 

   * <code>Campaign</code> <code>Persistent</code>.

   * Field description: 

   *   The file containing the output from the last run 

   * 

   * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods  

   * @param cooked  a validated <code>int</code> 

   * @throws AccessPoemException 

   *         if the current <code>AccessToken</code> 

   *         does not confer write access rights

   * @throws ValidationPoemException 

   *         if the value is not valid

   */

   public void setOutput(String cooked)

       throws AccessPoemException, ValidationPoemException {

     _getCampaignTable().getOutputColumn().

       getType().assertValidCooked(cooked);

     writeLock();

     setOutput_unsafe(cooked);

   }

  /**

   * Retrieves the <code>Output</code> value as a <code>Field</code>

   * from this <code>Campaign</code> <code>Persistent</code>.

   * 

   * see org.melati.poem.prepro.FieldDef#generateFieldCreator 

   * @throws AccessPoemException 

   *         if the current <code>AccessToken</code> 

   *         does not confer write access rights

   * @return the String output

   */

   public Field<String> getOutputField() throws AccessPoemException {

     Column<String> c = _getCampaignTable().getOutputColumn();

     return new Field<String>((String)c.getRaw(this), c);

   }

  /**

   * Retrieves the <code>Comment</code> value, without locking, 

   * for this <code>Campaign</code> <code>Persistent</code>.

   *

   * see org.melati.poem.prepro.FieldDef#generateBaseMethods 

   * @return the String comment

   */

   public String getComment_unsafe() {

     return comment;

   }

  /**

   * Sets the <code>Comment</code> value directly, without checking, 

   * for this Campaign <code>Persistent</code>.

   * 

   * see org.melati.poem.prepro.FieldDef#generateBaseMethods 

   * @param cooked  the pre-validated value to set

   */

   public void setComment_unsafe(String cooked) {

     comment = cooked;

   }

  /**

   * Retrieves the Comment value, with locking, for this 

   * <code>Campaign</code> <code>Persistent</code>.

   * Field description: 

   *   Any comments on this Campaign 

   * 

   * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods 

   * @throws AccessPoemException 

   *         if the current <code>AccessToken</code> 

   *         does not confer write access rights 

   * @return the value of the field <code>Comment</code> for this 

   *         <code>Campaign</code> <code>Persistent</code>  

   */

   public String getComment()

       throws AccessPoemException {

     readLock();

     return getComment_unsafe();

   }

  /**

   * Sets the <code>Comment</code> value, with checking, for this 

   * <code>Campaign</code> <code>Persistent</code>.

   * Field description: 

   *   Any comments on this Campaign 

   * 

   * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods  

   * @param cooked  a validated <code>int</code> 

   * @throws AccessPoemException 

   *         if the current <code>AccessToken</code> 

   *         does not confer write access rights

   * @throws ValidationPoemException 

   *         if the value is not valid

   */

   public void setComment(String cooked)

       throws AccessPoemException, ValidationPoemException {

     _getCampaignTable().getCommentColumn().

       getType().assertValidCooked(cooked);

     writeLock();

     setComment_unsafe(cooked);

   }

  /**

   * Retrieves the <code>Comment</code> value as a <code>Field</code>

   * from this <code>Campaign</code> <code>Persistent</code>.

   * 

   * see org.melati.poem.prepro.FieldDef#generateFieldCreator 

   * @throws AccessPoemException 

   *         if the current <code>AccessToken</code> 

   *         does not confer write access rights

   * @return the String comment

   */

   public Field<String> getCommentField() throws AccessPoemException {

     Column<String> c = _getCampaignTable().getCommentColumn();

     return new Field<String>((String)c.getRaw(this), c);

   }

  /**

   * Retrieves the <code>Template</code> value, without locking, 

   * for this <code>Campaign</code> <code>Persistent</code>.

   *

   * see org.melati.poem.prepro.FieldDef#generateBaseMethods 

   * @return the String template

   */

   public String getTemplate_unsafe() {

     return template;

   }

  /**

   * Sets the <code>Template</code> value directly, without checking, 

   * for this Campaign <code>Persistent</code>.

   * 

   * see org.melati.poem.prepro.FieldDef#generateBaseMethods 

   * @param cooked  the pre-validated value to set

   */

   public void setTemplate_unsafe(String cooked) {

     template = cooked;

   }

  /**

   * Retrieves the Template value, with locking, for this 

   * <code>Campaign</code> <code>Persistent</code>.

   * Field description: 

   *   A template for the email to be sent 

   * 

   * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods 

   * @throws AccessPoemException 

   *         if the current <code>AccessToken</code> 

   *         does not confer write access rights 

   * @return the value of the field <code>Template</code> for this 

   *         <code>Campaign</code> <code>Persistent</code>  

   */

   public String getTemplate()

       throws AccessPoemException {

     readLock();

     return getTemplate_unsafe();

   }

  /**

   * Sets the <code>Template</code> value, with checking, for this 

   * <code>Campaign</code> <code>Persistent</code>.

   * Field description: 

   *   A template for the email to be sent 

   * 

   * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods  

   * @param cooked  a validated <code>int</code> 

   * @throws AccessPoemException 

   *         if the current <code>AccessToken</code> 

   *         does not confer write access rights

   * @throws ValidationPoemException 

   *         if the value is not valid

   */

   public void setTemplate(String cooked)

       throws AccessPoemException, ValidationPoemException {

     _getCampaignTable().getTemplateColumn().

       getType().assertValidCooked(cooked);

     writeLock();

     setTemplate_unsafe(cooked);

   }

  /**

   * Retrieves the <code>Template</code> value as a <code>Field</code>

   * from this <code>Campaign</code> <code>Persistent</code>.

   * 

   * see org.melati.poem.prepro.FieldDef#generateFieldCreator 

   * @throws AccessPoemException 

   *         if the current <code>AccessToken</code> 

   *         does not confer write access rights

   * @return the String template

   */

   public Field<String> getTemplateField() throws AccessPoemException {

     Column<String> c = _getCampaignTable().getTemplateColumn();

     return new Field<String>((String)c.getRaw(this), c);

   }

   private CachedSelection<CampaignUser> campaignCampaignUsers = null;

   /** References to this Campaign in the CampaignUser table via its campaign field.*/

   @SuppressWarnings("unchecked")

   public Enumeration<CampaignUser> getCampaignCampaignUsers() {

     if (getTroid() == null)

       return new EmptyEnumeration<CampaignUser>();

     else {

       if (campaignCampaignUsers == null)

         campaignCampaignUsers =

           getBibliomaniaDatabaseTables().getCampaignUserTable().getCampaignColumn().cachedSelectionWhereEq(getTroid());

       return campaignCampaignUsers.objects();

     }

   }

   /** References to this Campaign in the CampaignUser table via its campaign field, as a List.*/

   public List<CampaignUser> getCampaignCampaignUserList() {

     return Collections.list(getCampaignCampaignUsers());

   }

 }