jobmatch.data
Class IndustryBDO

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

Direct Known Subclasses:

Industry

public class IndustryBDO

extends Object

implements Serializable

IndustryBDO contains the same set and get methods as the IndustryDO 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.7 $

See Also:

Serialized Form

Field Summary

protected IndustryDO

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

Constructor Summary

IndustryBDO()
Constructor required by IndustryBDO.create methods.

IndustryBDO(IndustryDO DO)
Constructor for use by classes derived from IndustryBDO.

Method Summary

void	addCompanyBDO(CompanyBDO rbdo) Add (set & commit) a CompanyBDO object whose CompanyDO refers to the DO held by this BDO.
void	addCompanyBDO(CompanyBDO rbdo, jobmatch.data.DBTransaction tran) Add (set & commit) a CompanyBDO object whose CompanyDO 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 IndustryBDO	createExisting(IndustryDO DO) The createExisting method is used to create a IndustryBDO from a IndustryDO that was returned by the IndustryQuery class.
static IndustryBDO	createVirgin() Like the class IndustryDO, 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.
AdressDO[]	getAdressDOArray_via_Company() From the many-to-many relationship expressed by CompanyDO, get array of AdressDO objects that indirectly refer to the DO held by this BDO.
static IndustryBDO[]	getBDOarray() The getBDOarray method performs a database query to return an array of IndustryBDO objects representing all the rows in the Industry table.
CompanyBDO	getCompanyBDO() Get the single CompanyBDO object holding a CompanyDO object that refers to the DO held by this BDO.
CompanyBDO[]	getCompanyBDOArray() Get array of CompanyBDO objects holding CompanyDO objects that refer to the DO held by this BDO.
CompanyDO	getCompanyDO() Get the single CompanyDO object that refers to the DO held by this BDO.
CompanyDO[]	getCompanyDOArray() Get array of CompanyDO objects that refer to the DO held by this BDO.
String	getDescription() Get Description of the IndustryDO
IndustryDO	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 IndustryBDO objects as options.
boolean	hasMatchingHandle(String handle)
void	mapAdress_via_CompanyBDO(AdressBDO b) To the many-to-many relationship expressed by CompanyDO, add a AdressDO object that indirectly refers to the DO held by this BDO.
void	mapAdress_via_CompanyBDO(AdressBDO b, jobmatch.data.DBTransaction tran) To the many-to-many relationship expressed by CompanyDO, add a AdressDO object that indirectly refers to the DO held by this BDO.
void	mapAdress_via_CompanyDO(AdressDO d) To the many-to-many relationship expressed by CompanyDO, add a AdressDO object that indirectly refers to the DO held by this BDO.
void	mapAdress_via_CompanyDO(AdressDO d, jobmatch.data.DBTransaction tran) To the many-to-many relationship expressed by CompanyDO, add a AdressDO object that indirectly refers to the DO held by this BDO.
protected void	modifyDO(jobmatch.data.DBTransaction dbt, boolean delete) Modifies the DO within its table.
void	removeCompanyBDO(CompanyBDO rbdo) Remove (delete) a CompanyBDO object whose CompanyDO refers to the DO held by this BDO.
void	removeCompanyBDO(CompanyBDO rbdo, jobmatch.data.DBTransaction tran) Remove (delete) a CompanyBDO object whose CompanyDO refers to the DO held by this BDO.
void	setDescription(String Description) Set Description of the IndustryDO
String	toString() for debugging
void	unmapAdress_via_CompanyBDO(AdressBDO b) From the many-to-many relationship expressed by CompanyDO, remove (delete) the AdressDO object that indirectly refers to the DO held by this BDO.
void	unmapAdress_via_CompanyBDO(AdressBDO b, jobmatch.data.DBTransaction tran) From the many-to-many relationship expressed by CompanyDO, remove (delete) the AdressDO object that indirectly refers to the DO held by this BDO.
void	unmapAdress_via_CompanyDO(AdressDO d) From the many-to-many relationship expressed by CompanyDO, remove (delete) the AdressDO object that indirectly refers to the DO held by this BDO.
void	unmapAdress_via_CompanyDO(AdressDO d, jobmatch.data.DBTransaction tran) From the many-to-many relationship expressed by CompanyDO, remove (delete) the AdressDO object that indirectly refers to the DO held by this BDO.

Methods inherited from class java.lang.Object

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

Field Detail

DO

protected IndustryDO DO

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

Constructor Detail

IndustryBDO

public IndustryBDO(IndustryDO DO)

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

IndustryBDO

public IndustryBDO()
            throws Exception

Constructor required by IndustryBDO.create methods.

Method Detail

getDO

public IndustryDO 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 IndustryBDO createVirgin()
                                throws Exception

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

The createExisting method is used to create a IndustryBDO from a IndustryDO that was returned by the IndustryQuery class.

getBDOarray

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

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

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 IndustryDO

Returns:

Description of the IndustryDO

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 IndustryDO

Parameters:

Description - of the IndustryDO

Throws:

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

getCompanyDOArray

public CompanyDO[] getCompanyDOArray()
                              throws jobmatch.data.DataObjectException,
                                     jobmatch.data.QueryException

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

Returns:

array of CompanyDO objects.

Throws:

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

getCompanyDO

public CompanyDO getCompanyDO()
                       throws jobmatch.data.DataObjectException,
                              jobmatch.data.NonUniqueQueryException,
                              jobmatch.data.QueryException

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

Returns:

CompanyDO object.

Throws:

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

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

getCompanyBDOArray

public CompanyBDO[] getCompanyBDOArray()
                                throws jobmatch.data.DataObjectException,
                                       jobmatch.data.QueryException

Get array of CompanyBDO objects holding CompanyDO objects that refer to the DO held by this BDO.

Returns:

array of CompanyBDO objects.

Throws:

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

getCompanyBDO

public CompanyBDO getCompanyBDO()
                         throws jobmatch.data.DataObjectException,
                                jobmatch.data.NonUniqueQueryException,
                                jobmatch.data.QueryException

Get the single CompanyBDO object holding a CompanyDO object that refers to the DO held by this BDO.

Returns:

CompanyBDO object.

Throws:

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

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

addCompanyBDO

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

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

Parameters:

rbdo - CompanyBDO 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.

addCompanyBDO

public void addCompanyBDO(CompanyBDO 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 CompanyBDO object whose CompanyDO refers to the DO held by this BDO.

Parameters:

rbdo - CompanyBDO 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.

removeCompanyBDO

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

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

Parameters:

r - CompanyBDO 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.

removeCompanyBDO

public void removeCompanyBDO(CompanyBDO 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 CompanyBDO object whose CompanyDO refers to the DO held by this BDO.

Parameters:

r - CompanyBDO 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.

getAdressDOArray_via_Company

public AdressDO[] getAdressDOArray_via_Company()
                                        throws jobmatch.data.DataObjectException

From the many-to-many relationship expressed by CompanyDO, get array of AdressDO objects that indirectly refer to the DO held by this BDO.

Returns:

array of AdressDO objects.

Throws:

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

mapAdress_via_CompanyDO

public void mapAdress_via_CompanyDO(AdressDO d)
                             throws jobmatch.data.DataObjectException,
                                    jobmatch.data.DatabaseManagerException,
                                    jobmatch.data.RefAssertionException,
                                    SQLException,
                                    jobmatch.data.DBRowUpdateException,
                                    jobmatch.data.QueryException

To the many-to-many relationship expressed by CompanyDO, add a AdressDO object that indirectly refers to the DO held by this BDO.

Parameters:

d - The AdressDO to add to the CompanyDO mapping for this BDO.

Throws:

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

mapAdress_via_CompanyDO

public void mapAdress_via_CompanyDO(AdressDO d,
                                    jobmatch.data.DBTransaction tran)
                             throws jobmatch.data.DataObjectException,
                                    jobmatch.data.DatabaseManagerException,
                                    jobmatch.data.RefAssertionException,
                                    SQLException,
                                    jobmatch.data.DBRowUpdateException,
                                    jobmatch.data.QueryException

To the many-to-many relationship expressed by CompanyDO, add a AdressDO object that indirectly refers to the DO held by this BDO.

Parameters:

d - The AdressDO to add to the CompanyDO mapping for this BDO.

Throws:

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

mapAdress_via_CompanyBDO

public void mapAdress_via_CompanyBDO(AdressBDO b)
                              throws jobmatch.data.DataObjectException,
                                     jobmatch.data.DatabaseManagerException,
                                     jobmatch.data.RefAssertionException,
                                     SQLException,
                                     jobmatch.data.DBRowUpdateException,
                                     jobmatch.data.QueryException

To the many-to-many relationship expressed by CompanyDO, add a AdressDO object that indirectly refers to the DO held by this BDO.

Parameters:

b - The AdressBDO to add to the CompanyDO mapping for this BDO.

Throws:

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

mapAdress_via_CompanyBDO

public void mapAdress_via_CompanyBDO(AdressBDO b,
                                     jobmatch.data.DBTransaction tran)
                              throws jobmatch.data.DataObjectException,
                                     jobmatch.data.DatabaseManagerException,
                                     jobmatch.data.RefAssertionException,
                                     SQLException,
                                     jobmatch.data.DBRowUpdateException,
                                     jobmatch.data.QueryException

To the many-to-many relationship expressed by CompanyDO, add a AdressDO object that indirectly refers to the DO held by this BDO.

Parameters:

b - The AdressBDO to add to the CompanyDO mapping for this BDO.

Throws:

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

unmapAdress_via_CompanyDO

public void unmapAdress_via_CompanyDO(AdressDO d)
                               throws jobmatch.data.DataObjectException,
                                      jobmatch.data.DatabaseManagerException,
                                      jobmatch.data.RefAssertionException,
                                      SQLException,
                                      jobmatch.data.DBRowUpdateException,
                                      jobmatch.data.QueryException

From the many-to-many relationship expressed by CompanyDO, remove (delete) the AdressDO object that indirectly refers to the DO held by this BDO.

Parameters:

d - The AdressDO to remove from the CompanyDO mapping for this BDO.

Throws:

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

unmapAdress_via_CompanyDO

public void unmapAdress_via_CompanyDO(AdressDO d,
                                      jobmatch.data.DBTransaction tran)
                               throws jobmatch.data.DataObjectException,
                                      jobmatch.data.DatabaseManagerException,
                                      jobmatch.data.RefAssertionException,
                                      SQLException,
                                      jobmatch.data.DBRowUpdateException,
                                      jobmatch.data.QueryException

From the many-to-many relationship expressed by CompanyDO, remove (delete) the AdressDO object that indirectly refers to the DO held by this BDO.

Parameters:

d - The AdressDO to remove from the CompanyDO mapping for this BDO.

Throws:

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

unmapAdress_via_CompanyBDO

public void unmapAdress_via_CompanyBDO(AdressBDO b)
                                throws jobmatch.data.DataObjectException,
                                       jobmatch.data.DatabaseManagerException,
                                       jobmatch.data.RefAssertionException,
                                       SQLException,
                                       jobmatch.data.DBRowUpdateException,
                                       jobmatch.data.QueryException

From the many-to-many relationship expressed by CompanyDO, remove (delete) the AdressDO object that indirectly refers to the DO held by this BDO.

Parameters:

b - The AdressBDO to remove from the CompanyDO mapping for this BDO.

Throws:

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

unmapAdress_via_CompanyBDO

public void unmapAdress_via_CompanyBDO(AdressBDO b,
                                       jobmatch.data.DBTransaction tran)
                                throws jobmatch.data.DataObjectException,
                                       jobmatch.data.DatabaseManagerException,
                                       jobmatch.data.RefAssertionException,
                                       SQLException,
                                       jobmatch.data.DBRowUpdateException,
                                       jobmatch.data.QueryException

From the many-to-many relationship expressed by CompanyDO, remove (delete) the AdressDO object that indirectly refers to the DO held by this BDO.

Parameters:

b - The AdressBDO to remove from the CompanyDO mapping for this BDO.

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.