PSE 2000 Group 4

jobmatch.data
Class SchooltypeBDO

java.lang.Object
  |
  +--jobmatch.data.SchooltypeBDO
Direct Known Subclasses:
Schooltype

public class SchooltypeBDO
extends Object
implements Serializable

SchooltypeBDO contains the same set and get methods as the SchooltypeDO 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  SchooltypeDO DO
          The SchooltypeDO object upon which the set and get methods operate.
 
Constructor Summary
SchooltypeBDO()
          Constructor required by SchooltypeBDO.create methods.
SchooltypeBDO(SchooltypeDO DO)
          Constructor for use by classes derived from SchooltypeBDO.
 
Method Summary
 void addSchoolBDO(SchoolBDO rbdo)
          Add (set & commit) a SchoolBDO object whose SchoolDO refers to the DO held by this BDO.
 void addSchoolBDO(SchoolBDO rbdo, jobmatch.data.DBTransaction tran)
          Add (set & commit) a SchoolBDO object whose SchoolDO 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 SchooltypeBDO createExisting(SchooltypeDO DO)
          The createExisting method is used to create a SchooltypeBDO from a SchooltypeDO that was returned by the SchooltypeQuery class.
static SchooltypeBDO createVirgin()
          Like the class SchooltypeDO, 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 SchooltypeBDO[] getBDOarray()
          The getBDOarray method performs a database query to return an array of SchooltypeBDO objects representing all the rows in the Schooltype table.
 String getDescription()
          Get Description of the SchooltypeDO
 SchooltypeDO 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 SchooltypeBDO objects as options.
 SchoolBDO getSchoolBDO()
          Get the single SchoolBDO object holding a SchoolDO object that refers to the DO held by this BDO.
 SchoolBDO[] getSchoolBDOArray()
          Get array of SchoolBDO objects holding SchoolDO objects that refer to the DO held by this BDO.
 SchoolDO getSchoolDO()
          Get the single SchoolDO object that refers to the DO held by this BDO.
 SchoolDO[] getSchoolDOArray()
          Get array of SchoolDO 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 removeSchoolBDO(SchoolBDO rbdo)
          Remove (delete) a SchoolBDO object whose SchoolDO refers to the DO held by this BDO.
 void removeSchoolBDO(SchoolBDO rbdo, jobmatch.data.DBTransaction tran)
          Remove (delete) a SchoolBDO object whose SchoolDO refers to the DO held by this BDO.
 void setDescription(String Description)
          Set Description of the SchooltypeDO
 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 SchooltypeDO DO
The SchooltypeDO object upon which the set and get methods operate. This member is protected so that classes derived from SchooltypeBDO can access the underlying Data Object.
Constructor Detail

SchooltypeBDO

public SchooltypeBDO(SchooltypeDO DO)
Constructor for use by classes derived from SchooltypeBDO. 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 ); } }

SchooltypeBDO

public SchooltypeBDO()
              throws Exception
Constructor required by SchooltypeBDO.create methods.
Method Detail

getDO

public SchooltypeDO 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 SchooltypeBDO createVirgin()
                                  throws Exception
Like the class SchooltypeDO, 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 SchooltypeBDO createExisting(SchooltypeDO DO)
The createExisting method is used to create a SchooltypeBDO from a SchooltypeDO that was returned by the SchooltypeQuery class.

getBDOarray

public static SchooltypeBDO[] getBDOarray()
                                   throws jobmatch.data.DataObjectException
The getBDOarray method performs a database query to return an array of SchooltypeBDO objects representing all the rows in the Schooltype 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 SchooltypeDO 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 SchooltypeBDO 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 SchooltypeBDO object holds a reference to a SchooltypeDO object. The id of this SchooltypeBDO is the id of its SchooltypeDO.
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 SchooltypeDO
Returns:
Description of the SchooltypeDO
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 SchooltypeDO
Parameters:
Description - of the SchooltypeDO
Throws:
jobmatch.data.DataObjectException - If the object is not found in the database.

getSchoolDOArray

public SchoolDO[] getSchoolDOArray()
                            throws jobmatch.data.DataObjectException,
                                   jobmatch.data.QueryException
Get array of SchoolDO objects that 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.

getSchoolDO

public SchoolDO getSchoolDO()
                     throws jobmatch.data.DataObjectException,
                            jobmatch.data.NonUniqueQueryException,
                            jobmatch.data.QueryException
Get the single SchoolDO object that refers to the DO held by this BDO.
Returns:
SchoolDO object.
Throws:
jobmatch.data.DataObjectException - If the object is not found in the database.
jobmatch.data.NonUniqueQueryException - If more than one SchoolDO object was found.

getSchoolBDOArray

public SchoolBDO[] getSchoolBDOArray()
                              throws jobmatch.data.DataObjectException,
                                     jobmatch.data.QueryException
Get array of SchoolBDO objects holding SchoolDO objects that refer to the DO held by this BDO.
Returns:
array of SchoolBDO objects.
Throws:
jobmatch.data.DataObjectException - If the object is not found in the database.

getSchoolBDO

public SchoolBDO getSchoolBDO()
                       throws jobmatch.data.DataObjectException,
                              jobmatch.data.NonUniqueQueryException,
                              jobmatch.data.QueryException
Get the single SchoolBDO object holding a SchoolDO object that refers to the DO held by this BDO.
Returns:
SchoolBDO object.
Throws:
jobmatch.data.DataObjectException - If the object is not found in the database.
jobmatch.data.NonUniqueQueryException - If more than one SchoolBDO object was found.

addSchoolBDO

public void addSchoolBDO(SchoolBDO rbdo)
                  throws SQLException,
                         jobmatch.data.DatabaseManagerException,
                         jobmatch.data.DataObjectException,
                         jobmatch.data.RefAssertionException,
                         jobmatch.data.DBRowUpdateException,
                         jobmatch.data.QueryException
Add (set & commit) a SchoolBDO object whose SchoolDO refers to the DO held by this BDO.
Parameters:
rbdo - SchoolBDO 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.

addSchoolBDO

public void addSchoolBDO(SchoolBDO 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 SchoolBDO object whose SchoolDO refers to the DO held by this BDO.
Parameters:
rbdo - SchoolBDO 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.

removeSchoolBDO

public void removeSchoolBDO(SchoolBDO rbdo)
                     throws SQLException,
                            jobmatch.data.DatabaseManagerException,
                            jobmatch.data.DataObjectException,
                            jobmatch.data.RefAssertionException,
                            jobmatch.data.DBRowUpdateException,
                            jobmatch.data.QueryException
Remove (delete) a SchoolBDO object whose SchoolDO refers to the DO held by this BDO.
Parameters:
r - SchoolBDO 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.

removeSchoolBDO

public void removeSchoolBDO(SchoolBDO 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 SchoolBDO object whose SchoolDO refers to the DO held by this BDO.
Parameters:
r - SchoolBDO 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.

PSE 2000 Group 4