jobmatch.data
Class GraduationBDO

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

Direct Known Subclasses:

Graduation

public class GraduationBDO

extends Object

implements Serializable

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

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

Constructor Summary

GraduationBDO()
Constructor required by GraduationBDO.create methods.

GraduationBDO(GraduationDO DO)
Constructor for use by classes derived from GraduationBDO.

Method Summary

void	addSchoolCandidateBDO(SchoolCandidateBDO rbdo) Add (set & commit) a SchoolCandidateBDO object whose SchoolCandidateDO refers to the DO held by this BDO.
void	addSchoolCandidateBDO(SchoolCandidateBDO rbdo, jobmatch.data.DBTransaction tran) Add (set & commit) a SchoolCandidateBDO object whose SchoolCandidateDO 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 GraduationBDO	createExisting(GraduationDO DO) The createExisting method is used to create a GraduationBDO from a GraduationDO that was returned by the GraduationQuery class.
static GraduationBDO	createVirgin() Like the class GraduationDO, 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 GraduationBDO[]	getBDOarray() The getBDOarray method performs a database query to return an array of GraduationBDO objects representing all the rows in the Graduation table.
String	getDescription() Get Description of the GraduationDO
GraduationDO	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 GraduationBDO objects as options.
SchoolCandidateBDO	getSchoolCandidateBDO() Get the single SchoolCandidateBDO object holding a SchoolCandidateDO object that refers to the DO held by this BDO.
SchoolCandidateBDO[]	getSchoolCandidateBDOArray() Get array of SchoolCandidateBDO objects holding SchoolCandidateDO objects that refer to the DO held by this BDO.
SchoolCandidateDO	getSchoolCandidateDO() Get the single SchoolCandidateDO object that refers to the DO held by this BDO.
SchoolCandidateDO[]	getSchoolCandidateDOArray() Get array of SchoolCandidateDO objects that refer to the DO held by this BDO.
SchoolDO[]	getSchoolDOArray_via_SchoolCandidate() From the many-to-many relationship expressed by SchoolCandidateDO, get array of SchoolDO objects that indirectly refer to the DO held by this BDO.
boolean	hasMatchingHandle(String handle)
void	mapSchool_via_SchoolCandidateBDO(SchoolBDO b) To the many-to-many relationship expressed by SchoolCandidateDO, add a SchoolDO object that indirectly refers to the DO held by this BDO.
void	mapSchool_via_SchoolCandidateBDO(SchoolBDO b, jobmatch.data.DBTransaction tran) To the many-to-many relationship expressed by SchoolCandidateDO, add a SchoolDO object that indirectly refers to the DO held by this BDO.
void	mapSchool_via_SchoolCandidateDO(SchoolDO d) To the many-to-many relationship expressed by SchoolCandidateDO, add a SchoolDO object that indirectly refers to the DO held by this BDO.
void	mapSchool_via_SchoolCandidateDO(SchoolDO d, jobmatch.data.DBTransaction tran) To the many-to-many relationship expressed by SchoolCandidateDO, add a SchoolDO 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	removeSchoolCandidateBDO(SchoolCandidateBDO rbdo) Remove (delete) a SchoolCandidateBDO object whose SchoolCandidateDO refers to the DO held by this BDO.
void	removeSchoolCandidateBDO(SchoolCandidateBDO rbdo, jobmatch.data.DBTransaction tran) Remove (delete) a SchoolCandidateBDO object whose SchoolCandidateDO refers to the DO held by this BDO.
void	setDescription(String Description) Set Description of the GraduationDO
String	toString() for debugging
void	unmapSchool_via_SchoolCandidateBDO(SchoolBDO b) From the many-to-many relationship expressed by SchoolCandidateDO, remove (delete) the SchoolDO object that indirectly refers to the DO held by this BDO.
void	unmapSchool_via_SchoolCandidateBDO(SchoolBDO b, jobmatch.data.DBTransaction tran) From the many-to-many relationship expressed by SchoolCandidateDO, remove (delete) the SchoolDO object that indirectly refers to the DO held by this BDO.
void	unmapSchool_via_SchoolCandidateDO(SchoolDO d) From the many-to-many relationship expressed by SchoolCandidateDO, remove (delete) the SchoolDO object that indirectly refers to the DO held by this BDO.
void	unmapSchool_via_SchoolCandidateDO(SchoolDO d, jobmatch.data.DBTransaction tran) From the many-to-many relationship expressed by SchoolCandidateDO, remove (delete) the SchoolDO 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 GraduationDO DO

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

Constructor Detail

GraduationBDO

public GraduationBDO(GraduationDO DO)

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

GraduationBDO

public GraduationBDO()
              throws Exception

Constructor required by GraduationBDO.create methods.

Method Detail

getDO

public GraduationDO 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 GraduationBDO createVirgin()
                                  throws Exception

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

The createExisting method is used to create a GraduationBDO from a GraduationDO that was returned by the GraduationQuery class.

getBDOarray

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

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

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 GraduationDO

Returns:

Description of the GraduationDO

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 GraduationDO

Parameters:

Description - of the GraduationDO

Throws:

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

getSchoolCandidateDOArray

public SchoolCandidateDO[] getSchoolCandidateDOArray()
                                              throws jobmatch.data.DataObjectException,
                                                     jobmatch.data.QueryException

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

Returns:

array of SchoolCandidateDO objects.

Throws:

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

getSchoolCandidateDO

public SchoolCandidateDO getSchoolCandidateDO()
                                       throws jobmatch.data.DataObjectException,
                                              jobmatch.data.NonUniqueQueryException,
                                              jobmatch.data.QueryException

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

Returns:

SchoolCandidateDO object.

Throws:

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

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

getSchoolCandidateBDOArray

public SchoolCandidateBDO[] getSchoolCandidateBDOArray()
                                                throws jobmatch.data.DataObjectException,
                                                       jobmatch.data.QueryException

Get array of SchoolCandidateBDO objects holding SchoolCandidateDO objects that refer to the DO held by this BDO.

Returns:

array of SchoolCandidateBDO objects.

Throws:

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

getSchoolCandidateBDO

public SchoolCandidateBDO getSchoolCandidateBDO()
                                         throws jobmatch.data.DataObjectException,
                                                jobmatch.data.NonUniqueQueryException,
                                                jobmatch.data.QueryException

Get the single SchoolCandidateBDO object holding a SchoolCandidateDO object that refers to the DO held by this BDO.

Returns:

SchoolCandidateBDO object.

Throws:

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

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

addSchoolCandidateBDO

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

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

Parameters:

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

addSchoolCandidateBDO

public void addSchoolCandidateBDO(SchoolCandidateBDO 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 SchoolCandidateBDO object whose SchoolCandidateDO refers to the DO held by this BDO.

Parameters:

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

removeSchoolCandidateBDO

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

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

Parameters:

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

removeSchoolCandidateBDO

public void removeSchoolCandidateBDO(SchoolCandidateBDO 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 SchoolCandidateBDO object whose SchoolCandidateDO refers to the DO held by this BDO.

Parameters:

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

getSchoolDOArray_via_SchoolCandidate

public SchoolDO[] getSchoolDOArray_via_SchoolCandidate()
                                                throws jobmatch.data.DataObjectException

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

Returns:

array of SchoolDO objects.

Throws:

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

mapSchool_via_SchoolCandidateDO

public void mapSchool_via_SchoolCandidateDO(SchoolDO 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 SchoolCandidateDO, add a SchoolDO object that indirectly refers to the DO held by this BDO.

Parameters:

d - The SchoolDO to add to the SchoolCandidateDO mapping for this BDO.

Throws:

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

mapSchool_via_SchoolCandidateDO

public void mapSchool_via_SchoolCandidateDO(SchoolDO 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 SchoolCandidateDO, add a SchoolDO object that indirectly refers to the DO held by this BDO.

Parameters:

d - The SchoolDO to add to the SchoolCandidateDO mapping for this BDO.

Throws:

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

mapSchool_via_SchoolCandidateBDO

public void mapSchool_via_SchoolCandidateBDO(SchoolBDO 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 SchoolCandidateDO, add a SchoolDO object that indirectly refers to the DO held by this BDO.

Parameters:

b - The SchoolBDO to add to the SchoolCandidateDO mapping for this BDO.

Throws:

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

mapSchool_via_SchoolCandidateBDO

public void mapSchool_via_SchoolCandidateBDO(SchoolBDO 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 SchoolCandidateDO, add a SchoolDO object that indirectly refers to the DO held by this BDO.

Parameters:

b - The SchoolBDO to add to the SchoolCandidateDO mapping for this BDO.

Throws:

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

unmapSchool_via_SchoolCandidateDO

public void unmapSchool_via_SchoolCandidateDO(SchoolDO 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 SchoolCandidateDO, remove (delete) the SchoolDO object that indirectly refers to the DO held by this BDO.

Parameters:

d - The SchoolDO to remove from the SchoolCandidateDO mapping for this BDO.

Throws:

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

unmapSchool_via_SchoolCandidateDO

public void unmapSchool_via_SchoolCandidateDO(SchoolDO 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 SchoolCandidateDO, remove (delete) the SchoolDO object that indirectly refers to the DO held by this BDO.

Parameters:

d - The SchoolDO to remove from the SchoolCandidateDO mapping for this BDO.

Throws:

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

unmapSchool_via_SchoolCandidateBDO

public void unmapSchool_via_SchoolCandidateBDO(SchoolBDO 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 SchoolCandidateDO, remove (delete) the SchoolDO object that indirectly refers to the DO held by this BDO.

Parameters:

b - The SchoolBDO to remove from the SchoolCandidateDO mapping for this BDO.

Throws:

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

unmapSchool_via_SchoolCandidateBDO

public void unmapSchool_via_SchoolCandidateBDO(SchoolBDO 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 SchoolCandidateDO, remove (delete) the SchoolDO object that indirectly refers to the DO held by this BDO.

Parameters:

b - The SchoolBDO to remove from the SchoolCandidateDO 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.