jobmatch.data
Class HobbyBDO

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

Direct Known Subclasses:

Hobby

public class HobbyBDO

extends Object

implements Serializable

HobbyBDO contains the same set and get methods as the HobbyDO 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 HobbyDO

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

Constructor Summary

HobbyBDO()
Constructor required by HobbyBDO.create methods.

HobbyBDO(HobbyDO DO)
Constructor for use by classes derived from HobbyBDO.

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 HobbyBDO	createExisting(HobbyDO DO) The createExisting method is used to create a HobbyBDO from a HobbyDO that was returned by the HobbyQuery class.
static HobbyBDO	createVirgin() Like the class HobbyDO, 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 HobbyBDO[]	getBDOarray() The getBDOarray method performs a database query to return an array of HobbyBDO objects representing all the rows in the Hobby table.
CandidateDO	getCandidate() Get Candidate of the HobbyDO
CandidateBDO	getCandidateBDO() Get BDO-wrapped Candidate of the HobbyDO
String	getDescription() Get Description of the HobbyDO
HobbyDO	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 HobbyBDO objects as options.
int	getPriority() Get Priority of the HobbyDO
String	getTitle() Get Title of the HobbyDO
boolean	hasMatchingHandle(String handle)
protected void	modifyDO(jobmatch.data.DBTransaction dbt, boolean delete) Modifies the DO within its table.
protected void	okToCommitCandidate(CandidateDO member) A stub method for implementing pre-commit assertions for the Candidate data member.
protected void	okToDeleteCandidate(CandidateDO member) A stub method for implementing pre-delete assertions for the Candidate data member.
void	setCandidate(CandidateBDO Candidate) Set Candidate of the HobbyDO
void	setCandidate(CandidateDO Candidate) Set Candidate of the HobbyDO
void	setDescription(String Description) Set Description of the HobbyDO
void	setPriority(int Priority) Set Priority of the HobbyDO
void	setTitle(String Title) Set Title of the HobbyDO
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 HobbyDO DO

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

Constructor Detail

HobbyBDO

public HobbyBDO(HobbyDO DO)

Constructor for use by classes derived from HobbyBDO. 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 ); } }

HobbyBDO

public HobbyBDO()
         throws Exception

Constructor required by HobbyBDO.create methods.

Method Detail

getDO

public HobbyDO 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 HobbyBDO createVirgin()
                             throws Exception

Like the class HobbyDO, 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 HobbyBDO createExisting(HobbyDO DO)

The createExisting method is used to create a HobbyBDO from a HobbyDO that was returned by the HobbyQuery class.

getBDOarray

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

The getBDOarray method performs a database query to return an array of HobbyBDO objects representing all the rows in the Hobby 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 HobbyDO 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 HobbyBDO 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 HobbyBDO object holds a reference to a HobbyDO object. The id of this HobbyBDO is the id of its HobbyDO.

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

getCandidate

public CandidateDO getCandidate()
                         throws jobmatch.data.DataObjectException

Get Candidate of the HobbyDO

Returns:

Candidate of the HobbyDO

Throws:

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

setCandidate

public void setCandidate(CandidateDO Candidate)
                  throws jobmatch.data.DataObjectException

Set Candidate of the HobbyDO

Parameters:

Candidate - of the HobbyDO

Throws:

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

getCandidateBDO

public CandidateBDO getCandidateBDO()
                             throws jobmatch.data.DataObjectException

Get BDO-wrapped Candidate of the HobbyDO

Returns:

BDO-wrapped Candidate of the HobbyDO

Throws:

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

setCandidate

public void setCandidate(CandidateBDO Candidate)
                  throws jobmatch.data.DataObjectException

Set Candidate of the HobbyDO

Parameters:

BDO-wrapped - Candidate of the HobbyDO

Throws:

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

getTitle

public String getTitle()
                throws jobmatch.data.DataObjectException

Get Title of the HobbyDO

Returns:

Title of the HobbyDO

Throws:

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

setTitle

public void setTitle(String Title)
              throws jobmatch.data.DataObjectException

Set Title of the HobbyDO

Parameters:

Title - of the HobbyDO

Throws:

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

getDescription

public String getDescription()
                      throws jobmatch.data.DataObjectException

Get Description of the HobbyDO

Returns:

Description of the HobbyDO

Throws:

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

setDescription

public void setDescription(String Description)
                    throws jobmatch.data.DataObjectException

Set Description of the HobbyDO

Parameters:

Description - of the HobbyDO

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 HobbyDO

Returns:

Priority of the HobbyDO

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 HobbyDO

Parameters:

Priority - of the HobbyDO

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.

okToCommitCandidate

protected void okToCommitCandidate(CandidateDO member)
                            throws jobmatch.data.RefAssertionException

A stub method for implementing pre-commit assertions for the Candidate data member. Implement this stub to throw an RefAssertionException for cases where Candidate is not valid for writing to the database.

okToDeleteCandidate

protected void okToDeleteCandidate(CandidateDO member)
                            throws jobmatch.data.RefAssertionException

A stub method for implementing pre-delete assertions for the Candidate data member. Implement this stub to throw an RefAssertionException for cases where Candidate is not valid for deletion from the database.

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.