org.melati.example.contacts.generated
Class ContactBase

java.lang.Object
  org.melati.poem.transaction.Transactioned
      org.melati.poem.JdbcPersistent
          org.melati.example.contacts.generated.ContactBase

All Implemented Interfaces:

Cloneable, Persistable, Persistent, Treeable

Direct Known Subclasses:

Contact

public abstract class ContactBase
extends JdbcPersistent

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

See Also:

TableDef.generatePersistentBaseJava(java.io.Writer)

Field Summary

protected String	address address - Contact Address
protected Integer	id id
protected Date	lastupdated lastupdated - When was this last updated?
protected Integer	lastupdateuser lastupdateuser - Who last updated this?
protected String	name name - Contact Name
protected Integer	owner owner - Contact who owns this contact
protected Integer	updates updates - How many times has this record been updated?

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

valid

Constructor Summary

ContactBase()

Method Summary

String	getAddress_unsafe() Retrieves the Address value, without locking, for this Contact Persistent.
String	getAddress() Retrieves the Address value, with locking, for this Contact Persistent.
Field	getAddressField() Retrieves the Address value as a Field from this Contact Persistent.
ContactsDatabaseTables	getContactsDatabaseTables() Retrieves the Database object.
ContactTable	getContactTable() Retrieves the ContactTable table which this Persistent is from.
Integer	getId_unsafe() Retrieves the Id value, without locking, for this Contact Persistent.
Integer	getId() Retrieves the Id value, with locking, for this Contact Persistent.
Field	getIdField() Retrieves the Id value as a Field from this Contact Persistent.
Date	getLastupdated_unsafe() Retrieves the Lastupdated value, without locking, for this Contact Persistent.
Date	getLastupdated() Retrieves the Lastupdated value, with locking, for this Contact Persistent.
Field	getLastupdatedField() Retrieves the Lastupdated value as a Field from this Contact Persistent.
Integer	getLastupdateuser_unsafe() Retrieves the Lastupdateuser value, without locking, for this Contact Persistent.
User	getLastupdateuser() Retrieves the Lastupdateuser object referred to.
Field	getLastupdateuserField() Retrieves the Lastupdateuser value as a Field from this Contact Persistent.
Integer	getLastupdateuserTroid() Retrieves the Table Row Object ID.
String	getName_unsafe() Retrieves the Name value, without locking, for this Contact Persistent.
String	getName() Retrieves the Name value, with locking, for this Contact Persistent.
Field	getNameField() Retrieves the Name value as a Field from this Contact Persistent.
Integer	getOwner_unsafe() Retrieves the Owner value, without locking, for this Contact Persistent.
Contact	getOwner() Retrieves the Owner object referred to.
Field	getOwnerField() Retrieves the Owner value as a Field from this Contact Persistent.
Integer	getOwnerTroid() Retrieves the Table Row Object ID.
Integer	getUpdates_unsafe() Retrieves the Updates value, without locking, for this Contact Persistent.
Integer	getUpdates() Retrieves the Updates value, with locking, for this Contact Persistent.
Field	getUpdatesField() Retrieves the Updates value as a Field from this Contact Persistent.
void	setAddress_unsafe(String cooked) Sets the Address value directly, without checking, for this Contact Persistent.
void	setAddress(String cooked) Sets the Address value, with checking, for this Contact Persistent.
void	setId_unsafe(Integer cooked) Sets the Id value directly, without checking, for this Contact Persistent.
void	setId(int cooked) Sets the Id value, with checking, for this Contact Persistent.
void	setId(Integer cooked) Sets the Id value, with checking, for this Contact Persistent.
void	setLastupdated_unsafe(Date cooked) Sets the Lastupdated value directly, without checking, for this Contact Persistent.
void	setLastupdated(Date cooked) Sets the Lastupdated value, with checking, for this Contact Persistent.
void	setLastupdateuser_unsafe(Integer cooked) Sets the Lastupdateuser value directly, without checking, for this Contact Persistent.
void	setLastupdateuser(User cooked) Set the Lastupdateuser.
void	setLastupdateuserTroid(Integer raw) Sets the Table Row Object ID.
void	setName_unsafe(String cooked) Sets the Name value directly, without checking, for this Contact Persistent.
void	setName(String cooked) Sets the Name value, with checking, for this Contact Persistent.
void	setOwner_unsafe(Integer cooked) Sets the Owner value directly, without checking, for this Contact Persistent.
void	setOwner(Contact cooked) Set the Owner.
void	setOwnerTroid(Integer raw) Sets the Table Row Object ID.
void	setUpdates_unsafe(Integer cooked) Sets the Updates value directly, without checking, for this Contact Persistent.
void	setUpdates(int cooked) Sets the Updates value, with checking, for this Contact Persistent.
void	setUpdates(Integer cooked) Sets the Updates value, with checking, for this Contact 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, 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

id

protected Integer id

id

name

protected String name

name - Contact Name

owner

protected Integer owner

owner - Contact who owns this contact

address

protected String address

address - Contact Address

updates

protected Integer updates

updates - How many times has this record been updated?

lastupdated

protected Date lastupdated

lastupdated - When was this last updated?

lastupdateuser

protected Integer lastupdateuser

lastupdateuser - Who last updated this?

Constructor Detail

ContactBase

public ContactBase()

Method Detail

getContactsDatabaseTables

public ContactsDatabaseTables getContactsDatabaseTables()

Retrieves the Database object.

Returns:

the database

See Also:

TableDef.generatePersistentBaseJava(java.io.Writer)

getContactTable

public ContactTable getContactTable()

Retrieves the ContactTable table which this Persistent is from.

Returns:

the ContactTable

See Also:

TableDef.generatePersistentBaseJava(java.io.Writer)

getId_unsafe

public Integer getId_unsafe()

Retrieves the Id value, without locking, for this Contact Persistent.

Returns:

the Integer id

See Also:

FieldDef.generateBaseMethods(java.io.Writer)

setId_unsafe

public void setId_unsafe(Integer cooked)

Sets the Id value directly, without checking, for this Contact Persistent.

Parameters:

cooked - the pre-validated value to set

See Also:

FieldDef.generateBaseMethods(java.io.Writer)

getId

public Integer getId()
              throws AccessPoemException

Retrieves the Id value, with locking, for this Contact Persistent.

Returns:

the value of the field Id for this Contact Persistent

Throws:

AccessPoemException - if the current AccessToken does not confer write access rights

Generator

org.melati.poem.prepro.AtomFieldDef#generateBaseMethods

setId

public void setId(Integer cooked)
           throws AccessPoemException,
                  ValidationPoemException

Sets the Id value, with checking, for this Contact Persistent.

Parameters:

cooked - a validated int

Throws:

AccessPoemException - if the current AccessToken does not confer write access rights

ValidationPoemException - if the value is not valid

Generator

org.melati.poem.prepro.AtomFieldDef#generateBaseMethods

setId

public final void setId(int cooked)
                 throws AccessPoemException,
                        ValidationPoemException

Sets the Id value, with checking, for this Contact Persistent.

Parameters:

cooked - a validated int

Throws:

AccessPoemException - if the current AccessToken does not confer write access rights

ValidationPoemException - if the value is not valid

Generator

org.melati.poem.prepro.IntegerFieldDef#generateBaseMethods

getIdField

public Field getIdField()
                 throws AccessPoemException

Retrieves the Id value as a Field from this Contact Persistent.

Returns:

the Integer id

Throws:

AccessPoemException - if the current AccessToken does not confer write access rights

See Also:

FieldDef.generateFieldCreator(java.io.Writer)

getName_unsafe

public String getName_unsafe()

Retrieves the Name value, without locking, for this Contact Persistent.

Returns:

the String name

See Also:

FieldDef.generateBaseMethods(java.io.Writer)

setName_unsafe

public void setName_unsafe(String cooked)

Sets the Name value directly, without checking, for this Contact Persistent.

Parameters:

cooked - the pre-validated value to set

See Also:

FieldDef.generateBaseMethods(java.io.Writer)

getName

public String getName()
               throws AccessPoemException

Retrieves the Name value, with locking, for this Contact Persistent. Field description: Contact Name

Specified by:

getName in interface Treeable

Overrides:

getName in class JdbcPersistent

Returns:

the value of the field Name for this Contact Persistent

Throws:

AccessPoemException - if the current AccessToken does not confer write access rights

See Also:

Treeable.getName()

Generator

org.melati.poem.prepro.AtomFieldDef#generateBaseMethods

setName

public void setName(String cooked)
             throws AccessPoemException,
                    ValidationPoemException

Sets the Name value, with checking, for this Contact Persistent. Field description: Contact Name

Parameters:

cooked - a validated int

Throws:

AccessPoemException - if the current AccessToken does not confer write access rights

ValidationPoemException - if the value is not valid

Generator

org.melati.poem.prepro.AtomFieldDef#generateBaseMethods

getNameField

public Field getNameField()
                   throws AccessPoemException

Retrieves the Name value as a Field from this Contact Persistent.

Returns:

the String name

Throws:

AccessPoemException - if the current AccessToken does not confer write access rights

See Also:

FieldDef.generateFieldCreator(java.io.Writer)

getOwner_unsafe

public Integer getOwner_unsafe()

Retrieves the Owner value, without locking, for this Contact Persistent.

Returns:

the Integer owner

See Also:

FieldDef.generateBaseMethods(java.io.Writer)

setOwner_unsafe

public void setOwner_unsafe(Integer cooked)

Sets the Owner value directly, without checking, for this Contact Persistent.

Parameters:

cooked - the pre-validated value to set

See Also:

FieldDef.generateBaseMethods(java.io.Writer)

getOwnerTroid

public Integer getOwnerTroid()
                      throws AccessPoemException

Retrieves the Table Row Object ID.

Returns:

the TROID as an Integer

Throws:

AccessPoemException - if the current AccessToken does not confer read access rights

Generator

org.melati.poem.prepro.ReferenceFieldDef#generateBaseMethods

setOwnerTroid

public void setOwnerTroid(Integer raw)
                   throws AccessPoemException

Sets the Table Row Object ID.

Parameters:

raw - a Table Row Object Id

Throws:

AccessPoemException - if the current AccessToken does not confer write access rights

Generator

org.melati.poem.prepro.ReferenceFieldDef#generateBaseMethods

getOwner

public Contact getOwner()
                 throws AccessPoemException,
                        NoSuchRowPoemException

Retrieves the Owner object referred to.

Returns:

the Owner as a Contact

Throws:

AccessPoemException - if the current AccessToken does not confer read access rights

NoSuchRowPoemException - if the Persistent has yet to be allocated a TROID

Generator

org.melati.poem.prepro.ReferenceFieldDef#generateBaseMethods

setOwner

public void setOwner(Contact cooked)
              throws AccessPoemException

Set the Owner.

Parameters:

cooked - a validated Contact

Throws:

AccessPoemException - if the current AccessToken does not confer write access rights

Generator

org.melati.poem.prepro.ReferenceFieldDef#generateBaseMethods

getOwnerField

public Field getOwnerField()
                    throws AccessPoemException

Retrieves the Owner value as a Field from this Contact Persistent.

Returns:

the Integer owner

Throws:

AccessPoemException - if the current AccessToken does not confer write access rights

See Also:

FieldDef.generateFieldCreator(java.io.Writer)

getAddress_unsafe

public String getAddress_unsafe()

Retrieves the Address value, without locking, for this Contact Persistent.

Returns:

the String address

See Also:

FieldDef.generateBaseMethods(java.io.Writer)

setAddress_unsafe

public void setAddress_unsafe(String cooked)

Sets the Address value directly, without checking, for this Contact Persistent.

Parameters:

cooked - the pre-validated value to set

See Also:

FieldDef.generateBaseMethods(java.io.Writer)

getAddress

public String getAddress()
                  throws AccessPoemException

Retrieves the Address value, with locking, for this Contact Persistent. Field description: Contact Address

Returns:

the value of the field Address for this Contact Persistent

Throws:

AccessPoemException - if the current AccessToken does not confer write access rights

Generator

org.melati.poem.prepro.AtomFieldDef#generateBaseMethods

setAddress

public void setAddress(String cooked)
                throws AccessPoemException,
                       ValidationPoemException

Sets the Address value, with checking, for this Contact Persistent. Field description: Contact Address

Parameters:

cooked - a validated int

Throws:

AccessPoemException - if the current AccessToken does not confer write access rights

ValidationPoemException - if the value is not valid

Generator

org.melati.poem.prepro.AtomFieldDef#generateBaseMethods

getAddressField

public Field getAddressField()
                      throws AccessPoemException

Retrieves the Address value as a Field from this Contact Persistent.

Returns:

the String address

Throws:

AccessPoemException - if the current AccessToken does not confer write access rights

See Also:

FieldDef.generateFieldCreator(java.io.Writer)

getUpdates_unsafe

public Integer getUpdates_unsafe()

Retrieves the Updates value, without locking, for this Contact Persistent.

Returns:

the Integer updates

See Also:

FieldDef.generateBaseMethods(java.io.Writer)

setUpdates_unsafe

public void setUpdates_unsafe(Integer cooked)

Sets the Updates value directly, without checking, for this Contact Persistent.

Parameters:

cooked - the pre-validated value to set

See Also:

FieldDef.generateBaseMethods(java.io.Writer)

getUpdates

public Integer getUpdates()
                   throws AccessPoemException

Retrieves the Updates value, with locking, for this Contact Persistent. Field description: How many times has this record been updated?

Returns:

the value of the field Updates for this Contact Persistent

Throws:

AccessPoemException - if the current AccessToken does not confer write access rights

Generator

org.melati.poem.prepro.AtomFieldDef#generateBaseMethods

setUpdates

public void setUpdates(Integer cooked)
                throws AccessPoemException,
                       ValidationPoemException

Sets the Updates value, with checking, for this Contact Persistent. Field description: How many times has this record been updated?

Parameters:

cooked - a validated int

Throws:

AccessPoemException - if the current AccessToken does not confer write access rights

ValidationPoemException - if the value is not valid

Generator

org.melati.poem.prepro.AtomFieldDef#generateBaseMethods

setUpdates

public final void setUpdates(int cooked)
                      throws AccessPoemException,
                             ValidationPoemException

Sets the Updates value, with checking, for this Contact Persistent. Field description: How many times has this record been updated?

Parameters:

cooked - a validated int

Throws:

AccessPoemException - if the current AccessToken does not confer write access rights

ValidationPoemException - if the value is not valid

Generator

org.melati.poem.prepro.IntegerFieldDef#generateBaseMethods

getUpdatesField

public Field getUpdatesField()
                      throws AccessPoemException

Retrieves the Updates value as a Field from this Contact Persistent.

Returns:

the Integer updates

Throws:

AccessPoemException - if the current AccessToken does not confer write access rights

See Also:

FieldDef.generateFieldCreator(java.io.Writer)

getLastupdated_unsafe

public Date getLastupdated_unsafe()

Retrieves the Lastupdated value, without locking, for this Contact Persistent.

Returns:

the Date lastupdated

See Also:

FieldDef.generateBaseMethods(java.io.Writer)

setLastupdated_unsafe

public void setLastupdated_unsafe(Date cooked)

Sets the Lastupdated value directly, without checking, for this Contact Persistent.

Parameters:

cooked - the pre-validated value to set

See Also:

FieldDef.generateBaseMethods(java.io.Writer)

getLastupdated

public Date getLastupdated()
                    throws AccessPoemException

Retrieves the Lastupdated value, with locking, for this Contact Persistent. Field description: When was this last updated?

Returns:

the value of the field Lastupdated for this Contact Persistent

Throws:

AccessPoemException - if the current AccessToken does not confer write access rights

Generator

org.melati.poem.prepro.AtomFieldDef#generateBaseMethods

setLastupdated

public void setLastupdated(Date cooked)
                    throws AccessPoemException,
                           ValidationPoemException

Sets the Lastupdated value, with checking, for this Contact Persistent. Field description: When was this last updated?

Parameters:

cooked - a validated int

Throws:

AccessPoemException - if the current AccessToken does not confer write access rights

ValidationPoemException - if the value is not valid

Generator

org.melati.poem.prepro.AtomFieldDef#generateBaseMethods

getLastupdatedField

public Field getLastupdatedField()
                          throws AccessPoemException

Retrieves the Lastupdated value as a Field from this Contact Persistent.

Returns:

the Date lastupdated

Throws:

AccessPoemException - if the current AccessToken does not confer write access rights

See Also:

FieldDef.generateFieldCreator(java.io.Writer)

getLastupdateuser_unsafe

public Integer getLastupdateuser_unsafe()

Retrieves the Lastupdateuser value, without locking, for this Contact Persistent.

Returns:

the Integer lastupdateuser

See Also:

FieldDef.generateBaseMethods(java.io.Writer)

setLastupdateuser_unsafe

public void setLastupdateuser_unsafe(Integer cooked)

Sets the Lastupdateuser value directly, without checking, for this Contact Persistent.

Parameters:

cooked - the pre-validated value to set

See Also:

FieldDef.generateBaseMethods(java.io.Writer)

getLastupdateuserTroid

public Integer getLastupdateuserTroid()
                               throws AccessPoemException

Retrieves the Table Row Object ID.

Returns:

the TROID as an Integer

Throws:

AccessPoemException - if the current AccessToken does not confer read access rights

Generator

org.melati.poem.prepro.ReferenceFieldDef#generateBaseMethods

setLastupdateuserTroid

public void setLastupdateuserTroid(Integer raw)
                            throws AccessPoemException

Sets the Table Row Object ID.

Parameters:

raw - a Table Row Object Id

Throws:

AccessPoemException - if the current AccessToken does not confer write access rights

Generator

org.melati.poem.prepro.ReferenceFieldDef#generateBaseMethods

getLastupdateuser

public User getLastupdateuser()
                       throws AccessPoemException,
                              NoSuchRowPoemException

Retrieves the Lastupdateuser object referred to.

Returns:

the Lastupdateuser as a User

Throws:

AccessPoemException - if the current AccessToken does not confer read access rights

NoSuchRowPoemException - if the Persistent has yet to be allocated a TROID

Generator

org.melati.poem.prepro.ReferenceFieldDef#generateBaseMethods

setLastupdateuser

public void setLastupdateuser(User cooked)
                       throws AccessPoemException

Set the Lastupdateuser.

Parameters:

cooked - a validated User

Throws:

AccessPoemException - if the current AccessToken does not confer write access rights

Generator

org.melati.poem.prepro.ReferenceFieldDef#generateBaseMethods

getLastupdateuserField

public Field getLastupdateuserField()
                             throws AccessPoemException

Retrieves the Lastupdateuser value as a Field from this Contact Persistent.

Returns:

the Integer lastupdateuser

Throws:

AccessPoemException - if the current AccessToken does not confer write access rights

See Also:

FieldDef.generateFieldCreator(java.io.Writer)