jobmatch.data
Class LanguageBDO

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

Direct Known Subclasses:

Language

public class LanguageBDO

extends Object

implements Serializable

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

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

Constructor Summary

LanguageBDO()
Constructor required by LanguageBDO.create methods.

LanguageBDO(LanguageDO DO)
Constructor for use by classes derived from LanguageBDO.

Method Summary

void	addLanguageCandidateBDO(LanguageCandidateBDO rbdo) Add (set & commit) a LanguageCandidateBDO object whose LanguageCandidateDO refers to the DO held by this BDO.
void	addLanguageCandidateBDO(LanguageCandidateBDO rbdo, jobmatch.data.DBTransaction tran) Add (set & commit) a LanguageCandidateBDO object whose LanguageCandidateDO refers to the DO held by this BDO.
void	addLanguageProfileBDO(LanguageProfileBDO rbdo) Add (set & commit) a LanguageProfileBDO object whose LanguageProfileDO refers to the DO held by this BDO.
void	addLanguageProfileBDO(LanguageProfileBDO rbdo, jobmatch.data.DBTransaction tran) Add (set & commit) a LanguageProfileBDO object whose LanguageProfileDO 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 LanguageBDO	createExisting(LanguageDO DO) The createExisting method is used to create a LanguageBDO from a LanguageDO that was returned by the LanguageQuery class.
static LanguageBDO	createVirgin() Like the class LanguageDO, 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 LanguageBDO[]	getBDOarray() The getBDOarray method performs a database query to return an array of LanguageBDO objects representing all the rows in the Language table.
String	getDescription() Get Description of the LanguageDO
LanguageDO	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 LanguageBDO objects as options.
LanguageCandidateBDO	getLanguageCandidateBDO() Get the single LanguageCandidateBDO object holding a LanguageCandidateDO object that refers to the DO held by this BDO.
LanguageCandidateBDO[]	getLanguageCandidateBDOArray() Get array of LanguageCandidateBDO objects holding LanguageCandidateDO objects that refer to the DO held by this BDO.
LanguageCandidateDO	getLanguageCandidateDO() Get the single LanguageCandidateDO object that refers to the DO held by this BDO.
LanguageCandidateDO[]	getLanguageCandidateDOArray() Get array of LanguageCandidateDO objects that refer to the DO held by this BDO.
LanguageProfileBDO	getLanguageProfileBDO() Get the single LanguageProfileBDO object holding a LanguageProfileDO object that refers to the DO held by this BDO.
LanguageProfileBDO[]	getLanguageProfileBDOArray() Get array of LanguageProfileBDO objects holding LanguageProfileDO objects that refer to the DO held by this BDO.
LanguageProfileDO	getLanguageProfileDO() Get the single LanguageProfileDO object that refers to the DO held by this BDO.
LanguageProfileDO[]	getLanguageProfileDOArray() Get array of LanguageProfileDO objects that refer to the DO held by this BDO.
boolean	hasMatchingHandle(String handle)
protected void	modifyDO(jobmatch.data.DBTransaction dbt, boolean delete) Modifies the DO within its table.
void	removeLanguageCandidateBDO(LanguageCandidateBDO rbdo) Remove (delete) a LanguageCandidateBDO object whose LanguageCandidateDO refers to the DO held by this BDO.
void	removeLanguageCandidateBDO(LanguageCandidateBDO rbdo, jobmatch.data.DBTransaction tran) Remove (delete) a LanguageCandidateBDO object whose LanguageCandidateDO refers to the DO held by this BDO.
void	removeLanguageProfileBDO(LanguageProfileBDO rbdo) Remove (delete) a LanguageProfileBDO object whose LanguageProfileDO refers to the DO held by this BDO.
void	removeLanguageProfileBDO(LanguageProfileBDO rbdo, jobmatch.data.DBTransaction tran) Remove (delete) a LanguageProfileBDO object whose LanguageProfileDO refers to the DO held by this BDO.
void	setDescription(String Description) Set Description of the LanguageDO
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 LanguageDO DO

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

Constructor Detail

LanguageBDO

public LanguageBDO(LanguageDO DO)

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

LanguageBDO

public LanguageBDO()
            throws Exception

Constructor required by LanguageBDO.create methods.

Method Detail

getDO

public LanguageDO 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 LanguageBDO createVirgin()
                                throws Exception

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

The createExisting method is used to create a LanguageBDO from a LanguageDO that was returned by the LanguageQuery class.

getBDOarray

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

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

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 LanguageDO

Returns:

Description of the LanguageDO

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 LanguageDO

Parameters:

Description - of the LanguageDO

Throws:

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

getLanguageCandidateDOArray

public LanguageCandidateDO[] getLanguageCandidateDOArray()
                                                  throws jobmatch.data.DataObjectException,
                                                         jobmatch.data.QueryException

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

Returns:

array of LanguageCandidateDO objects.

Throws:

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

getLanguageCandidateDO

public LanguageCandidateDO getLanguageCandidateDO()
                                           throws jobmatch.data.DataObjectException,
                                                  jobmatch.data.NonUniqueQueryException,
                                                  jobmatch.data.QueryException

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

Returns:

LanguageCandidateDO object.

Throws:

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

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

getLanguageCandidateBDOArray

public LanguageCandidateBDO[] getLanguageCandidateBDOArray()
                                                    throws jobmatch.data.DataObjectException,
                                                           jobmatch.data.QueryException

Get array of LanguageCandidateBDO objects holding LanguageCandidateDO objects that refer to the DO held by this BDO.

Returns:

array of LanguageCandidateBDO objects.

Throws:

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

getLanguageCandidateBDO

public LanguageCandidateBDO getLanguageCandidateBDO()
                                             throws jobmatch.data.DataObjectException,
                                                    jobmatch.data.NonUniqueQueryException,
                                                    jobmatch.data.QueryException

Get the single LanguageCandidateBDO object holding a LanguageCandidateDO object that refers to the DO held by this BDO.

Returns:

LanguageCandidateBDO object.

Throws:

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

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

addLanguageCandidateBDO

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

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

Parameters:

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

addLanguageCandidateBDO

public void addLanguageCandidateBDO(LanguageCandidateBDO 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 LanguageCandidateBDO object whose LanguageCandidateDO refers to the DO held by this BDO.

Parameters:

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

removeLanguageCandidateBDO

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

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

Parameters:

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

removeLanguageCandidateBDO

public void removeLanguageCandidateBDO(LanguageCandidateBDO 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 LanguageCandidateBDO object whose LanguageCandidateDO refers to the DO held by this BDO.

Parameters:

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

getLanguageProfileDOArray

public LanguageProfileDO[] getLanguageProfileDOArray()
                                              throws jobmatch.data.DataObjectException,
                                                     jobmatch.data.QueryException

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

Returns:

array of LanguageProfileDO objects.

Throws:

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

getLanguageProfileDO

public LanguageProfileDO getLanguageProfileDO()
                                       throws jobmatch.data.DataObjectException,
                                              jobmatch.data.NonUniqueQueryException,
                                              jobmatch.data.QueryException

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

Returns:

LanguageProfileDO object.

Throws:

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

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

getLanguageProfileBDOArray

public LanguageProfileBDO[] getLanguageProfileBDOArray()
                                                throws jobmatch.data.DataObjectException,
                                                       jobmatch.data.QueryException

Get array of LanguageProfileBDO objects holding LanguageProfileDO objects that refer to the DO held by this BDO.

Returns:

array of LanguageProfileBDO objects.

Throws:

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

getLanguageProfileBDO

public LanguageProfileBDO getLanguageProfileBDO()
                                         throws jobmatch.data.DataObjectException,
                                                jobmatch.data.NonUniqueQueryException,
                                                jobmatch.data.QueryException

Get the single LanguageProfileBDO object holding a LanguageProfileDO object that refers to the DO held by this BDO.

Returns:

LanguageProfileBDO object.

Throws:

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

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

addLanguageProfileBDO

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

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

Parameters:

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

addLanguageProfileBDO

public void addLanguageProfileBDO(LanguageProfileBDO 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 LanguageProfileBDO object whose LanguageProfileDO refers to the DO held by this BDO.

Parameters:

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

removeLanguageProfileBDO

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

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

Parameters:

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

removeLanguageProfileBDO

public void removeLanguageProfileBDO(LanguageProfileBDO 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 LanguageProfileBDO object whose LanguageProfileDO refers to the DO held by this BDO.

Parameters:

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