org.paneris.bibliomania.generated
Class UnitBase

java.lang.Object
  org.melati.poem.transaction.Transactioned
      org.melati.poem.JdbcPersistent
          org.paneris.bibliomania.generated.UnitBase

All Implemented Interfaces:

java.lang.Cloneable, org.melati.poem.Persistable, org.melati.poem.Persistent, org.melati.poem.Treeable

Direct Known Subclasses:

Unit

public abstract class UnitBase
extends org.melati.poem.JdbcPersistent

Melati POEM generated abstract base class for a Persistent Unit Object.

See Also:

org.melati.poem.prepro.TableDef#generatePersistentBaseJava

Field Summary

protected java.lang.Boolean	deleted deleted - Whether or not to include this Unit
protected java.sql.Timestamp	lastencached Last encached - When the unit was encached; cleared when the unit is updated
protected java.lang.Integer	layout layout - The name of the layout for this Unit
protected java.lang.Integer	messageboard messageboard - A messageboard on which this unit can be discussed
protected java.lang.String	path path - The path to this unit in the local filesystem, relative to the application's workspace

Fields inherited from class org.melati.poem.transaction.Transactioned

valid

Constructor Summary

UnitBase()

Method Summary

BibliomaniaDatabaseTables	getBibliomaniaDatabaseTables() Retrieves the Database object.
java.lang.Boolean	getDeleted_unsafe() Retrieves the Deleted value, without locking, for this Unit Persistent.
java.lang.Boolean	getDeleted() Retrieves the Deleted value, with locking, for this Unit Persistent.
org.melati.poem.Field	getDeletedField() Retrieves the Deleted value as a Field from this Unit Persistent.
java.sql.Timestamp	getLastencached_unsafe() Retrieves the Lastencached value, without locking, for this Unit Persistent.
java.sql.Timestamp	getLastencached() Retrieves the Lastencached value, with locking, for this Unit Persistent.
org.melati.poem.Field	getLastencachedField() Retrieves the Lastencached value as a Field from this Unit Persistent.
java.lang.Integer	getLayout_unsafe() Retrieves the Layout value, without locking, for this Unit Persistent.
Layout	getLayout() Retrieves the Layout object referred to.
org.melati.poem.Field	getLayoutField() Retrieves the Layout value as a Field from this Unit Persistent.
java.lang.Integer	getLayoutTroid() Retrieves the Table Row Object ID.
java.lang.Integer	getMessageboard_unsafe() Retrieves the Messageboard value, without locking, for this Unit Persistent.
Board	getMessageboard() Retrieves the Messageboard object referred to.
org.melati.poem.Field	getMessageboardField() Retrieves the Messageboard value as a Field from this Unit Persistent.
java.lang.Integer	getMessageboardTroid() Retrieves the Table Row Object ID.
java.lang.String	getPath_unsafe() Retrieves the Path value, without locking, for this Unit Persistent.
java.lang.String	getPath() Retrieves the Path value, with locking, for this Unit Persistent.
org.melati.poem.Field	getPathField() Retrieves the Path value as a Field from this Unit Persistent.
UnitTable	getUnitTable() Retrieves the UnitTable table which this Persistent is from.
void	setDeleted_unsafe(java.lang.Boolean cooked) Sets the Deleted value directly, without checking, for this Unit Persistent.
void	setDeleted(boolean cooked) Sets the Deleted value, with checking, from a boolean, for this Unit Persistent.
void	setDeleted(java.lang.Boolean cooked) Sets the Deleted value, with checking, for this Unit Persistent.
void	setLastencached_unsafe(java.sql.Timestamp cooked) Sets the Lastencached value directly, without checking, for this Unit Persistent.
void	setLastencached(java.sql.Timestamp cooked) Sets the Lastencached value, with checking, for this Unit Persistent.
void	setLayout_unsafe(java.lang.Integer cooked) Sets the Layout value directly, without checking, for this Unit Persistent.
void	setLayout(Layout cooked) Set the Layout.
void	setLayoutTroid(java.lang.Integer raw) Sets the Table Row Object ID.
void	setMessageboard_unsafe(java.lang.Integer cooked) Sets the Messageboard value directly, without checking, for this Unit Persistent.
void	setMessageboard(Board cooked) Set the Messageboard.
void	setMessageboardTroid(java.lang.Integer raw) Sets the Table Row Object ID.
void	setPath_unsafe(java.lang.String cooked) Sets the Path value directly, without checking, for this Unit Persistent.
void	setPath(java.lang.String cooked) Sets the Path value, with checking, for this Unit Persistent.

Methods inherited from class org.melati.poem.JdbcPersistent

assertCanCreate, assertCanCreate, assertCanDelete, assertCanDelete, assertCanRead, assertCanRead, assertCanWrite, assertCanWrite, clone, commit, countMatchSQL, delete_unsafe, delete, delete, deleteAndCommit, deleteAndCommit, deleteLock, displayString, displayString, displayString, dump, dump, duplicated, duplicatedFloating, equals, existenceLock, existenceLock, fieldsOfColumns, fromClause, getCanDelete, getCanRead, getCanSelect, getCanWrite, getChildren, getCooked, getCookedString, getDatabase, getDetailDisplayFields, getField, getFields, getName, getPrimaryDisplayField, getRaw, getRawString, getReadable, getRecordDisplayFields, getSearchCriterionFields, getSummaryDisplayFields, getTable, getTroid, hashCode, invalidate, isDirty, load, makePersistent, postEdit, postInsert, postModify, postWrite, preEdit, readLock, readLock, readLock, rollback, setCooked, setDirty, setRaw, setRawString, statusExistent, statusNonexistent, toString, troid, upToDate, writeDown, writeLock, writeLock, writeLock

Methods inherited from class org.melati.poem.transaction.Transactioned

markValid, reset, setTransactionPool, transactionPool, unSee

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

path

protected java.lang.String path

path - The path to this unit in the local filesystem, relative to the application's workspace

deleted

protected java.lang.Boolean deleted

deleted - Whether or not to include this Unit

lastencached

protected java.sql.Timestamp lastencached

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

layout

protected java.lang.Integer layout

layout - The name of the layout for this Unit

messageboard

protected java.lang.Integer messageboard

messageboard - A messageboard on which this unit can be discussed

Constructor Detail

UnitBase

public UnitBase()

Method Detail

getBibliomaniaDatabaseTables

public BibliomaniaDatabaseTables getBibliomaniaDatabaseTables()

Retrieves the Database object.

Returns:

the database

See Also:

org.melati.poem.prepro.TableDef#generatePersistentBaseJava

getUnitTable

public UnitTable getUnitTable()

Retrieves the UnitTable table which this Persistent is from.

Returns:

the UnitTable

See Also:

org.melati.poem.prepro.TableDef#generatePersistentBaseJava

getPath_unsafe

public java.lang.String getPath_unsafe()

Retrieves the Path value, without locking, for this Unit Persistent.

Returns:

the String path

See Also:

org.melati.poem.prepro.FieldDef#generateBaseMethods

setPath_unsafe

public void setPath_unsafe(java.lang.String cooked)

Sets the Path value directly, without checking, for this Unit Persistent.

Parameters:

cooked - the pre-validated value to set

See Also:

org.melati.poem.prepro.FieldDef#generateBaseMethods

getPath

public java.lang.String getPath()
                         throws org.melati.poem.AccessPoemException

Retrieves the Path value, with locking, for this Unit Persistent. Field description: The path to this unit in the local filesystem, relative to the application's workspace

Returns:

the value of the field Path for this Unit Persistent

Throws:

org.melati.poem.AccessPoemException - if the current AccessToken does not confer write access rights

Generator

org.melati.poem.prepro.AtomFieldDef#generateBaseMethods

setPath

public void setPath(java.lang.String cooked)
             throws org.melati.poem.AccessPoemException,
                    org.melati.poem.ValidationPoemException

Sets the Path value, with checking, for this Unit Persistent. Field description: The path to this unit in the local filesystem, relative to the application's workspace

Parameters:

cooked - a validated int

Throws:

org.melati.poem.AccessPoemException - if the current AccessToken does not confer write access rights

org.melati.poem.ValidationPoemException - if the value is not valid

Generator

org.melati.poem.prepro.AtomFieldDef#generateBaseMethods

getPathField

public org.melati.poem.Field getPathField()
                                   throws org.melati.poem.AccessPoemException

Retrieves the Path value as a Field from this Unit Persistent.

Returns:

the String path

Throws:

org.melati.poem.AccessPoemException - if the current AccessToken does not confer write access rights

See Also:

org.melati.poem.prepro.FieldDef#generateFieldCreator

getDeleted_unsafe

public java.lang.Boolean getDeleted_unsafe()

Retrieves the Deleted value, without locking, for this Unit Persistent.

Returns:

the Boolean deleted

See Also:

org.melati.poem.prepro.FieldDef#generateBaseMethods

setDeleted_unsafe

public void setDeleted_unsafe(java.lang.Boolean cooked)

Sets the Deleted value directly, without checking, for this Unit Persistent.

Parameters:

cooked - the pre-validated value to set

See Also:

org.melati.poem.prepro.FieldDef#generateBaseMethods

getDeleted

public java.lang.Boolean getDeleted()
                             throws org.melati.poem.AccessPoemException

Retrieves the Deleted value, with locking, for this Unit Persistent. Field description: Whether or not to include this Unit

Returns:

the value of the field Deleted for this Unit Persistent

Throws:

org.melati.poem.AccessPoemException - if the current AccessToken does not confer write access rights

Generator

org.melati.poem.prepro.AtomFieldDef#generateBaseMethods

setDeleted

public void setDeleted(java.lang.Boolean cooked)
                throws org.melati.poem.AccessPoemException,
                       org.melati.poem.ValidationPoemException

Sets the Deleted value, with checking, for this Unit Persistent. Field description: Whether or not to include this Unit

Parameters:

cooked - a validated int

Throws:

org.melati.poem.AccessPoemException - if the current AccessToken does not confer write access rights

org.melati.poem.ValidationPoemException - if the value is not valid

Generator

org.melati.poem.prepro.AtomFieldDef#generateBaseMethods

setDeleted

public final void setDeleted(boolean cooked)
                      throws org.melati.poem.AccessPoemException,
                             org.melati.poem.ValidationPoemException

Sets the Deleted value, with checking, from a boolean, for this Unit Persistent. Field description: Whether or not to include this Unit

Parameters:

cooked - a boolean

Throws:

org.melati.poem.AccessPoemException - if the current AccessToken does not confer write access rights

org.melati.poem.ValidationPoemException - if the value is not valid

Generator

org.melati.poem.prepro.BooleanFieldDef#generateBaseMethods

getDeletedField

public org.melati.poem.Field getDeletedField()
                                      throws org.melati.poem.AccessPoemException

Retrieves the Deleted value as a Field from this Unit Persistent.

Returns:

the Boolean deleted

Throws:

org.melati.poem.AccessPoemException - if the current AccessToken does not confer write access rights

See Also:

org.melati.poem.prepro.FieldDef#generateFieldCreator

getLastencached_unsafe

public java.sql.Timestamp getLastencached_unsafe()

Retrieves the Lastencached value, without locking, for this Unit Persistent.

Returns:

the Timestamp lastencached

See Also:

org.melati.poem.prepro.FieldDef#generateBaseMethods

setLastencached_unsafe

public void setLastencached_unsafe(java.sql.Timestamp cooked)

Sets the Lastencached value directly, without checking, for this Unit Persistent.

Parameters:

cooked - the pre-validated value to set

See Also:

org.melati.poem.prepro.FieldDef#generateBaseMethods

getLastencached

public java.sql.Timestamp getLastencached()
                                   throws org.melati.poem.AccessPoemException

Retrieves the Lastencached value, with locking, for this Unit Persistent. Field description: When the unit was encached; cleared when the unit is updated

Returns:

the value of the field Lastencached for this Unit Persistent

Throws:

org.melati.poem.AccessPoemException - if the current AccessToken does not confer write access rights

Generator

org.melati.poem.prepro.AtomFieldDef#generateBaseMethods

setLastencached

public void setLastencached(java.sql.Timestamp cooked)
                     throws org.melati.poem.AccessPoemException,
                            org.melati.poem.ValidationPoemException

Sets the Lastencached value, with checking, for this Unit Persistent. Field description: When the unit was encached; cleared when the unit is updated

Parameters:

cooked - a validated int

Throws:

org.melati.poem.AccessPoemException - if the current AccessToken does not confer write access rights

org.melati.poem.ValidationPoemException - if the value is not valid

Generator

org.melati.poem.prepro.AtomFieldDef#generateBaseMethods

getLastencachedField

public org.melati.poem.Field getLastencachedField()
                                           throws org.melati.poem.AccessPoemException

Retrieves the Lastencached value as a Field from this Unit Persistent.

Returns:

the Timestamp lastencached

Throws:

org.melati.poem.AccessPoemException - if the current AccessToken does not confer write access rights

See Also:

org.melati.poem.prepro.FieldDef#generateFieldCreator

getLayout_unsafe

public java.lang.Integer getLayout_unsafe()

Retrieves the Layout value, without locking, for this Unit Persistent.

Returns:

the Integer layout

See Also:

org.melati.poem.prepro.FieldDef#generateBaseMethods

setLayout_unsafe

public void setLayout_unsafe(java.lang.Integer cooked)

Sets the Layout value directly, without checking, for this Unit Persistent.

Parameters:

cooked - the pre-validated value to set

See Also:

org.melati.poem.prepro.FieldDef#generateBaseMethods

getLayoutTroid

public java.lang.Integer getLayoutTroid()
                                 throws org.melati.poem.AccessPoemException

Retrieves the Table Row Object ID.

Returns:

the TROID as an Integer

Throws:

org.melati.poem.AccessPoemException - if the current AccessToken does not confer read access rights

Generator

org.melati.poem.prepro.ReferenceFieldDef#generateBaseMethods

setLayoutTroid

public void setLayoutTroid(java.lang.Integer raw)
                    throws org.melati.poem.AccessPoemException

Sets the Table Row Object ID.

Parameters:

raw - a Table Row Object Id

Throws:

org.melati.poem.AccessPoemException - if the current AccessToken does not confer write access rights

Generator

org.melati.poem.prepro.ReferenceFieldDef#generateBaseMethods

getLayout

public Layout getLayout()
                 throws org.melati.poem.AccessPoemException,
                        org.melati.poem.NoSuchRowPoemException

Retrieves the Layout object referred to.

Returns:

the Layout as a Layout

Throws:

org.melati.poem.AccessPoemException - if the current AccessToken does not confer read access rights

org.melati.poem.NoSuchRowPoemException - if the Persistent has yet to be allocated a TROID

Generator

org.melati.poem.prepro.ReferenceFieldDef#generateBaseMethods

setLayout

public void setLayout(Layout cooked)
               throws org.melati.poem.AccessPoemException

Set the Layout.

Parameters:

cooked - a validated Layout

Throws:

org.melati.poem.AccessPoemException - if the current AccessToken does not confer write access rights

Generator

org.melati.poem.prepro.ReferenceFieldDef#generateBaseMethods

getLayoutField

public org.melati.poem.Field getLayoutField()
                                     throws org.melati.poem.AccessPoemException

Retrieves the Layout value as a Field from this Unit Persistent.

Returns:

the Integer layout

Throws:

org.melati.poem.AccessPoemException - if the current AccessToken does not confer write access rights

See Also:

org.melati.poem.prepro.FieldDef#generateFieldCreator

getMessageboard_unsafe

public java.lang.Integer getMessageboard_unsafe()

Retrieves the Messageboard value, without locking, for this Unit Persistent.

Returns:

the Integer messageboard

See Also:

org.melati.poem.prepro.FieldDef#generateBaseMethods

setMessageboard_unsafe

public void setMessageboard_unsafe(java.lang.Integer cooked)

Sets the Messageboard value directly, without checking, for this Unit Persistent.

Parameters:

cooked - the pre-validated value to set

See Also:

org.melati.poem.prepro.FieldDef#generateBaseMethods

getMessageboardTroid

public java.lang.Integer getMessageboardTroid()
                                       throws org.melati.poem.AccessPoemException

Retrieves the Table Row Object ID.

Returns:

the TROID as an Integer

Throws:

org.melati.poem.AccessPoemException - if the current AccessToken does not confer read access rights

Generator

org.melati.poem.prepro.ReferenceFieldDef#generateBaseMethods

setMessageboardTroid

public void setMessageboardTroid(java.lang.Integer raw)
                          throws org.melati.poem.AccessPoemException

Sets the Table Row Object ID.

Parameters:

raw - a Table Row Object Id

Throws:

org.melati.poem.AccessPoemException - if the current AccessToken does not confer write access rights

Generator

org.melati.poem.prepro.ReferenceFieldDef#generateBaseMethods

getMessageboard

public Board getMessageboard()
                      throws org.melati.poem.AccessPoemException,
                             org.melati.poem.NoSuchRowPoemException

Retrieves the Messageboard object referred to.

Returns:

the Messageboard as a Board

Throws:

org.melati.poem.AccessPoemException - if the current AccessToken does not confer read access rights

org.melati.poem.NoSuchRowPoemException - if the Persistent has yet to be allocated a TROID

Generator

org.melati.poem.prepro.ReferenceFieldDef#generateBaseMethods

setMessageboard

public void setMessageboard(Board cooked)
                     throws org.melati.poem.AccessPoemException

Set the Messageboard.

Parameters:

cooked - a validated Board

Throws:

org.melati.poem.AccessPoemException - if the current AccessToken does not confer write access rights

Generator

org.melati.poem.prepro.ReferenceFieldDef#generateBaseMethods

getMessageboardField

public org.melati.poem.Field getMessageboardField()
                                           throws org.melati.poem.AccessPoemException

Retrieves the Messageboard value as a Field from this Unit Persistent.

Returns:

the Integer messageboard

Throws:

org.melati.poem.AccessPoemException - if the current AccessToken does not confer write access rights

See Also:

org.melati.poem.prepro.FieldDef#generateFieldCreator