jobmatch.data
Class EmployerBDO

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

Direct Known Subclasses:

Employer

public class EmployerBDO

extends Object

implements Serializable

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

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

Constructor Summary

EmployerBDO()
Constructor required by EmployerBDO.create methods.

EmployerBDO(EmployerDO DO)
Constructor for use by classes derived from EmployerBDO.

Method Summary

void	addEmployerCandidateBDO(EmployerCandidateBDO rbdo) Add (set & commit) a EmployerCandidateBDO object whose EmployerCandidateDO refers to the DO held by this BDO.
void	addEmployerCandidateBDO(EmployerCandidateBDO rbdo, jobmatch.data.DBTransaction tran) Add (set & commit) a EmployerCandidateBDO object whose EmployerCandidateDO 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 EmployerBDO	createExisting(EmployerDO DO) The createExisting method is used to create a EmployerBDO from a EmployerDO that was returned by the EmployerQuery class.
static EmployerBDO	createVirgin() Like the class EmployerDO, 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	getAdress() Get Adress of the EmployerDO
AdressBDO	getAdressBDO() Get BDO-wrapped Adress of the EmployerDO
static EmployerBDO[]	getBDOarray() The getBDOarray method performs a database query to return an array of EmployerBDO objects representing all the rows in the Employer table.
EmployerDO	getDO() Note: This method is intended for use only by other BDO classes.
EmployerCandidateBDO	getEmployerCandidateBDO() Get the single EmployerCandidateBDO object holding a EmployerCandidateDO object that refers to the DO held by this BDO.
EmployerCandidateBDO[]	getEmployerCandidateBDOArray() Get array of EmployerCandidateBDO objects holding EmployerCandidateDO objects that refer to the DO held by this BDO.
EmployerCandidateDO	getEmployerCandidateDO() Get the single EmployerCandidateDO object that refers to the DO held by this BDO.
EmployerCandidateDO[]	getEmployerCandidateDOArray() Get array of EmployerCandidateDO objects that refer to the DO held by this BDO.
String	getHandle() The methods getHandle hasMatchingHandle are used by Presentation Objects that need to populate HTML select lists with EmployerBDO objects as options.
String	getName() Get Name of the EmployerDO
boolean	hasMatchingHandle(String handle)
protected void	modifyDO(jobmatch.data.DBTransaction dbt, boolean delete) Modifies the DO within its table.
protected void	okToCommitAdress(AdressDO member) A stub method for implementing pre-commit assertions for the Adress data member.
protected void	okToDeleteAdress(AdressDO member) A stub method for implementing pre-delete assertions for the Adress data member.
void	removeEmployerCandidateBDO(EmployerCandidateBDO rbdo) Remove (delete) a EmployerCandidateBDO object whose EmployerCandidateDO refers to the DO held by this BDO.
void	removeEmployerCandidateBDO(EmployerCandidateBDO rbdo, jobmatch.data.DBTransaction tran) Remove (delete) a EmployerCandidateBDO object whose EmployerCandidateDO refers to the DO held by this BDO.
void	setAdress(AdressBDO Adress) Set Adress of the EmployerDO
void	setAdress(AdressDO Adress) Set Adress of the EmployerDO
void	setName(String Name) Set Name of the EmployerDO
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 EmployerDO DO

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

Constructor Detail

EmployerBDO

public EmployerBDO(EmployerDO DO)

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

EmployerBDO

public EmployerBDO()
            throws Exception

Constructor required by EmployerBDO.create methods.

Method Detail

getDO

public EmployerDO 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 EmployerBDO createVirgin()
                                throws Exception

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

The createExisting method is used to create a EmployerBDO from a EmployerDO that was returned by the EmployerQuery class.

getBDOarray

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

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

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

getName

public String getName()
               throws jobmatch.data.DataObjectException

Get Name of the EmployerDO

Returns:

Name of the EmployerDO

Throws:

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

setName

public void setName(String Name)
             throws jobmatch.data.DataObjectException

Set Name of the EmployerDO

Parameters:

Name - of the EmployerDO

Throws:

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

getAdress

public AdressDO getAdress()
                   throws jobmatch.data.DataObjectException

Get Adress of the EmployerDO

Returns:

Adress of the EmployerDO

Throws:

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

setAdress

public void setAdress(AdressDO Adress)
               throws jobmatch.data.DataObjectException

Set Adress of the EmployerDO

Parameters:

Adress - of the EmployerDO

Throws:

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

getAdressBDO

public AdressBDO getAdressBDO()
                       throws jobmatch.data.DataObjectException

Get BDO-wrapped Adress of the EmployerDO

Returns:

BDO-wrapped Adress of the EmployerDO

Throws:

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

setAdress

public void setAdress(AdressBDO Adress)
               throws jobmatch.data.DataObjectException

Set Adress of the EmployerDO

Parameters:

BDO-wrapped - Adress of the EmployerDO

Throws:

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

getEmployerCandidateDOArray

public EmployerCandidateDO[] getEmployerCandidateDOArray()
                                                  throws jobmatch.data.DataObjectException,
                                                         jobmatch.data.QueryException

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

Returns:

array of EmployerCandidateDO objects.

Throws:

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

getEmployerCandidateDO

public EmployerCandidateDO getEmployerCandidateDO()
                                           throws jobmatch.data.DataObjectException,
                                                  jobmatch.data.NonUniqueQueryException,
                                                  jobmatch.data.QueryException

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

Returns:

EmployerCandidateDO object.

Throws:

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

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

getEmployerCandidateBDOArray

public EmployerCandidateBDO[] getEmployerCandidateBDOArray()
                                                    throws jobmatch.data.DataObjectException,
                                                           jobmatch.data.QueryException

Get array of EmployerCandidateBDO objects holding EmployerCandidateDO objects that refer to the DO held by this BDO.

Returns:

array of EmployerCandidateBDO objects.

Throws:

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

getEmployerCandidateBDO

public EmployerCandidateBDO getEmployerCandidateBDO()
                                             throws jobmatch.data.DataObjectException,
                                                    jobmatch.data.NonUniqueQueryException,
                                                    jobmatch.data.QueryException

Get the single EmployerCandidateBDO object holding a EmployerCandidateDO object that refers to the DO held by this BDO.

Returns:

EmployerCandidateBDO object.

Throws:

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

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

addEmployerCandidateBDO

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

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

Parameters:

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

addEmployerCandidateBDO

public void addEmployerCandidateBDO(EmployerCandidateBDO 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 EmployerCandidateBDO object whose EmployerCandidateDO refers to the DO held by this BDO.

Parameters:

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

removeEmployerCandidateBDO

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

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

Parameters:

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

removeEmployerCandidateBDO

public void removeEmployerCandidateBDO(EmployerCandidateBDO 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 EmployerCandidateBDO object whose EmployerCandidateDO refers to the DO held by this BDO.

Parameters:

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

okToCommitAdress

protected void okToCommitAdress(AdressDO member)
                         throws jobmatch.data.RefAssertionException

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

okToDeleteAdress

protected void okToDeleteAdress(AdressDO member)
                         throws jobmatch.data.RefAssertionException

A stub method for implementing pre-delete assertions for the Adress data member. Implement this stub to throw an RefAssertionException for cases where Adress 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.