jobmatch.data
Class CandidateProfileBDO

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

public class CandidateProfileBDO

extends Object

implements Serializable

CandidateProfileBDO contains the same set and get methods as the CandidateProfileDO 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.7 $

See Also:

Serialized Form

Field Summary

protected CandidateProfileDO

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

Constructor Summary

CandidateProfileBDO()
Constructor required by CandidateProfileBDO.create methods.

CandidateProfileBDO(CandidateProfileDO DO)
Constructor for use by classes derived from CandidateProfileBDO.

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 CandidateProfileBDO	createExisting(CandidateProfileDO DO) The createExisting method is used to create a CandidateProfileBDO from a CandidateProfileDO that was returned by the CandidateProfileQuery class.
static CandidateProfileBDO	createVirgin() Like the class CandidateProfileDO, 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 CandidateProfileBDO[]	getBDOarray() The getBDOarray method performs a database query to return an array of CandidateProfileBDO objects representing all the rows in the CandidateProfile table.
CandidateDO	getCandidate() Get Candidate of the CandidateProfileDO
CandidateBDO	getCandidateBDO() Get BDO-wrapped Candidate of the CandidateProfileDO
CandidateProfileDO	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 CandidateProfileBDO objects as options.
Timestamp	getMatchingTime() Get MatchingTime of the CandidateProfileDO
ProfileDO	getProfile() Get Profile of the CandidateProfileDO
ProfileBDO	getProfileBDO() Get BDO-wrapped Profile of the CandidateProfileDO
double	getScore() Get Score of the CandidateProfileDO
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	okToCommitProfile(ProfileDO member) A stub method for implementing pre-commit assertions for the Profile data member.
protected void	okToDeleteCandidate(CandidateDO member) A stub method for implementing pre-delete assertions for the Candidate data member.
protected void	okToDeleteProfile(ProfileDO member) A stub method for implementing pre-delete assertions for the Profile data member.
void	setCandidate(CandidateBDO Candidate) Set Candidate of the CandidateProfileDO
void	setCandidate(CandidateDO Candidate) Set Candidate of the CandidateProfileDO
void	setMatchingTime(Timestamp MatchingTime) Set MatchingTime of the CandidateProfileDO
void	setProfile(ProfileBDO Profile) Set Profile of the CandidateProfileDO
void	setProfile(ProfileDO Profile) Set Profile of the CandidateProfileDO
void	setScore(double Score) Set Score of the CandidateProfileDO
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 CandidateProfileDO DO

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

Constructor Detail

CandidateProfileBDO

public CandidateProfileBDO(CandidateProfileDO DO)

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

CandidateProfileBDO

public CandidateProfileBDO()
                    throws Exception

Constructor required by CandidateProfileBDO.create methods.

Method Detail

getDO

public CandidateProfileDO 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 CandidateProfileBDO createVirgin()
                                        throws Exception

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

The createExisting method is used to create a CandidateProfileBDO from a CandidateProfileDO that was returned by the CandidateProfileQuery class.

getBDOarray

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

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

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 CandidateProfileDO

Returns:

Candidate of the CandidateProfileDO

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 CandidateProfileDO

Parameters:

Candidate - of the CandidateProfileDO

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 CandidateProfileDO

Returns:

BDO-wrapped Candidate of the CandidateProfileDO

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 CandidateProfileDO

Parameters:

BDO-wrapped - Candidate of the CandidateProfileDO

Throws:

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

getMatchingTime

public Timestamp getMatchingTime()
                          throws jobmatch.data.DataObjectException

Get MatchingTime of the CandidateProfileDO

Returns:

MatchingTime of the CandidateProfileDO

Throws:

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

setMatchingTime

public void setMatchingTime(Timestamp MatchingTime)
                     throws jobmatch.data.DataObjectException

Set MatchingTime of the CandidateProfileDO

Parameters:

MatchingTime - of the CandidateProfileDO

Throws:

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

getProfile

public ProfileDO getProfile()
                     throws jobmatch.data.DataObjectException

Get Profile of the CandidateProfileDO

Returns:

Profile of the CandidateProfileDO

Throws:

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

setProfile

public void setProfile(ProfileDO Profile)
                throws jobmatch.data.DataObjectException

Set Profile of the CandidateProfileDO

Parameters:

Profile - of the CandidateProfileDO

Throws:

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

getProfileBDO

public ProfileBDO getProfileBDO()
                         throws jobmatch.data.DataObjectException

Get BDO-wrapped Profile of the CandidateProfileDO

Returns:

BDO-wrapped Profile of the CandidateProfileDO

Throws:

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

setProfile

public void setProfile(ProfileBDO Profile)
                throws jobmatch.data.DataObjectException

Set Profile of the CandidateProfileDO

Parameters:

BDO-wrapped - Profile of the CandidateProfileDO

Throws:

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

getScore

public double getScore()
                throws jobmatch.data.DataObjectException

Get Score of the CandidateProfileDO

Returns:

Score of the CandidateProfileDO

Throws:

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

setScore

public void setScore(double Score)
              throws jobmatch.data.DataObjectException

Set Score of the CandidateProfileDO

Parameters:

Score - of the CandidateProfileDO

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.

okToCommitProfile

protected void okToCommitProfile(ProfileDO member)
                          throws jobmatch.data.RefAssertionException

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

okToDeleteProfile

protected void okToDeleteProfile(ProfileDO member)
                          throws jobmatch.data.RefAssertionException

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