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, org.melati.poem.Persistable, org.melati.poem.Persistent, org.melati.poem.Treeable

Direct Known Subclasses:

Contact

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

Melati POEM generated abstract base class for a Persistent Contact Object. See org.melati.poem.prepro.TableDef#generatePersistentBaseJava

Field Summary

Fields

Modifier and Type	Field and Description
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

Constructors

Constructor and Description
ContactBase()

Method Summary

Modifier and Type	Method and Description
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.
org.melati.poem.Field<String>	getAddressField() Retrieves the Address value as a Field from this Contact Persistent.
List<ContactCategory>	getContactContactCategoryList() References to this Contact in the ContactCategory table via its contact field, as a List.
Enumeration<ContactCategory>	getContactContactCategorys() References to this Contact in the ContactCategory table via its contact field.
ContactsDatabaseTables	getContactsDatabaseTables() Retrieves the Database object.
ContactTable<Contact>	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.
org.melati.poem.Field<Integer>	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.
org.melati.poem.Field<Date>	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.
org.melati.poem.User	getLastupdateuser() Retrieves the Lastupdateuser object referred to.
org.melati.poem.Field<Integer>	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.
org.melati.poem.Field<String>	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.
List<Contact>	getOwnerContactList() References to this Contact in the Contact table via its owner field, as a List.
Enumeration<Contact>	getOwnerContacts() References to this Contact in the Contact table via its owner field.
org.melati.poem.Field<Integer>	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.
org.melati.poem.Field<Integer>	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(org.melati.poem.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. See org.melati.poem.prepro.TableDef#generatePersistentBaseJava

Returns:

the database

getContactTable

public ContactTable<Contact> getContactTable()

Retrieves the ContactTable table which this Persistent is from. See org.melati.poem.prepro.TableDef#generatePersistentBaseJava

Returns:

the ContactTable

getId_unsafe

public Integer getId_unsafe()

Retrieves the Id value, without locking, for this Contact Persistent. see org.melati.poem.prepro.FieldDef#generateBaseMethods

Returns:

the Integer id

setId_unsafe

public void setId_unsafe(Integer cooked)

Sets the Id value directly, without checking, for this Contact Persistent. see org.melati.poem.prepro.FieldDef#generateBaseMethods

Parameters:

cooked - the pre-validated value to set

getId

public Integer getId()
              throws org.melati.poem.AccessPoemException

Retrieves the Id value, with locking, for this Contact Persistent. Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods

Returns:

the value of the field Id for this Contact Persistent

Throws:

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

setId

public void setId(Integer cooked)
           throws org.melati.poem.AccessPoemException,
                  org.melati.poem.ValidationPoemException

Sets the Id value, with checking, for this Contact Persistent. Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods

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

setId

public final void setId(int cooked)
                 throws org.melati.poem.AccessPoemException,
                        org.melati.poem.ValidationPoemException

Sets the Id value, with checking, for this Contact Persistent. Generated by org.melati.poem.prepro.IntegerFieldDef#generateBaseMethods

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

getIdField

public org.melati.poem.Field<Integer> getIdField()
                                          throws org.melati.poem.AccessPoemException

Retrieves the Id value as a Field from this Contact Persistent. see org.melati.poem.prepro.FieldDef#generateFieldCreator

Returns:

the Integer id

Throws:

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

getName_unsafe

public String getName_unsafe()

Retrieves the Name value, without locking, for this Contact Persistent. see org.melati.poem.prepro.FieldDef#generateBaseMethods

Returns:

the String name

setName_unsafe

public void setName_unsafe(String cooked)

Sets the Name value directly, without checking, for this Contact Persistent. see org.melati.poem.prepro.FieldDef#generateBaseMethods

Parameters:

cooked - the pre-validated value to set

getName

public String getName()
               throws org.melati.poem.AccessPoemException

Retrieves the Name value, with locking, for this Contact Persistent. Field description: Contact Name Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods

Specified by:

getName in interface org.melati.poem.Treeable

Overrides:

getName in class org.melati.poem.JdbcPersistent

Returns:

the value of the field Name for this Contact Persistent

Throws:

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

setName

public void setName(String cooked)
             throws org.melati.poem.AccessPoemException,
                    org.melati.poem.ValidationPoemException

Sets the Name value, with checking, for this Contact Persistent. Field description: Contact Name Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods

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

getNameField

public org.melati.poem.Field<String> getNameField()
                                           throws org.melati.poem.AccessPoemException

Retrieves the Name value as a Field from this Contact Persistent. see org.melati.poem.prepro.FieldDef#generateFieldCreator

Returns:

the String name

Throws:

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

getOwner_unsafe

public Integer getOwner_unsafe()

Retrieves the Owner value, without locking, for this Contact Persistent. see org.melati.poem.prepro.FieldDef#generateBaseMethods

Returns:

the Integer owner

setOwner_unsafe

public void setOwner_unsafe(Integer cooked)

Sets the Owner value directly, without checking, for this Contact Persistent. see org.melati.poem.prepro.FieldDef#generateBaseMethods

Parameters:

cooked - the pre-validated value to set

getOwnerTroid

public Integer getOwnerTroid()
                      throws org.melati.poem.AccessPoemException

Retrieves the Table Row Object ID. Generated by org.melati.poem.prepro.ReferenceFieldDef#generateBaseMethods

Returns:

the TROID as an Integer

Throws:

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

setOwnerTroid

public void setOwnerTroid(Integer raw)
                   throws org.melati.poem.AccessPoemException

Sets the Table Row Object ID. Generated by org.melati.poem.prepro.ReferenceFieldDef#generateBaseMethods

Parameters:

raw - a Table Row Object Id

Throws:

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

getOwner

public Contact getOwner()
                 throws org.melati.poem.AccessPoemException,
                        org.melati.poem.NoSuchRowPoemException

Retrieves the Owner object referred to. Generated by org.melati.poem.prepro.ReferenceFieldDef#generateBaseMethods

Returns:

the Owner as a Contact

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

setOwner

public void setOwner(Contact cooked)
              throws org.melati.poem.AccessPoemException

Set the Owner. Generated by org.melati.poem.prepro.ReferenceFieldDef#generateBaseMethods

Parameters:

cooked - a validated Contact

Throws:

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

getOwnerField

public org.melati.poem.Field<Integer> getOwnerField()
                                             throws org.melati.poem.AccessPoemException

Retrieves the Owner value as a Field from this Contact Persistent. see org.melati.poem.prepro.FieldDef#generateFieldCreator

Returns:

the Integer owner

Throws:

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

getAddress_unsafe

public String getAddress_unsafe()

Retrieves the Address value, without locking, for this Contact Persistent. see org.melati.poem.prepro.FieldDef#generateBaseMethods

Returns:

the String address

setAddress_unsafe

public void setAddress_unsafe(String cooked)

Sets the Address value directly, without checking, for this Contact Persistent. see org.melati.poem.prepro.FieldDef#generateBaseMethods

Parameters:

cooked - the pre-validated value to set

getAddress

public String getAddress()
                  throws org.melati.poem.AccessPoemException

Retrieves the Address value, with locking, for this Contact Persistent. Field description: Contact Address Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods

Returns:

the value of the field Address for this Contact Persistent

Throws:

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

setAddress

public void setAddress(String cooked)
                throws org.melati.poem.AccessPoemException,
                       org.melati.poem.ValidationPoemException

Sets the Address value, with checking, for this Contact Persistent. Field description: Contact Address Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods

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

getAddressField

public org.melati.poem.Field<String> getAddressField()
                                              throws org.melati.poem.AccessPoemException

Retrieves the Address value as a Field from this Contact Persistent. see org.melati.poem.prepro.FieldDef#generateFieldCreator

Returns:

the String address

Throws:

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

getUpdates_unsafe

public Integer getUpdates_unsafe()

Retrieves the Updates value, without locking, for this Contact Persistent. see org.melati.poem.prepro.FieldDef#generateBaseMethods

Returns:

the Integer updates

setUpdates_unsafe

public void setUpdates_unsafe(Integer cooked)

Sets the Updates value directly, without checking, for this Contact Persistent. see org.melati.poem.prepro.FieldDef#generateBaseMethods

Parameters:

cooked - the pre-validated value to set

getUpdates

public Integer getUpdates()
                   throws org.melati.poem.AccessPoemException

Retrieves the Updates value, with locking, for this Contact Persistent. Field description: How many times has this record been updated? Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods

Returns:

the value of the field Updates for this Contact Persistent

Throws:

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

setUpdates

public void setUpdates(Integer cooked)
                throws org.melati.poem.AccessPoemException,
                       org.melati.poem.ValidationPoemException

Sets the Updates value, with checking, for this Contact Persistent. Field description: How many times has this record been updated? Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods

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

setUpdates

public final void setUpdates(int cooked)
                      throws org.melati.poem.AccessPoemException,
                             org.melati.poem.ValidationPoemException

Sets the Updates value, with checking, for this Contact Persistent. Field description: How many times has this record been updated? Generated by org.melati.poem.prepro.IntegerFieldDef#generateBaseMethods

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

getUpdatesField

public org.melati.poem.Field<Integer> getUpdatesField()
                                               throws org.melati.poem.AccessPoemException

Retrieves the Updates value as a Field from this Contact Persistent. see org.melati.poem.prepro.FieldDef#generateFieldCreator

Returns:

the Integer updates

Throws:

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

getLastupdated_unsafe

public Date getLastupdated_unsafe()

Retrieves the Lastupdated value, without locking, for this Contact Persistent. see org.melati.poem.prepro.FieldDef#generateBaseMethods

Returns:

the Date lastupdated

setLastupdated_unsafe

public void setLastupdated_unsafe(Date cooked)

Sets the Lastupdated value directly, without checking, for this Contact Persistent. see org.melati.poem.prepro.FieldDef#generateBaseMethods

Parameters:

cooked - the pre-validated value to set

getLastupdated

public Date getLastupdated()
                    throws org.melati.poem.AccessPoemException

Retrieves the Lastupdated value, with locking, for this Contact Persistent. Field description: When was this last updated? Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods

Returns:

the value of the field Lastupdated for this Contact Persistent

Throws:

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

setLastupdated

public void setLastupdated(Date cooked)
                    throws org.melati.poem.AccessPoemException,
                           org.melati.poem.ValidationPoemException

Sets the Lastupdated value, with checking, for this Contact Persistent. Field description: When was this last updated? Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods

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

getLastupdatedField

public org.melati.poem.Field<Date> getLastupdatedField()
                                                throws org.melati.poem.AccessPoemException

Retrieves the Lastupdated value as a Field from this Contact Persistent. see org.melati.poem.prepro.FieldDef#generateFieldCreator

Returns:

the Date lastupdated

Throws:

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

getLastupdateuser_unsafe

public Integer getLastupdateuser_unsafe()

Retrieves the Lastupdateuser value, without locking, for this Contact Persistent. see org.melati.poem.prepro.FieldDef#generateBaseMethods

Returns:

the Integer lastupdateuser

setLastupdateuser_unsafe

public void setLastupdateuser_unsafe(Integer cooked)

Sets the Lastupdateuser value directly, without checking, for this Contact Persistent. see org.melati.poem.prepro.FieldDef#generateBaseMethods

Parameters:

cooked - the pre-validated value to set

getLastupdateuserTroid

public Integer getLastupdateuserTroid()
                               throws org.melati.poem.AccessPoemException

Retrieves the Table Row Object ID. Generated by org.melati.poem.prepro.ReferenceFieldDef#generateBaseMethods

Returns:

the TROID as an Integer

Throws:

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

setLastupdateuserTroid

public void setLastupdateuserTroid(Integer raw)
                            throws org.melati.poem.AccessPoemException

Sets the Table Row Object ID. Generated by org.melati.poem.prepro.ReferenceFieldDef#generateBaseMethods

Parameters:

raw - a Table Row Object Id

Throws:

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

getLastupdateuser

public org.melati.poem.User getLastupdateuser()
                                       throws org.melati.poem.AccessPoemException,
                                              org.melati.poem.NoSuchRowPoemException

Retrieves the Lastupdateuser object referred to. Generated by org.melati.poem.prepro.ReferenceFieldDef#generateBaseMethods

Returns:

the Lastupdateuser as a User

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

setLastupdateuser

public void setLastupdateuser(org.melati.poem.User cooked)
                       throws org.melati.poem.AccessPoemException

Set the Lastupdateuser. Generated by org.melati.poem.prepro.ReferenceFieldDef#generateBaseMethods

Parameters:

cooked - a validated User

Throws:

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

getLastupdateuserField

public org.melati.poem.Field<Integer> getLastupdateuserField()
                                                      throws org.melati.poem.AccessPoemException

Retrieves the Lastupdateuser value as a Field from this Contact Persistent. see org.melati.poem.prepro.FieldDef#generateFieldCreator

Returns:

the Integer lastupdateuser

Throws:

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

getOwnerContacts

public Enumeration<Contact> getOwnerContacts()

References to this Contact in the Contact table via its owner field.

getOwnerContactList

public List<Contact> getOwnerContactList()

References to this Contact in the Contact table via its owner field, as a List.

getContactContactCategorys

public Enumeration<ContactCategory> getContactContactCategorys()

References to this Contact in the ContactCategory table via its contact field.

getContactContactCategoryList

public List<ContactCategory> getContactContactCategoryList()

References to this Contact in the ContactCategory table via its contact field, as a List.