PSE 2000 Group 4

jobmatch.data
Class SchoolCandidateBDO

java.lang.Object
  |
  +--jobmatch.data.SchoolCandidateBDO
Direct Known Subclasses:
Formation

public class SchoolCandidateBDO
extends Object
implements Serializable

SchoolCandidateBDO contains the same set and get methods as the SchoolCandidateDO 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  SchoolCandidateDO DO
          The SchoolCandidateDO object upon which the set and get methods operate.
 
Constructor Summary
SchoolCandidateBDO()
          Constructor required by SchoolCandidateBDO.create methods.
SchoolCandidateBDO(SchoolCandidateDO DO)
          Constructor for use by classes derived from SchoolCandidateBDO.
 
Method Summary
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 SchoolCandidateBDO createExisting(SchoolCandidateDO DO)
          The createExisting method is used to create a SchoolCandidateBDO from a SchoolCandidateDO that was returned by the SchoolCandidateQuery class.
static SchoolCandidateBDO createVirgin()
          Like the class SchoolCandidateDO, 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 SchoolCandidateBDO[] getBDOarray()
          The getBDOarray method performs a database query to return an array of SchoolCandidateBDO objects representing all the rows in the SchoolCandidate table.
 Date getBeginDate()
          Get BeginDate of the SchoolCandidateDO
 CandidateDO getCandidate()
          Get Candidate of the SchoolCandidateDO
 CandidateBDO getCandidateBDO()
          Get BDO-wrapped Candidate of the SchoolCandidateDO
 GraduationDO getDiploma()
          Get Diploma of the SchoolCandidateDO
 GraduationBDO getDiplomaBDO()
          Get BDO-wrapped Diploma of the SchoolCandidateDO
 SchoolCandidateDO getDO()
          Note: This method is intended for use only by other BDO classes.
 Date getEndDate()
          Get EndDate of the SchoolCandidateDO
 String getHandle()
          The methods getHandle hasMatchingHandle are used by Presentation Objects that need to populate HTML select lists with SchoolCandidateBDO objects as options.
 String getRemarks()
          Get Remarks of the SchoolCandidateDO
 SchoolDO getSchool()
          Get School of the SchoolCandidateDO
 SchoolBDO getSchoolBDO()
          Get BDO-wrapped School of the SchoolCandidateDO
 boolean hasMatchingHandle(String handle)
           
protected  void modifyDO(jobmatch.data.DBTransaction dbt, boolean delete)
          Modifies the DO within its table.
protected  void okToCommitCandidate(CandidateDO member)
          A stub method for implementing pre-commit assertions for the Candidate data member.
protected  void okToCommitDiploma(GraduationDO member)
          A stub method for implementing pre-commit assertions for the Diploma data member.
protected  void okToCommitSchool(SchoolDO member)
          A stub method for implementing pre-commit assertions for the School data member.
protected  void okToDeleteCandidate(CandidateDO member)
          A stub method for implementing pre-delete assertions for the Candidate data member.
protected  void okToDeleteDiploma(GraduationDO member)
          A stub method for implementing pre-delete assertions for the Diploma data member.
protected  void okToDeleteSchool(SchoolDO member)
          A stub method for implementing pre-delete assertions for the School data member.
 void setBeginDate(Date BeginDate)
          Set BeginDate of the SchoolCandidateDO
 void setCandidate(CandidateBDO Candidate)
          Set Candidate of the SchoolCandidateDO
 void setCandidate(CandidateDO Candidate)
          Set Candidate of the SchoolCandidateDO
 void setDiploma(GraduationBDO Diploma)
          Set Diploma of the SchoolCandidateDO
 void setDiploma(GraduationDO Diploma)
          Set Diploma of the SchoolCandidateDO
 void setEndDate(Date EndDate)
          Set EndDate of the SchoolCandidateDO
 void setRemarks(String Remarks)
          Set Remarks of the SchoolCandidateDO
 void setSchool(SchoolBDO School)
          Set School of the SchoolCandidateDO
 void setSchool(SchoolDO School)
          Set School of the SchoolCandidateDO
 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 SchoolCandidateDO DO
The SchoolCandidateDO object upon which the set and get methods operate. This member is protected so that classes derived from SchoolCandidateBDO can access the underlying Data Object.
Constructor Detail

SchoolCandidateBDO

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

SchoolCandidateBDO

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

getDO

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

getBDOarray

public static SchoolCandidateBDO[] getBDOarray()
                                        throws jobmatch.data.DataObjectException
The getBDOarray method performs a database query to return an array of SchoolCandidateBDO objects representing all the rows in the SchoolCandidate 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 SchoolCandidateDO 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 SchoolCandidateBDO 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 SchoolCandidateBDO object holds a reference to a SchoolCandidateDO object. The id of this SchoolCandidateBDO is the id of its SchoolCandidateDO.
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

getCandidate

public CandidateDO getCandidate()
                         throws jobmatch.data.DataObjectException
Get Candidate of the SchoolCandidateDO
Returns:
Candidate of the SchoolCandidateDO
Throws:
jobmatch.data.DataObjectException - If the object is not found in the database.

setCandidate

public void setCandidate(CandidateDO Candidate)
                  throws jobmatch.data.DataObjectException
Set Candidate of the SchoolCandidateDO
Parameters:
Candidate - of the SchoolCandidateDO
Throws:
jobmatch.data.DataObjectException - If the object is not found in the database.

getCandidateBDO

public CandidateBDO getCandidateBDO()
                             throws jobmatch.data.DataObjectException
Get BDO-wrapped Candidate of the SchoolCandidateDO
Returns:
BDO-wrapped Candidate of the SchoolCandidateDO
Throws:
jobmatch.data.DataObjectException - If the object is not found in the database.

setCandidate

public void setCandidate(CandidateBDO Candidate)
                  throws jobmatch.data.DataObjectException
Set Candidate of the SchoolCandidateDO
Parameters:
BDO-wrapped - Candidate of the SchoolCandidateDO
Throws:
jobmatch.data.DataObjectException - If the object is not found in the database.

getBeginDate

public Date getBeginDate()
                  throws jobmatch.data.DataObjectException
Get BeginDate of the SchoolCandidateDO
Returns:
BeginDate of the SchoolCandidateDO
Throws:
jobmatch.data.DataObjectException - If the object is not found in the database.

setBeginDate

public void setBeginDate(Date BeginDate)
                  throws jobmatch.data.DataObjectException
Set BeginDate of the SchoolCandidateDO
Parameters:
BeginDate - of the SchoolCandidateDO
Throws:
jobmatch.data.DataObjectException - If the object is not found in the database.

getEndDate

public Date getEndDate()
                throws jobmatch.data.DataObjectException
Get EndDate of the SchoolCandidateDO
Returns:
EndDate of the SchoolCandidateDO
Throws:
jobmatch.data.DataObjectException - If the object is not found in the database.

setEndDate

public void setEndDate(Date EndDate)
                throws jobmatch.data.DataObjectException
Set EndDate of the SchoolCandidateDO
Parameters:
EndDate - of the SchoolCandidateDO
Throws:
jobmatch.data.DataObjectException - If the object is not found in the database.

getSchool

public SchoolDO getSchool()
                   throws jobmatch.data.DataObjectException
Get School of the SchoolCandidateDO
Returns:
School of the SchoolCandidateDO
Throws:
jobmatch.data.DataObjectException - If the object is not found in the database.

setSchool

public void setSchool(SchoolDO School)
               throws jobmatch.data.DataObjectException
Set School of the SchoolCandidateDO
Parameters:
School - of the SchoolCandidateDO
Throws:
jobmatch.data.DataObjectException - If the object is not found in the database.

getSchoolBDO

public SchoolBDO getSchoolBDO()
                       throws jobmatch.data.DataObjectException
Get BDO-wrapped School of the SchoolCandidateDO
Returns:
BDO-wrapped School of the SchoolCandidateDO
Throws:
jobmatch.data.DataObjectException - If the object is not found in the database.

setSchool

public void setSchool(SchoolBDO School)
               throws jobmatch.data.DataObjectException
Set School of the SchoolCandidateDO
Parameters:
BDO-wrapped - School of the SchoolCandidateDO
Throws:
jobmatch.data.DataObjectException - If the object is not found in the database.

getDiploma

public GraduationDO getDiploma()
                        throws jobmatch.data.DataObjectException
Get Diploma of the SchoolCandidateDO
Returns:
Diploma of the SchoolCandidateDO
Throws:
jobmatch.data.DataObjectException - If the object is not found in the database.

setDiploma

public void setDiploma(GraduationDO Diploma)
                throws jobmatch.data.DataObjectException
Set Diploma of the SchoolCandidateDO
Parameters:
Diploma - of the SchoolCandidateDO
Throws:
jobmatch.data.DataObjectException - If the object is not found in the database.

getDiplomaBDO

public GraduationBDO getDiplomaBDO()
                            throws jobmatch.data.DataObjectException
Get BDO-wrapped Diploma of the SchoolCandidateDO
Returns:
BDO-wrapped Diploma of the SchoolCandidateDO
Throws:
jobmatch.data.DataObjectException - If the object is not found in the database.

setDiploma

public void setDiploma(GraduationBDO Diploma)
                throws jobmatch.data.DataObjectException
Set Diploma of the SchoolCandidateDO
Parameters:
BDO-wrapped - Diploma of the SchoolCandidateDO
Throws:
jobmatch.data.DataObjectException - If the object is not found in the database.

getRemarks

public String getRemarks()
                  throws jobmatch.data.DataObjectException
Get Remarks of the SchoolCandidateDO
Returns:
Remarks of the SchoolCandidateDO
Throws:
jobmatch.data.DataObjectException - If the object is not found in the database.

setRemarks

public void setRemarks(String Remarks)
                throws jobmatch.data.DataObjectException
Set Remarks of the SchoolCandidateDO
Parameters:
Remarks - of the SchoolCandidateDO
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.

okToCommitCandidate

protected void okToCommitCandidate(CandidateDO member)
                            throws jobmatch.data.RefAssertionException
A stub method for implementing pre-commit assertions for the Candidate data member. Implement this stub to throw an RefAssertionException for cases where Candidate is not valid for writing to the database.

okToDeleteCandidate

protected void okToDeleteCandidate(CandidateDO member)
                            throws jobmatch.data.RefAssertionException
A stub method for implementing pre-delete assertions for the Candidate data member. Implement this stub to throw an RefAssertionException for cases where Candidate is not valid for deletion from the database.

okToCommitSchool

protected void okToCommitSchool(SchoolDO member)
                         throws jobmatch.data.RefAssertionException
A stub method for implementing pre-commit assertions for the School data member. Implement this stub to throw an RefAssertionException for cases where School is not valid for writing to the database.

okToDeleteSchool

protected void okToDeleteSchool(SchoolDO member)
                         throws jobmatch.data.RefAssertionException
A stub method for implementing pre-delete assertions for the School data member. Implement this stub to throw an RefAssertionException for cases where School is not valid for deletion from the database.

okToCommitDiploma

protected void okToCommitDiploma(GraduationDO member)
                          throws jobmatch.data.RefAssertionException
A stub method for implementing pre-commit assertions for the Diploma data member. Implement this stub to throw an RefAssertionException for cases where Diploma is not valid for writing to the database.

okToDeleteDiploma

protected void okToDeleteDiploma(GraduationDO member)
                          throws jobmatch.data.RefAssertionException
A stub method for implementing pre-delete assertions for the Diploma data member. Implement this stub to throw an RefAssertionException for cases where Diploma 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.

PSE 2000 Group 4