jobmatch.data
Class MailQueueBDO

java.lang.Object
  |
  +--jobmatch.data.MailQueueBDO

public class MailQueueBDO

extends Object

implements Serializable

MailQueueBDO contains the same set and get methods as the MailQueueDO class. Business Object (BO) classes typically need these set and get methods. So by deriving a BO from a BDO, or by implementing a BO that contains a BDO, the developer of the BO is spared some work.

Version:

$Revision: 1.5 $

See Also:

Serialized Form

Field Summary

protected MailQueueDO

DO The MailQueueDO object upon which the set and get methods operate.

Constructor Summary

MailQueueBDO()
Constructor required by MailQueueBDO.create methods.

MailQueueBDO(MailQueueDO DO)
Constructor for use by classes derived from MailQueueBDO.

Method Summary

protected void	afterAnySet()
protected void	beforeAnyGet() The developer of a Business Object that derives from this class can override the methods: beforeAnyGet beforeAnySet afterAnySet to handle any general assertions or cleanup needed for get and set methods.
protected void	beforeAnySet()
void	commit() Inserts/Updates the DO into its table.
void	commit(jobmatch.data.DBTransaction dbt) Inserts/Updates the DO into its table.
static MailQueueBDO	createExisting(MailQueueDO DO) The createExisting method is used to create a MailQueueBDO from a MailQueueDO that was returned by the MailQueueQuery class.
static MailQueueBDO	createVirgin() Like the class MailQueueDO, this class acts as a factory.
void	delete() Deletes the DO from its table.
void	delete(jobmatch.data.DBTransaction dbt) Deletes the DO from its table.
static MailQueueBDO[]	getBDOarray() The getBDOarray method performs a database query to return an array of MailQueueBDO objects representing all the rows in the MailQueue table.
MailQueueDO	getDO() Note: This method is intended for use only by other BDO classes.
String	getHandle() The methods getHandle hasMatchingHandle are used by Presentation Objects that need to populate HTML select lists with MailQueueBDO objects as options.
byte[]	getMail() Get Mail of the MailQueueDO
int	getPriority() Get Priority of the MailQueueDO
Timestamp	getTime() Get Time of the MailQueueDO
boolean	hasMatchingHandle(String handle)
protected void	modifyDO(jobmatch.data.DBTransaction dbt, boolean delete) Modifies the DO within its table.
void	setMail(byte[] Mail) Set Mail of the MailQueueDO
void	setPriority(int Priority) Set Priority of the MailQueueDO
void	setTime(Timestamp Time) Set Time of the MailQueueDO
String	toString() for debugging

Methods inherited from class java.lang.Object

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

Field Detail

DO

protected MailQueueDO DO

The MailQueueDO object upon which the set and get methods operate. This member is protected so that classes derived from MailQueueBDO can access the underlying Data Object.

Constructor Detail

MailQueueBDO

public MailQueueBDO(MailQueueDO DO)

Constructor for use by classes derived from MailQueueBDO. Example usage: class CustomerBO extends CustomerBDO { // a BDO class is commonly extended in order to implement: public void beforeAnySet() throws Exception { if ( CustomerDO should not be altered ) throw new ApplicationException( "ERROR" ); } public CustomerBO( CustomerDO DO ) { super( DO ); } } class SomePresentationLayerClass { public CustomerBO findCustomer( String name ) { CustomerQuery q = new CustomerQuery(); q.setQueryName( name ); CustomerDO DO = q.getNextDO(); // Here the CustomerBO ctor fires the CustomerBDO ctor. return new CustomerBO( DO ); } }

MailQueueBDO

public MailQueueBDO()
             throws Exception

Constructor required by MailQueueBDO.create methods.

Method Detail

getDO

public MailQueueDO getDO()

Note: This method is intended for use only by other BDO classes. Presentation Layer classes should (theoretically) always use the Business Layer (BDO) to create/access Data Layer (DO) objects. The overhead for using BDO objects is small (the BDO classes are fairly lightweight.)

Returns:

The DO object held by this BDO object.

createVirgin

public static MailQueueBDO createVirgin()
                                 throws Exception

Like the class MailQueueDO, this class acts as a factory. Business Object (BO) classes typically need these set and get methods. So by deriving a BO from a BDO, or by implementing a BO that contains one or more BDOs, the developer of the BO is spared some work.

Throws:

Exception - If an error occurs.

createExisting

public static MailQueueBDO createExisting(MailQueueDO DO)

The createExisting method is used to create a MailQueueBDO from a MailQueueDO that was returned by the MailQueueQuery class.

getBDOarray

public static MailQueueBDO[] getBDOarray()
                                  throws jobmatch.data.DataObjectException

The getBDOarray method performs a database query to return an array of MailQueueBDO objects representing all the rows in the MailQueue table. This method is a minimal example of using a Query class. To restrict the set of objects returned, you could invoke query.setXxx(), where Xxx is an Attribute of MailQueueDO which was marked as "Can be queried" in the DODS Attribute Editor.

Throws:

jobmatch.data.DataObjectException - If an object is not found in the database.

beforeAnyGet

protected void beforeAnyGet()

The developer of a Business Object that derives from this class can override the methods: beforeAnyGet beforeAnySet afterAnySet to handle any general assertions or cleanup needed for get and set methods.

beforeAnySet

protected void beforeAnySet()
                     throws Exception

afterAnySet

protected void afterAnySet()

getHandle

public String getHandle()
                 throws jobmatch.data.DatabaseManagerException

The methods getHandle hasMatchingHandle are used by Presentation Objects that need to populate HTML select lists with MailQueueBDO objects as options. The getHandle() method is used to set the value for each option, and the hasMatchingHandle() methods are used to lookup the Data Object when the selection has been made. This MailQueueBDO object holds a reference to a MailQueueDO object. The id of this MailQueueBDO is the id of its MailQueueDO.

Returns:

id of this BDO as a string If an object id can't be allocated for this object.

Throws:

jobmatch.data.DatabaseManagerException - If a connection to the database cannot be established, etc.

hasMatchingHandle

public boolean hasMatchingHandle(String handle)

Parameters:

handle - String representation of the id for this BDO

Returns:

boolean True if the string version of the id of this DO matches passed handle

See Also:

getHandle

toString

public String toString()

for debugging

Overrides:

toString in class Object

getTime

public Timestamp getTime()
                  throws jobmatch.data.DataObjectException

Get Time of the MailQueueDO

Returns:

Time of the MailQueueDO

Throws:

jobmatch.data.DataObjectException - If the object is not found in the database.

setTime

public void setTime(Timestamp Time)
             throws jobmatch.data.DataObjectException

Set Time of the MailQueueDO

Parameters:

Time - of the MailQueueDO

Throws:

jobmatch.data.DataObjectException - If the object is not found in the database.

getMail

public byte[] getMail()
               throws jobmatch.data.DataObjectException

Get Mail of the MailQueueDO

Returns:

Mail of the MailQueueDO

Throws:

jobmatch.data.DataObjectException - If the object is not found in the database.

setMail

public void setMail(byte[] Mail)
             throws jobmatch.data.DataObjectException

Set Mail of the MailQueueDO

Parameters:

Mail - of the MailQueueDO

Throws:

jobmatch.data.DataObjectException - If the object is not found in the database.

getPriority

public int getPriority()
                throws jobmatch.data.DataObjectException

Get Priority of the MailQueueDO

Returns:

Priority of the MailQueueDO

Throws:

jobmatch.data.DataObjectException - If the object is not found in the database.

setPriority

public void setPriority(int Priority)
                 throws jobmatch.data.DataObjectException

Set Priority of the MailQueueDO

Parameters:

Priority - of the MailQueueDO

Throws:

jobmatch.data.DataObjectException - If the object is not found in the database.

commit

public void commit()
            throws SQLException,
                   jobmatch.data.DatabaseManagerException,
                   jobmatch.data.DataObjectException,
                   jobmatch.data.RefAssertionException,
                   jobmatch.data.DBRowUpdateException,
                   jobmatch.data.QueryException

Inserts/Updates the DO into its table.

Throws:

com.lutris.appserver.server.sql.DatabaseManagerException - if a Transaction can not be created.

jobmatch.data.RefAssertionException - thrown by okTo method.

SQLException - if any SQL errors occur.

commit

public void commit(jobmatch.data.DBTransaction dbt)
            throws SQLException,
                   jobmatch.data.DatabaseManagerException,
                   jobmatch.data.DataObjectException,
                   jobmatch.data.RefAssertionException,
                   jobmatch.data.DBRowUpdateException,
                   jobmatch.data.QueryException

Inserts/Updates the DO into its table. The transaction is likely provided by the commit() method of another BDO whose DO references this DO.

Parameters:

dbt - The transaction object to use for this operation.

Throws:

com.lutris.appserver.server.sql.DatabaseManagerException - if a Transaction can not be created.

jobmatch.data.RefAssertionException - thrown by okTo method.

SQLException - if any SQL errors occur.

delete

public void delete()
            throws SQLException,
                   jobmatch.data.DatabaseManagerException,
                   jobmatch.data.DataObjectException,
                   jobmatch.data.RefAssertionException,
                   jobmatch.data.DBRowUpdateException,
                   jobmatch.data.QueryException

Deletes the DO from its table.

Throws:

com.lutris.appserver.server.sql.DatabaseManagerException - if a Transaction can not be created.

jobmatch.data.RefAssertionException - thrown by okTo method.

SQLException - if any SQL errors occur.

delete

public void delete(jobmatch.data.DBTransaction dbt)
            throws SQLException,
                   jobmatch.data.DatabaseManagerException,
                   jobmatch.data.DataObjectException,
                   jobmatch.data.RefAssertionException,
                   jobmatch.data.DBRowUpdateException,
                   jobmatch.data.QueryException

Deletes the DO from its table. The transaction is likely provided by the delete() method of another BDO whose DO references this DO.

Parameters:

dbt - The transaction object to use for this operation.

Throws:

com.lutris.appserver.server.sql.DatabaseManagerException - if a Transaction can not be created.

jobmatch.data.RefAssertionException - thrown by okTo method.

SQLException - if any SQL errors occur.

modifyDO

protected void modifyDO(jobmatch.data.DBTransaction dbt,
                        boolean delete)
                 throws SQLException,
                        jobmatch.data.DatabaseManagerException,
                        jobmatch.data.DataObjectException,
                        jobmatch.data.RefAssertionException,
                        jobmatch.data.DBRowUpdateException,
                        jobmatch.data.QueryException

Modifies the DO within its table. Performs recursive commit/delete on referenced DOs; all operations occur within a single transaction to allow rollback in the event of error. Only the creator of the transaction releases it.

Parameters:

dbt - The transaction object to use for this operation.

delete - True if doing a delete, otherwise doing insert/update.

Throws:

com.lutris.appserver.server.sql.DatabaseManagerException - if a Transaction can not be created.

jobmatch.data.RefAssertionException - thrown by okTo method.

SQLException - if any SQL errors occur.