org.paneris.rimauresq.model.generated
Class UserBase

java.lang.Object
  org.melati.poem.transaction.Transactioned
      org.melati.poem.JdbcPersistent
          org.melati.poem.generated.UserBase
              org.melati.poem.User
                  org.paneris.rimauresq.model.generated.UserBase

All Implemented Interfaces:

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

Direct Known Subclasses:

User

public abstract class UserBase
extends org.melati.poem.User

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

Field Summary

protected java.lang.String	address Address
protected java.lang.String	country Country
protected java.lang.String	email email - The user's email address
protected java.lang.String	fax fax - User's fax number
protected java.lang.String	mobile Mobile - User's mobile number
protected java.lang.Boolean	news Receive Newsletter? - Does the user want to receive the email newsletter?
protected java.lang.String	postcode Postcode - Order postcode
protected java.lang.String	tel Telephone - User's telephone number
protected java.lang.String	title Title - User's title or role
protected java.lang.String	town Town / City

Fields inherited from class org.melati.poem.generated.UserBase

id, login, name, password

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

valid

Fields inherited from interface org.melati.poem.AccessToken

root

Constructor Summary

UserBase()

Method Summary

java.lang.String	getAddress_unsafe() Retrieves the Address value, without locking, for this User Persistent.
java.lang.String	getAddress() Retrieves the Address value, with locking, for this User Persistent.
org.melati.poem.Field	getAddressField() Retrieves the Address value as a Field from this User Persistent.
java.lang.String	getCountry_unsafe() Retrieves the Country value, without locking, for this User Persistent.
java.lang.String	getCountry() Retrieves the Country value, with locking, for this User Persistent.
org.melati.poem.Field	getCountryField() Retrieves the Country value as a Field from this User Persistent.
java.lang.String	getEmail_unsafe() Retrieves the Email value, without locking, for this User Persistent.
java.lang.String	getEmail() Retrieves the Email value, with locking, for this User Persistent.
org.melati.poem.Field	getEmailField() Retrieves the Email value as a Field from this User Persistent.
java.lang.String	getFax_unsafe() Retrieves the Fax value, without locking, for this User Persistent.
java.lang.String	getFax() Retrieves the Fax value, with locking, for this User Persistent.
org.melati.poem.Field	getFaxField() Retrieves the Fax value as a Field from this User Persistent.
java.lang.String	getMobile_unsafe() Retrieves the Mobile value, without locking, for this User Persistent.
java.lang.String	getMobile() Retrieves the Mobile value, with locking, for this User Persistent.
org.melati.poem.Field	getMobileField() Retrieves the Mobile value as a Field from this User Persistent.
java.lang.Boolean	getNews_unsafe() Retrieves the News value, without locking, for this User Persistent.
java.lang.Boolean	getNews() Retrieves the News value, with locking, for this User Persistent.
org.melati.poem.Field	getNewsField() Retrieves the News value as a Field from this User Persistent.
java.lang.String	getPostcode_unsafe() Retrieves the Postcode value, without locking, for this User Persistent.
java.lang.String	getPostcode() Retrieves the Postcode value, with locking, for this User Persistent.
org.melati.poem.Field	getPostcodeField() Retrieves the Postcode value as a Field from this User Persistent.
RimauresqDatabaseTables	getRimauresqDatabaseTables() Retrieves the Database object.
java.lang.String	getTel_unsafe() Retrieves the Tel value, without locking, for this User Persistent.
java.lang.String	getTel() Retrieves the Tel value, with locking, for this User Persistent.
org.melati.poem.Field	getTelField() Retrieves the Tel value as a Field from this User Persistent.
java.lang.String	getTitle_unsafe() Retrieves the Title value, without locking, for this User Persistent.
java.lang.String	getTitle() Retrieves the Title value, with locking, for this User Persistent.
org.melati.poem.Field	getTitleField() Retrieves the Title value as a Field from this User Persistent.
java.lang.String	getTown_unsafe() Retrieves the Town value, without locking, for this User Persistent.
java.lang.String	getTown() Retrieves the Town value, with locking, for this User Persistent.
org.melati.poem.Field	getTownField() Retrieves the Town value as a Field from this User Persistent.
org.melati.poem.UserTable	getUserTable() Retrieves the UserTable table which this Persistent is from.
void	setAddress_unsafe(java.lang.String cooked) Sets the Address value directly, without checking, for this User Persistent.
void	setAddress(java.lang.String cooked) Sets the Address value, with checking, for this User Persistent.
void	setCountry_unsafe(java.lang.String cooked) Sets the Country value directly, without checking, for this User Persistent.
void	setCountry(java.lang.String cooked) Sets the Country value, with checking, for this User Persistent.
void	setEmail_unsafe(java.lang.String cooked) Sets the Email value directly, without checking, for this User Persistent.
void	setEmail(java.lang.String cooked) Sets the Email value, with checking, for this User Persistent.
void	setFax_unsafe(java.lang.String cooked) Sets the Fax value directly, without checking, for this User Persistent.
void	setFax(java.lang.String cooked) Sets the Fax value, with checking, for this User Persistent.
void	setMobile_unsafe(java.lang.String cooked) Sets the Mobile value directly, without checking, for this User Persistent.
void	setMobile(java.lang.String cooked) Sets the Mobile value, with checking, for this User Persistent.
void	setNews_unsafe(java.lang.Boolean cooked) Sets the News value directly, without checking, for this User Persistent.
void	setNews(boolean cooked) Sets the News value, with checking, from a boolean, for this User Persistent.
void	setNews(java.lang.Boolean cooked) Sets the News value, with checking, for this User Persistent.
void	setPostcode_unsafe(java.lang.String cooked) Sets the Postcode value directly, without checking, for this User Persistent.
void	setPostcode(java.lang.String cooked) Sets the Postcode value, with checking, for this User Persistent.
void	setTel_unsafe(java.lang.String cooked) Sets the Tel value directly, without checking, for this User Persistent.
void	setTel(java.lang.String cooked) Sets the Tel value, with checking, for this User Persistent.
void	setTitle_unsafe(java.lang.String cooked) Sets the Title value directly, without checking, for this User Persistent.
void	setTitle(java.lang.String cooked) Sets the Title value, with checking, for this User Persistent.
void	setTown_unsafe(java.lang.String cooked) Sets the Town value directly, without checking, for this User Persistent.
void	setTown(java.lang.String cooked) Sets the Town value, with checking, for this User Persistent.

Methods inherited from class org.melati.poem.User

getPassword, givesCapability, isAdministrator, isGuest, setPassword, toString

Methods inherited from class org.melati.poem.generated.UserBase

getId_unsafe, getId, getIdField, getLogin_unsafe, getLogin, getLoginField, getName_unsafe, getName, getNameField, getPassword_unsafe, getPasswordField, getPoemDatabaseTables, setId_unsafe, setId, setId, setLogin_unsafe, setLogin, setName_unsafe, setName, setPassword_unsafe

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, 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

email

protected java.lang.String email

email - The user's email address

title

protected java.lang.String title

Title - User's title or role

address

protected java.lang.String address

Address

town

protected java.lang.String town

Town / City

postcode

protected java.lang.String postcode

Postcode - Order postcode

country

protected java.lang.String country

Country

tel

protected java.lang.String tel

Telephone - User's telephone number

fax

protected java.lang.String fax

fax - User's fax number

mobile

protected java.lang.String mobile

Mobile - User's mobile number

news

protected java.lang.Boolean news

Receive Newsletter? - Does the user want to receive the email newsletter?

Constructor Detail

UserBase

public UserBase()

Method Detail

getRimauresqDatabaseTables

public RimauresqDatabaseTables getRimauresqDatabaseTables()

Retrieves the Database object.

Returns:

the database

getUserTable

public org.melati.poem.UserTable getUserTable()

Retrieves the UserTable table which this Persistent is from.

Overrides:

getUserTable in class org.melati.poem.generated.UserBase

Returns:

the org.melati.poem.UserTable

getEmail_unsafe

public java.lang.String getEmail_unsafe()

Retrieves the Email value, without locking, for this User Persistent.

Returns:

the String email

setEmail_unsafe

public void setEmail_unsafe(java.lang.String cooked)

Sets the Email value directly, without checking, for this User Persistent.

Parameters:

cooked - the pre-validated value to set

getEmail

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

Retrieves the Email value, with locking, for this User Persistent. Field description: The user's email address

Returns:

the value of the field Email for this User Persistent

Throws:

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

setEmail

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

Sets the Email value, with checking, for this User Persistent. Field description: The user's email address

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

getEmailField

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

Retrieves the Email value as a Field from this User Persistent.

Returns:

the String email

Throws:

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

getTitle_unsafe

public java.lang.String getTitle_unsafe()

Retrieves the Title value, without locking, for this User Persistent.

Returns:

the String title

setTitle_unsafe

public void setTitle_unsafe(java.lang.String cooked)

Sets the Title value directly, without checking, for this User Persistent.

Parameters:

cooked - the pre-validated value to set

getTitle

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

Retrieves the Title value, with locking, for this User Persistent. Field description: User's title or role

Returns:

the value of the field Title for this User Persistent

Throws:

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

setTitle

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

Sets the Title value, with checking, for this User Persistent. Field description: User's title or role

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

getTitleField

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

Retrieves the Title value as a Field from this User Persistent.

Returns:

the String title

Throws:

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

getAddress_unsafe

public java.lang.String getAddress_unsafe()

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

Returns:

the String address

setAddress_unsafe

public void setAddress_unsafe(java.lang.String cooked)

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

Parameters:

cooked - the pre-validated value to set

getAddress

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

Retrieves the Address value, with locking, for this User Persistent.

Returns:

the value of the field Address for this User Persistent

Throws:

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

setAddress

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

Sets the Address value, with checking, for this User Persistent.

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 getAddressField()
                                      throws org.melati.poem.AccessPoemException

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

Returns:

the String address

Throws:

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

getTown_unsafe

public java.lang.String getTown_unsafe()

Retrieves the Town value, without locking, for this User Persistent.

Returns:

the String town

setTown_unsafe

public void setTown_unsafe(java.lang.String cooked)

Sets the Town value directly, without checking, for this User Persistent.

Parameters:

cooked - the pre-validated value to set

getTown

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

Retrieves the Town value, with locking, for this User Persistent.

Returns:

the value of the field Town for this User Persistent

Throws:

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

setTown

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

Sets the Town value, with checking, for this User Persistent.

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

getTownField

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

Retrieves the Town value as a Field from this User Persistent.

Returns:

the String town

Throws:

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

getPostcode_unsafe

public java.lang.String getPostcode_unsafe()

Retrieves the Postcode value, without locking, for this User Persistent.

Returns:

the String postcode

setPostcode_unsafe

public void setPostcode_unsafe(java.lang.String cooked)

Sets the Postcode value directly, without checking, for this User Persistent.

Parameters:

cooked - the pre-validated value to set

getPostcode

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

Retrieves the Postcode value, with locking, for this User Persistent. Field description: Order postcode

Returns:

the value of the field Postcode for this User Persistent

Throws:

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

setPostcode

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

Sets the Postcode value, with checking, for this User Persistent. Field description: Order postcode

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

getPostcodeField

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

Retrieves the Postcode value as a Field from this User Persistent.

Returns:

the String postcode

Throws:

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

getCountry_unsafe

public java.lang.String getCountry_unsafe()

Retrieves the Country value, without locking, for this User Persistent.

Returns:

the String country

setCountry_unsafe

public void setCountry_unsafe(java.lang.String cooked)

Sets the Country value directly, without checking, for this User Persistent.

Parameters:

cooked - the pre-validated value to set

getCountry

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

Retrieves the Country value, with locking, for this User Persistent.

Returns:

the value of the field Country for this User Persistent

Throws:

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

setCountry

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

Sets the Country value, with checking, for this User Persistent.

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

getCountryField

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

Retrieves the Country value as a Field from this User Persistent.

Returns:

the String country

Throws:

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

getTel_unsafe

public java.lang.String getTel_unsafe()

Retrieves the Tel value, without locking, for this User Persistent.

Returns:

the String tel

setTel_unsafe

public void setTel_unsafe(java.lang.String cooked)

Sets the Tel value directly, without checking, for this User Persistent.

Parameters:

cooked - the pre-validated value to set

getTel

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

Retrieves the Tel value, with locking, for this User Persistent. Field description: User's telephone number

Returns:

the value of the field Tel for this User Persistent

Throws:

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

setTel

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

Sets the Tel value, with checking, for this User Persistent. Field description: User's telephone number

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

getTelField

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

Retrieves the Tel value as a Field from this User Persistent.

Returns:

the String tel

Throws:

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

getFax_unsafe

public java.lang.String getFax_unsafe()

Retrieves the Fax value, without locking, for this User Persistent.

Returns:

the String fax

setFax_unsafe

public void setFax_unsafe(java.lang.String cooked)

Sets the Fax value directly, without checking, for this User Persistent.

Parameters:

cooked - the pre-validated value to set

getFax

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

Retrieves the Fax value, with locking, for this User Persistent. Field description: User's fax number

Returns:

the value of the field Fax for this User Persistent

Throws:

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

setFax

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

Sets the Fax value, with checking, for this User Persistent. Field description: User's fax number

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

getFaxField

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

Retrieves the Fax value as a Field from this User Persistent.

Returns:

the String fax

Throws:

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

getMobile_unsafe

public java.lang.String getMobile_unsafe()

Retrieves the Mobile value, without locking, for this User Persistent.

Returns:

the String mobile

setMobile_unsafe

public void setMobile_unsafe(java.lang.String cooked)

Sets the Mobile value directly, without checking, for this User Persistent.

Parameters:

cooked - the pre-validated value to set

getMobile

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

Retrieves the Mobile value, with locking, for this User Persistent. Field description: User's mobile number

Returns:

the value of the field Mobile for this User Persistent

Throws:

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

setMobile

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

Sets the Mobile value, with checking, for this User Persistent. Field description: User's mobile number

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

getMobileField

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

Retrieves the Mobile value as a Field from this User Persistent.

Returns:

the String mobile

Throws:

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

getNews_unsafe

public java.lang.Boolean getNews_unsafe()

Retrieves the News value, without locking, for this User Persistent.

Returns:

the Boolean news

setNews_unsafe

public void setNews_unsafe(java.lang.Boolean cooked)

Sets the News value directly, without checking, for this User Persistent.

Parameters:

cooked - the pre-validated value to set

getNews

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

Retrieves the News value, with locking, for this User Persistent. Field description: Does the user want to receive the email newsletter?

Returns:

the value of the field News for this User Persistent

Throws:

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

setNews

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

Sets the News value, with checking, for this User Persistent. Field description: Does the user want to receive the email newsletter?

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

setNews

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

Sets the News value, with checking, from a boolean, for this User Persistent. Field description: Does the user want to receive the email newsletter?

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

getNewsField

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

Retrieves the News value as a Field from this User Persistent.

Returns:

the Boolean news

Throws:

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