org.apache.jetspeed.om.apps.email
Class BaseEmailInboxPeer

java.lang.Object
  |
  +--org.apache.torque.util.BasePeer
        |
        +--org.apache.jetspeed.om.apps.email.BaseEmailInboxPeer

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

EmailInboxPeer

public abstract class BaseEmailInboxPeer

extends org.apache.torque.util.BasePeer

This class was autogenerated by Torque on: [Thu Apr 22 23:12:36 EDT 2004]

See Also:

Serialized Form

Field Summary

static java.lang.String	ATTACHMENT the column name for the ATTACHMENT field
protected static java.lang.Class	CLASS_DEFAULT A class that can be returned by this peer.
protected static java.lang.String	CLASSNAME_DEFAULT A class that can be returned by this peer.
static java.lang.String	DATABASE_NAME the default database name for this class
static java.lang.String	EMAIL_INBOX_ID the column name for the EMAIL_INBOX_ID field
static java.lang.String	FILENAME the column name for the FILENAME field
static java.lang.String	MESSAGE_ID the column name for the MESSAGE_ID field
static int	numColumns number of columns for this peer
static java.lang.String	READFLAG the column name for the READFLAG field
static java.lang.String	TABLE_NAME the table name for this class

Fields inherited from class org.apache.torque.util.BasePeer

DEFAULT_MAP_BUILDER, IGNORE_CASE, log, ORDER_BY

Constructor Summary

BaseEmailInboxPeer()

Method Summary

static void	addSelectColumns(org.apache.torque.util.Criteria criteria) Add all the columns needed to create a new object.
static org.apache.torque.util.Criteria	buildCriteria(org.apache.jetspeed.om.apps.email.EmailInbox obj) Build a Criteria object from the data object for this peer
static org.apache.torque.util.Criteria	buildCriteria(org.apache.torque.om.ObjectKey pk) Build a Criteria object from an ObjectKey
static void	doDelete(org.apache.torque.util.Criteria criteria) Method to do deletes.
static void	doDelete(org.apache.torque.util.Criteria criteria, java.sql.Connection con) Method to do deletes.
static void	doDelete(org.apache.jetspeed.om.apps.email.EmailInbox obj)
static void	doDelete(org.apache.jetspeed.om.apps.email.EmailInbox obj, java.sql.Connection con) Method to delete.
static void	doDelete(org.apache.torque.om.ObjectKey pk) Method to do deletes.
static void	doDelete(org.apache.torque.om.ObjectKey pk, java.sql.Connection con) Method to delete.
static org.apache.torque.om.ObjectKey	doInsert(org.apache.torque.util.Criteria criteria) Method to do inserts.
static org.apache.torque.om.ObjectKey	doInsert(org.apache.torque.util.Criteria criteria, java.sql.Connection con) Method to do inserts.
static void	doInsert(org.apache.jetspeed.om.apps.email.EmailInbox obj) Method to do inserts
static void	doInsert(org.apache.jetspeed.om.apps.email.EmailInbox obj, java.sql.Connection con) Method to do inserts.
static java.util.List	doSelect(org.apache.torque.util.Criteria criteria) Method to do selects.
static java.util.List	doSelect(org.apache.torque.util.Criteria criteria, java.sql.Connection con) Method to do selects within a transaction.
static java.util.List	doSelect(org.apache.jetspeed.om.apps.email.EmailInbox obj) Method to do selects
static java.util.List	doSelectVillageRecords(org.apache.torque.util.Criteria criteria) Grabs the raw Village records to be formed into objects.
static java.util.List	doSelectVillageRecords(org.apache.torque.util.Criteria criteria, java.sql.Connection con) Grabs the raw Village records to be formed into objects.
static void	doUpdate(org.apache.torque.util.Criteria criteria) Method to do updates.
static void	doUpdate(org.apache.torque.util.Criteria criteria, java.sql.Connection con) Method to do updates.
static void	doUpdate(org.apache.jetspeed.om.apps.email.EmailInbox obj)
static void	doUpdate(org.apache.jetspeed.om.apps.email.EmailInbox obj, java.sql.Connection con) Method to do update.
static org.apache.torque.map.MapBuilder	getMapBuilder()
static java.lang.Class	getOMClass() The class that the Peer will make instances of.
protected static org.apache.torque.map.TableMap	getTableMap() Returns the TableMap related to this peer.
static void	populateObject(com.workingdogs.village.Record row, int offset, org.apache.jetspeed.om.apps.email.EmailInbox obj) Populates an object from a resultset row starting from a specified offset.
static java.util.List	populateObjects(java.util.List records) The returned List will contain objects of the default type or objects that inherit from the default.
static java.util.List	resultSet2Objects(java.sql.ResultSet results) Get the list of objects for a ResultSet.
static org.apache.jetspeed.om.apps.email.EmailInbox	retrieveByPK(int pk) Retrieve a single object by pk
static org.apache.jetspeed.om.apps.email.EmailInbox	retrieveByPK(org.apache.torque.om.ObjectKey pk) Retrieve a single object by pk
static org.apache.jetspeed.om.apps.email.EmailInbox	retrieveByPK(org.apache.torque.om.ObjectKey pk, java.sql.Connection con) Retrieve a single object by pk
static java.util.List	retrieveByPKs(java.util.List pks) Retrieve a multiple objects by pk
static java.util.List	retrieveByPKs(java.util.List pks, java.sql.Connection dbcon) Retrieve a multiple objects by pk
static org.apache.jetspeed.om.apps.email.EmailInbox	row2Object(com.workingdogs.village.Record row, int offset, java.lang.Class cls) Create a new object of type cls from a resultset row starting from a specified offset.

Methods inherited from class org.apache.torque.util.BasePeer

createPreparedStatement, createQueryString, deleteAll, deleteAll, doPSSelect, doPSSelect, doUpdate, doUpdate, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, executeStatement, executeStatement, executeStatement, getMapBuilder, getSelectResults, getSelectResults, getSelectResults, getSelectResults, handleMultipleRecords, hashtableToByteArray, initColumnNames, initCriteriaKeys, initTableColumns, initTableSchema, initTableSchema

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DATABASE_NAME

public static final java.lang.String DATABASE_NAME

the default database name for this class

See Also:

Constant Field Values

TABLE_NAME

public static final java.lang.String TABLE_NAME

the table name for this class

See Also:

Constant Field Values

EMAIL_INBOX_ID

public static final java.lang.String EMAIL_INBOX_ID

the column name for the EMAIL_INBOX_ID field

MESSAGE_ID

public static final java.lang.String MESSAGE_ID

the column name for the MESSAGE_ID field

FILENAME

public static final java.lang.String FILENAME

the column name for the FILENAME field

ATTACHMENT

public static final java.lang.String ATTACHMENT

the column name for the ATTACHMENT field

READFLAG

public static final java.lang.String READFLAG

the column name for the READFLAG field

numColumns

public static final int numColumns

number of columns for this peer

See Also:

Constant Field Values

CLASSNAME_DEFAULT

protected static final java.lang.String CLASSNAME_DEFAULT

A class that can be returned by this peer.

See Also:

Constant Field Values

CLASS_DEFAULT

protected static final java.lang.Class CLASS_DEFAULT

A class that can be returned by this peer.

Constructor Detail

BaseEmailInboxPeer

public BaseEmailInboxPeer()

Method Detail

getMapBuilder

public static org.apache.torque.map.MapBuilder getMapBuilder()
                                                      throws org.apache.torque.TorqueException

Returns:

the map builder for this peer

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

resultSet2Objects

public static java.util.List resultSet2Objects(java.sql.ResultSet results)
                                        throws org.apache.torque.TorqueException

Get the list of objects for a ResultSet. Please not that your resultset MUST return columns in the right order. You can use getFieldNames() in BaseObject to get the correct sequence.

Parameters:

results - the ResultSet

Returns:

the list of objects

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doInsert

public static org.apache.torque.om.ObjectKey doInsert(org.apache.torque.util.Criteria criteria)
                                               throws org.apache.torque.TorqueException

Method to do inserts.

Parameters:

criteria - object used to create the INSERT statement.

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doInsert

public static org.apache.torque.om.ObjectKey doInsert(org.apache.torque.util.Criteria criteria,
                                                      java.sql.Connection con)
                                               throws org.apache.torque.TorqueException

Method to do inserts. This method is to be used during a transaction, otherwise use the doInsert(Criteria) method. It will take care of the connection details internally.

Parameters:

criteria - object used to create the INSERT statement.

con - the connection to use

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

addSelectColumns

public static void addSelectColumns(org.apache.torque.util.Criteria criteria)
                             throws org.apache.torque.TorqueException

Add all the columns needed to create a new object.

Parameters:

criteria - object containing the columns to add.

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

row2Object

public static org.apache.jetspeed.om.apps.email.EmailInbox row2Object(com.workingdogs.village.Record row,
                                                                      int offset,
                                                                      java.lang.Class cls)
                                                               throws org.apache.torque.TorqueException

Create a new object of type cls from a resultset row starting from a specified offset. This is done so that you can select other rows than just those needed for this object. You may for example want to create two objects from the same row.

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

populateObject

public static void populateObject(com.workingdogs.village.Record row,
                                  int offset,
                                  org.apache.jetspeed.om.apps.email.EmailInbox obj)
                           throws org.apache.torque.TorqueException

Populates an object from a resultset row starting from a specified offset. This is done so that you can select other rows than just those needed for this object. You may for example want to create two objects from the same row.

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doSelect

public static java.util.List doSelect(org.apache.torque.util.Criteria criteria)
                               throws org.apache.torque.TorqueException

Method to do selects.

Parameters:

criteria - object used to create the SELECT statement.

Returns:

List of selected Objects

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doSelect

public static java.util.List doSelect(org.apache.torque.util.Criteria criteria,
                                      java.sql.Connection con)
                               throws org.apache.torque.TorqueException

Method to do selects within a transaction.

Parameters:

criteria - object used to create the SELECT statement.

con - the connection to use

Returns:

List of selected Objects

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doSelectVillageRecords

public static java.util.List doSelectVillageRecords(org.apache.torque.util.Criteria criteria)
                                             throws org.apache.torque.TorqueException

Grabs the raw Village records to be formed into objects. This method handles connections internally. The Record objects returned by this method should be considered readonly. Do not alter the data and call save(), your results may vary, but are certainly likely to result in hard to track MT bugs.

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doSelectVillageRecords

public static java.util.List doSelectVillageRecords(org.apache.torque.util.Criteria criteria,
                                                    java.sql.Connection con)
                                             throws org.apache.torque.TorqueException

Grabs the raw Village records to be formed into objects. This method should be used for transactions

Parameters:

con - the connection to use

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

populateObjects

public static java.util.List populateObjects(java.util.List records)
                                      throws org.apache.torque.TorqueException

The returned List will contain objects of the default type or objects that inherit from the default.

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

getOMClass

public static java.lang.Class getOMClass()
                                  throws org.apache.torque.TorqueException

The class that the Peer will make instances of. If the BO is abstract then you must implement this method in the BO.

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doUpdate

public static void doUpdate(org.apache.torque.util.Criteria criteria)
                     throws org.apache.torque.TorqueException

Method to do updates.

Parameters:

criteria - object containing data that is used to create the UPDATE statement.

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doUpdate

public static void doUpdate(org.apache.torque.util.Criteria criteria,
                            java.sql.Connection con)
                     throws org.apache.torque.TorqueException

Method to do updates. This method is to be used during a transaction, otherwise use the doUpdate(Criteria) method. It will take care of the connection details internally.

Parameters:

criteria - object containing data that is used to create the UPDATE statement.

con - the connection to use

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doDelete

public static void doDelete(org.apache.torque.util.Criteria criteria)
                     throws org.apache.torque.TorqueException

Method to do deletes.

Parameters:

criteria - object containing data that is used DELETE from database.

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doDelete

public static void doDelete(org.apache.torque.util.Criteria criteria,
                            java.sql.Connection con)
                     throws org.apache.torque.TorqueException

Method to do deletes. This method is to be used during a transaction, otherwise use the doDelete(Criteria) method. It will take care of the connection details internally.

Parameters:

criteria - object containing data that is used DELETE from database.

con - the connection to use

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doSelect

public static java.util.List doSelect(org.apache.jetspeed.om.apps.email.EmailInbox obj)
                               throws org.apache.torque.TorqueException

Method to do selects

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doInsert

public static void doInsert(org.apache.jetspeed.om.apps.email.EmailInbox obj)
                     throws org.apache.torque.TorqueException

Method to do inserts

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doUpdate

public static void doUpdate(org.apache.jetspeed.om.apps.email.EmailInbox obj)
                     throws org.apache.torque.TorqueException

Parameters:

obj - the data object to update in the database.

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doDelete

public static void doDelete(org.apache.jetspeed.om.apps.email.EmailInbox obj)
                     throws org.apache.torque.TorqueException

Parameters:

obj - the data object to delete in the database.

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doInsert

public static void doInsert(org.apache.jetspeed.om.apps.email.EmailInbox obj,
                            java.sql.Connection con)
                     throws org.apache.torque.TorqueException

Method to do inserts. This method is to be used during a transaction, otherwise use the doInsert(EmailInbox) method. It will take care of the connection details internally.

Parameters:

obj - the data object to insert into the database.

con - the connection to use

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doUpdate

public static void doUpdate(org.apache.jetspeed.om.apps.email.EmailInbox obj,
                            java.sql.Connection con)
                     throws org.apache.torque.TorqueException

Method to do update. This method is to be used during a transaction, otherwise use the doUpdate(EmailInbox) method. It will take care of the connection details internally.

Parameters:

obj - the data object to update in the database.

con - the connection to use

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doDelete

public static void doDelete(org.apache.jetspeed.om.apps.email.EmailInbox obj,
                            java.sql.Connection con)
                     throws org.apache.torque.TorqueException

Method to delete. This method is to be used during a transaction, otherwise use the doDelete(EmailInbox) method. It will take care of the connection details internally.

Parameters:

obj - the data object to delete in the database.

con - the connection to use

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doDelete

public static void doDelete(org.apache.torque.om.ObjectKey pk)
                     throws org.apache.torque.TorqueException

Method to do deletes.

Parameters:

pk - ObjectKey that is used DELETE from database.

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doDelete

public static void doDelete(org.apache.torque.om.ObjectKey pk,
                            java.sql.Connection con)
                     throws org.apache.torque.TorqueException

Method to delete. This method is to be used during a transaction, otherwise use the doDelete(ObjectKey) method. It will take care of the connection details internally.

Parameters:

pk - the primary key for the object to delete in the database.

con - the connection to use

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

buildCriteria

public static org.apache.torque.util.Criteria buildCriteria(org.apache.torque.om.ObjectKey pk)

Build a Criteria object from an ObjectKey

buildCriteria

public static org.apache.torque.util.Criteria buildCriteria(org.apache.jetspeed.om.apps.email.EmailInbox obj)

Build a Criteria object from the data object for this peer

retrieveByPK

public static org.apache.jetspeed.om.apps.email.EmailInbox retrieveByPK(int pk)
                                                                 throws org.apache.torque.TorqueException,
                                                                        org.apache.torque.NoRowsException,
                                                                        org.apache.torque.TooManyRowsException

Retrieve a single object by pk

Parameters:

pk - the primary key

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

org.apache.torque.NoRowsException - Primary key was not found in database.

org.apache.torque.TooManyRowsException - Primary key was not found in database.

retrieveByPK

public static org.apache.jetspeed.om.apps.email.EmailInbox retrieveByPK(org.apache.torque.om.ObjectKey pk)
                                                                 throws org.apache.torque.TorqueException,
                                                                        org.apache.torque.NoRowsException,
                                                                        org.apache.torque.TooManyRowsException

Retrieve a single object by pk

Parameters:

pk - the primary key

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

org.apache.torque.NoRowsException - Primary key was not found in database.

org.apache.torque.TooManyRowsException - Primary key was not found in database.

retrieveByPK

public static org.apache.jetspeed.om.apps.email.EmailInbox retrieveByPK(org.apache.torque.om.ObjectKey pk,
                                                                        java.sql.Connection con)
                                                                 throws org.apache.torque.TorqueException,
                                                                        org.apache.torque.NoRowsException,
                                                                        org.apache.torque.TooManyRowsException

Retrieve a single object by pk

Parameters:

pk - the primary key

con - the connection to use

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

org.apache.torque.NoRowsException - Primary key was not found in database.

org.apache.torque.TooManyRowsException - Primary key was not found in database.

retrieveByPKs

public static java.util.List retrieveByPKs(java.util.List pks)
                                    throws org.apache.torque.TorqueException

Retrieve a multiple objects by pk

Parameters:

pks - List of primary keys

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

retrieveByPKs

public static java.util.List retrieveByPKs(java.util.List pks,
                                           java.sql.Connection dbcon)
                                    throws org.apache.torque.TorqueException

Retrieve a multiple objects by pk

Parameters:

pks - List of primary keys

dbcon - the connection to use

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

getTableMap

protected static org.apache.torque.map.TableMap getTableMap()
                                                     throws org.apache.torque.TorqueException

Returns the TableMap related to this peer. This method is not needed for general use but a specific application could have a need.

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.