jobmatch.data
Class AssociationBDO

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

Direct Known Subclasses:

Association

public class AssociationBDO

extends Object

implements Serializable

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

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

Constructor Summary

AssociationBDO()
Constructor required by AssociationBDO.create methods.

AssociationBDO(AssociationDO DO)
Constructor for use by classes derived from AssociationBDO.

Method Summary

void	addAssociationCandidateBDO(AssociationCandidateBDO rbdo) Add (set & commit) a AssociationCandidateBDO object whose AssociationCandidateDO refers to the DO held by this BDO.
void	addAssociationCandidateBDO(AssociationCandidateBDO rbdo, jobmatch.data.DBTransaction tran) Add (set & commit) a AssociationCandidateBDO object whose AssociationCandidateDO refers to the DO held by this BDO.
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 AssociationBDO	createExisting(AssociationDO DO) The createExisting method is used to create a AssociationBDO from a AssociationDO that was returned by the AssociationQuery class.
static AssociationBDO	createVirgin() Like the class AssociationDO, 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.
AssociationCandidateBDO	getAssociationCandidateBDO() Get the single AssociationCandidateBDO object holding a AssociationCandidateDO object that refers to the DO held by this BDO.
AssociationCandidateBDO[]	getAssociationCandidateBDOArray() Get array of AssociationCandidateBDO objects holding AssociationCandidateDO objects that refer to the DO held by this BDO.
AssociationCandidateDO	getAssociationCandidateDO() Get the single AssociationCandidateDO object that refers to the DO held by this BDO.
AssociationCandidateDO[]	getAssociationCandidateDOArray() Get array of AssociationCandidateDO objects that refer to the DO held by this BDO.
static AssociationBDO[]	getBDOarray() The getBDOarray method performs a database query to return an array of AssociationBDO objects representing all the rows in the Association table.
String	getDescription() Get Description of the AssociationDO
AssociationDO	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 AssociationBDO objects as options.
boolean	hasMatchingHandle(String handle)
protected void	modifyDO(jobmatch.data.DBTransaction dbt, boolean delete) Modifies the DO within its table.
void	removeAssociationCandidateBDO(AssociationCandidateBDO rbdo) Remove (delete) a AssociationCandidateBDO object whose AssociationCandidateDO refers to the DO held by this BDO.
void	removeAssociationCandidateBDO(AssociationCandidateBDO rbdo, jobmatch.data.DBTransaction tran) Remove (delete) a AssociationCandidateBDO object whose AssociationCandidateDO refers to the DO held by this BDO.
void	setDescription(String Description) Set Description of the AssociationDO
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 AssociationDO DO

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

Constructor Detail

AssociationBDO

public AssociationBDO(AssociationDO DO)

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

AssociationBDO

public AssociationBDO()
               throws Exception

Constructor required by AssociationBDO.create methods.

Method Detail

getDO

public AssociationDO 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 AssociationBDO createVirgin()
                                   throws Exception

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

The createExisting method is used to create a AssociationBDO from a AssociationDO that was returned by the AssociationQuery class.

getBDOarray

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

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

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

getDescription

public String getDescription()
                      throws jobmatch.data.DataObjectException

Get Description of the AssociationDO

Returns:

Description of the AssociationDO

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 AssociationDO

Parameters:

Description - of the AssociationDO

Throws:

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

getAssociationCandidateDOArray

public AssociationCandidateDO[] getAssociationCandidateDOArray()
                                                        throws jobmatch.data.DataObjectException,
                                                               jobmatch.data.QueryException

Get array of AssociationCandidateDO objects that refer to the DO held by this BDO.

Returns:

array of AssociationCandidateDO objects.

Throws:

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

getAssociationCandidateDO

public AssociationCandidateDO getAssociationCandidateDO()
                                                 throws jobmatch.data.DataObjectException,
                                                        jobmatch.data.NonUniqueQueryException,
                                                        jobmatch.data.QueryException

Get the single AssociationCandidateDO object that refers to the DO held by this BDO.

Returns:

AssociationCandidateDO object.

Throws:

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

jobmatch.data.NonUniqueQueryException - If more than one AssociationCandidateDO object was found.

getAssociationCandidateBDOArray

public AssociationCandidateBDO[] getAssociationCandidateBDOArray()
                                                          throws jobmatch.data.DataObjectException,
                                                                 jobmatch.data.QueryException

Get array of AssociationCandidateBDO objects holding AssociationCandidateDO objects that refer to the DO held by this BDO.

Returns:

array of AssociationCandidateBDO objects.

Throws:

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

getAssociationCandidateBDO

public AssociationCandidateBDO getAssociationCandidateBDO()
                                                   throws jobmatch.data.DataObjectException,
                                                          jobmatch.data.NonUniqueQueryException,
                                                          jobmatch.data.QueryException

Get the single AssociationCandidateBDO object holding a AssociationCandidateDO object that refers to the DO held by this BDO.

Returns:

AssociationCandidateBDO object.

Throws:

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

jobmatch.data.NonUniqueQueryException - If more than one AssociationCandidateBDO object was found.

addAssociationCandidateBDO

public void addAssociationCandidateBDO(AssociationCandidateBDO rbdo)
                                throws SQLException,
                                       jobmatch.data.DatabaseManagerException,
                                       jobmatch.data.DataObjectException,
                                       jobmatch.data.RefAssertionException,
                                       jobmatch.data.DBRowUpdateException,
                                       jobmatch.data.QueryException

Add (set & commit) a AssociationCandidateBDO object whose AssociationCandidateDO refers to the DO held by this BDO.

Parameters:

rbdo - AssociationCandidateBDO to be set to point to this BDO and committed.

Throws:

jobmatch.data.DatabaseManagerException - if could not create a transaction

SQLException - if any SQL errors occur.

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

addAssociationCandidateBDO

public void addAssociationCandidateBDO(AssociationCandidateBDO rbdo,
                                       jobmatch.data.DBTransaction tran)
                                throws SQLException,
                                       jobmatch.data.DatabaseManagerException,
                                       jobmatch.data.DataObjectException,
                                       jobmatch.data.RefAssertionException,
                                       jobmatch.data.DBRowUpdateException,
                                       jobmatch.data.QueryException

Add (set & commit) a AssociationCandidateBDO object whose AssociationCandidateDO refers to the DO held by this BDO.

Parameters:

rbdo - AssociationCandidateBDO to be set to point to this BDO and committed.

tran - The transaction to be used for the commit. If null, a new transaction is created.

Throws:

jobmatch.data.DatabaseManagerException - if could not create a transaction

SQLException - if any SQL errors occur.

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

removeAssociationCandidateBDO

public void removeAssociationCandidateBDO(AssociationCandidateBDO rbdo)
                                   throws SQLException,
                                          jobmatch.data.DatabaseManagerException,
                                          jobmatch.data.DataObjectException,
                                          jobmatch.data.RefAssertionException,
                                          jobmatch.data.DBRowUpdateException,
                                          jobmatch.data.QueryException

Remove (delete) a AssociationCandidateBDO object whose AssociationCandidateDO refers to the DO held by this BDO.

Parameters:

r - AssociationCandidateBDO to be deleted.

Throws:

jobmatch.data.DatabaseManagerException - if could not create a transaction

SQLException - if any SQL errors occur.

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

removeAssociationCandidateBDO

public void removeAssociationCandidateBDO(AssociationCandidateBDO rbdo,
                                          jobmatch.data.DBTransaction tran)
                                   throws SQLException,
                                          jobmatch.data.DatabaseManagerException,
                                          jobmatch.data.DataObjectException,
                                          jobmatch.data.RefAssertionException,
                                          jobmatch.data.DBRowUpdateException,
                                          jobmatch.data.QueryException

Remove (delete) a AssociationCandidateBDO object whose AssociationCandidateDO refers to the DO held by this BDO.

Parameters:

r - AssociationCandidateBDO to be deleted.

tran - The transaction to be used for the commit. If null, a new transaction is created.

Throws:

jobmatch.data.DatabaseManagerException - if could not create a transaction

SQLException - if any SQL errors occur.

jobmatch.data.DataObjectException - If 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.