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

 package org.paneris.bibliomania.generated;

 import java.sql.Timestamp;

 import org.melati.poem.AccessPoemException;

 import org.melati.poem.Column;

 import org.melati.poem.Field;

 import org.melati.poem.JdbcPersistent;

 import org.melati.poem.NoSuchRowPoemException;

 import org.melati.poem.ValidationPoemException;

 import org.paneris.bibliomania.BibliomaniaDatabaseTables;

 import org.paneris.bibliomania.Board;

 import org.paneris.bibliomania.Layout;

 import org.paneris.bibliomania.Unit;

 import org.paneris.bibliomania.UnitTable;

 /**

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

  * <code>Unit</code> Object.

  *

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

  */

 public abstract class UnitBase 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>UnitTable</code> table 

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

   * 

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

   * @return the UnitTable

   */

   @SuppressWarnings("unchecked")

   public UnitTable<Unit> getUnitTable() {

     return (UnitTable<Unit>)getTable();

   }

   @SuppressWarnings("unchecked")

   private UnitTable<Unit> _getUnitTable() {

     return (UnitTable<Unit>)getTable();

   }

   // Fields in this table 

  /**

   * path - The path to this unit in the local filesystem, relative to the 

   * application's workspace 

   */

   protected String path;

  /**

   * deleted - Whether or not to include this Unit 

   */

   protected Boolean deleted;

  /**

   * Last encached - When the unit was encached; cleared when the unit is 

   * updated 

   */

   protected Timestamp lastencached;

  /**

   * layout - The name of the layout for this Unit 

   */

   protected Integer layout;

  /**

   * messageboard - A messageboard on which this unit can be discussed 

   */

   protected Integer messageboard;

  /**

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

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

   *

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

   * @return the String path

   */

   public String getPath_unsafe() {

     return path;

   }

  /**

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

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

   * 

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

   * @param cooked  the pre-validated value to set

   */

   public void setPath_unsafe(String cooked) {

     path = cooked;

   }

  /**

   * Retrieves the Path value, with locking, for this 

   * <code>Unit</code> <code>Persistent</code>.

   * Field description: 

   *   The path to this unit in the local filesystem, relative to the 

   *   application's workspace 

   * 

   * 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>Path</code> for this 

   *         <code>Unit</code> <code>Persistent</code>  

   */

   public String getPath()

       throws AccessPoemException {

     readLock();

     return getPath_unsafe();

   }

  /**

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

   * <code>Unit</code> <code>Persistent</code>.

   * Field description: 

   *   The path to this unit in the local filesystem, relative to the 

   *   application's workspace 

   * 

   * 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 setPath(String cooked)

       throws AccessPoemException, ValidationPoemException {

     _getUnitTable().getPathColumn().

       getType().assertValidCooked(cooked);

     writeLock();

     setPath_unsafe(cooked);

   }

  /**

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

   * from this <code>Unit</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 path

   */

   public Field<String> getPathField() throws AccessPoemException {

     Column<String> c = _getUnitTable().getPathColumn();

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

   }

  /**

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

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

   *

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

   * @return the Boolean deleted

   */

   public Boolean getDeleted_unsafe() {

     return deleted;

   }

  /**

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

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

   * 

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

   * @param cooked  the pre-validated value to set

   */

   public void setDeleted_unsafe(Boolean cooked) {

     deleted = cooked;

   }

  /**

   * Retrieves the Deleted value, with locking, for this 

   * <code>Unit</code> <code>Persistent</code>.

   * Field description: 

   *   Whether or not to include this Unit 

   * 

   * 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>Deleted</code> for this 

   *         <code>Unit</code> <code>Persistent</code>  

   */

   public Boolean getDeleted()

       throws AccessPoemException {

     readLock();

     return getDeleted_unsafe();

   }

  /**

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

   * <code>Unit</code> <code>Persistent</code>.

   * Field description: 

   *   Whether or not to include this Unit 

   * 

   * 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 setDeleted(Boolean cooked)

       throws AccessPoemException, ValidationPoemException {

     _getUnitTable().getDeletedColumn().

       getType().assertValidCooked(cooked);

     writeLock();

     setDeleted_unsafe(cooked);

   }

  /**

   * Sets the <code>Deleted</code> value, with checking, 

   * from a <code>boolean</code>, for this 

   * <code>Unit</code> <code>Persistent</code>.

   * Field description: 

   *   Whether or not to include this Unit 

   * 

   * 

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

   * @param cooked  a <code>boolean</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 setDeleted(boolean cooked)

       throws AccessPoemException, ValidationPoemException {

     setDeleted(cooked ? Boolean.TRUE : Boolean.FALSE);

   }

  /**

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

   * from this <code>Unit</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 Boolean deleted

   */

   public Field<Boolean> getDeletedField() throws AccessPoemException {

     Column<Boolean> c = _getUnitTable().getDeletedColumn();

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

   }

  /**

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

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

   *

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

   * @return the Timestamp lastencached

   */

   public Timestamp getLastencached_unsafe() {

     return lastencached;

   }

  /**

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

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

   * 

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

   * @param cooked  the pre-validated value to set

   */

   public void setLastencached_unsafe(Timestamp cooked) {

     lastencached = cooked;

   }

  /**

   * Retrieves the Lastencached value, with locking, for this 

   * <code>Unit</code> <code>Persistent</code>.

   * Field description: 

   *   When the unit was encached; cleared when the unit is updated 

   * 

   * 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>Lastencached</code> for this 

   *         <code>Unit</code> <code>Persistent</code>  

   */

   public Timestamp getLastencached()

       throws AccessPoemException {

     readLock();

     return getLastencached_unsafe();

   }

  /**

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

   * <code>Unit</code> <code>Persistent</code>.

   * Field description: 

   *   When the unit was encached; cleared when the unit is updated 

   * 

   * 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 setLastencached(Timestamp cooked)

       throws AccessPoemException, ValidationPoemException {

     _getUnitTable().getLastencachedColumn().

       getType().assertValidCooked(cooked);

     writeLock();

     setLastencached_unsafe(cooked);

   }

  /**

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

   * from this <code>Unit</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 lastencached

   */

   public Field<Timestamp> getLastencachedField() throws AccessPoemException {

     Column<Timestamp> c = _getUnitTable().getLastencachedColumn();

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

   }

  /**

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

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

   *

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

   * @return the Integer layout

   */

   public Integer getLayout_unsafe() {

     return layout;

   }

  /**

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

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

   * 

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

   * @param cooked  the pre-validated value to set

   */

   public void setLayout_unsafe(Integer cooked) {

     layout = cooked;

   }

  /**

   * Retrieves the Table Row Object ID. 

   *

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

   * @throws AccessPoemException  

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

   *         does not confer read access rights 

   * @return the TROID as an <code>Integer</code> 

   */

   public Integer getLayoutTroid()

       throws AccessPoemException {

     readLock();

     return getLayout_unsafe();

   }

  /**

   * Sets the Table Row Object ID. 

   * 

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

   * @param raw  a Table Row Object Id 

   * @throws AccessPoemException  

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

   *         does not confer write access rights

   */

   public void setLayoutTroid(Integer raw)

       throws AccessPoemException {

     setLayout(raw == null ? null : 

         getBibliomaniaDatabaseTables().getLayoutTable().getLayoutObject(raw));

   }

  /**

   * Retrieves the <code>Layout</code> object referred to.

   *  

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

   * @throws AccessPoemException  

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

   *         does not confer read access rights 

   * @throws NoSuchRowPoemException  

   *         if the <code>Persistent</code> has yet to be allocated a TROID 

   * @return the <code>Layout</code> as a <code>Layout</code> 

   */

   public Layout getLayout()

       throws AccessPoemException, NoSuchRowPoemException {

     Integer troid = getLayoutTroid();

     return troid == null ? null :

         getBibliomaniaDatabaseTables().getLayoutTable().getLayoutObject(troid);

   }

  /**

   * Set the Layout.

   * 

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

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

   * @throws AccessPoemException  

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

   *         does not confer write access rights 

   */

   public void setLayout(Layout cooked)

       throws AccessPoemException {

     _getUnitTable().

       getLayoutColumn().

         getType().assertValidCooked(cooked);

     writeLock();

     if (cooked == null)

       setLayout_unsafe(null);

     else {

       cooked.existenceLock();

       setLayout_unsafe(cooked.troid());

     }

   }

  /**

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

   * from this <code>Unit</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 layout

   */

   public Field<Integer> getLayoutField() throws AccessPoemException {

     Column<Integer> c = _getUnitTable().getLayoutColumn();

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

   }

  /**

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

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

   *

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

   * @return the Integer messageboard

   */

   public Integer getMessageboard_unsafe() {

     return messageboard;

   }

  /**

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

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

   * 

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

   * @param cooked  the pre-validated value to set

   */

   public void setMessageboard_unsafe(Integer cooked) {

     messageboard = cooked;

   }

  /**

   * Retrieves the Table Row Object ID. 

   *

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

   * @throws AccessPoemException  

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

   *         does not confer read access rights 

   * @return the TROID as an <code>Integer</code> 

   */

   public Integer getMessageboardTroid()

       throws AccessPoemException {

     readLock();

     return getMessageboard_unsafe();

   }

  /**

   * Sets the Table Row Object ID. 

   * 

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

   * @param raw  a Table Row Object Id 

   * @throws AccessPoemException  

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

   *         does not confer write access rights

   */

   public void setMessageboardTroid(Integer raw)

       throws AccessPoemException {

     setMessageboard(raw == null ? null : 

         (Board)getBibliomaniaDatabaseTables().getBoardTable().getBoardObject(raw));

   }

  /**

   * Retrieves the <code>Messageboard</code> object referred to.

   *  

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

   * @throws AccessPoemException  

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

   *         does not confer read access rights 

   * @throws NoSuchRowPoemException  

   *         if the <code>Persistent</code> has yet to be allocated a TROID 

   * @return the <code>Messageboard</code> as a <code>Board</code> 

   */

   public Board getMessageboard()

       throws AccessPoemException, NoSuchRowPoemException {

     Integer troid = getMessageboardTroid();

     return troid == null ? null :

         (Board)getBibliomaniaDatabaseTables().getBoardTable().getBoardObject(troid);

   }

  /**

   * Set the Messageboard.

   * 

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

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

   * @throws AccessPoemException  

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

   *         does not confer write access rights 

   */

   public void setMessageboard(Board cooked)

       throws AccessPoemException {

     _getUnitTable().

       getMessageboardColumn().

         getType().assertValidCooked(cooked);

     writeLock();

     if (cooked == null)

       setMessageboard_unsafe(null);

     else {

       cooked.existenceLock();

       setMessageboard_unsafe(cooked.troid());

     }

   }

  /**

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

   * from this <code>Unit</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 messageboard

   */

   public Field<Integer> getMessageboardField() throws AccessPoemException {

     Column<Integer> c = _getUnitTable().getMessageboardColumn();

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

   }

 }