jobmatch.data
Class CandidateAccountBDO

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

Direct Known Subclasses:

CandidateAccount

public class CandidateAccountBDO

extends Object

implements Serializable

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

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

Constructor Summary

CandidateAccountBDO()
Constructor required by CandidateAccountBDO.create methods.

CandidateAccountBDO(CandidateAccountDO DO)
Constructor for use by classes derived from CandidateAccountBDO.

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 CandidateAccountBDO	createExisting(CandidateAccountDO DO) The createExisting method is used to create a CandidateAccountBDO from a CandidateAccountDO that was returned by the CandidateAccountQuery class.
static CandidateAccountBDO	createVirgin() Like the class CandidateAccountDO, 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 CandidateAccountBDO[]	getBDOarray() The getBDOarray method performs a database query to return an array of CandidateAccountBDO objects representing all the rows in the CandidateAccount table.
CandidateDO	getCandidate() Get Candidate of the CandidateAccountDO
CandidateBDO	getCandidateBDO() Get BDO-wrapped Candidate of the CandidateAccountDO
CandidateAccountDO	getDO() Note: This method is intended for use only by other BDO classes.
String	getEmail() Get Email of the CandidateAccountDO
String	getHandle() The methods getHandle hasMatchingHandle are used by Presentation Objects that need to populate HTML select lists with CandidateAccountBDO objects as options.
String	getLastHost() Get LastHost of the CandidateAccountDO
String	getLastIP() Get LastIP of the CandidateAccountDO
Timestamp	getLastLogin() Get LastLogin of the CandidateAccountDO
int	getLoginReminder() Get LoginReminder of the CandidateAccountDO
String	getPassphrase() Get Passphrase of the CandidateAccountDO
String	getUsername() Get Username of the CandidateAccountDO
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	okToDeleteCandidate(CandidateDO member) A stub method for implementing pre-delete assertions for the Candidate data member.
void	setCandidate(CandidateBDO Candidate) Set Candidate of the CandidateAccountDO
void	setCandidate(CandidateDO Candidate) Set Candidate of the CandidateAccountDO
void	setEmail(String Email) Set Email of the CandidateAccountDO
void	setLastHost(String LastHost) Set LastHost of the CandidateAccountDO
void	setLastIP(String LastIP) Set LastIP of the CandidateAccountDO
void	setLastLogin(Timestamp LastLogin) Set LastLogin of the CandidateAccountDO
void	setLoginReminder(int LoginReminder) Set LoginReminder of the CandidateAccountDO
void	setPassphrase(String Passphrase) Set Passphrase of the CandidateAccountDO
void	setUsername(String Username) Set Username of the CandidateAccountDO
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 CandidateAccountDO DO

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

Constructor Detail

CandidateAccountBDO

public CandidateAccountBDO(CandidateAccountDO DO)

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

CandidateAccountBDO

public CandidateAccountBDO()
                    throws Exception

Constructor required by CandidateAccountBDO.create methods.

Method Detail

getDO

public CandidateAccountDO 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 CandidateAccountBDO createVirgin()
                                        throws Exception

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

The createExisting method is used to create a CandidateAccountBDO from a CandidateAccountDO that was returned by the CandidateAccountQuery class.

getBDOarray

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

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

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

getUsername

public String getUsername()
                   throws jobmatch.data.DataObjectException

Get Username of the CandidateAccountDO

Returns:

Username of the CandidateAccountDO

Throws:

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

setUsername

public void setUsername(String Username)
                 throws jobmatch.data.DataObjectException

Set Username of the CandidateAccountDO

Parameters:

Username - of the CandidateAccountDO

Throws:

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

getEmail

public String getEmail()
                throws jobmatch.data.DataObjectException

Get Email of the CandidateAccountDO

Returns:

Email of the CandidateAccountDO

Throws:

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

setEmail

public void setEmail(String Email)
              throws jobmatch.data.DataObjectException

Set Email of the CandidateAccountDO

Parameters:

Email - of the CandidateAccountDO

Throws:

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

getLastLogin

public Timestamp getLastLogin()
                       throws jobmatch.data.DataObjectException

Get LastLogin of the CandidateAccountDO

Returns:

LastLogin of the CandidateAccountDO

Throws:

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

setLastLogin

public void setLastLogin(Timestamp LastLogin)
                  throws jobmatch.data.DataObjectException

Set LastLogin of the CandidateAccountDO

Parameters:

LastLogin - of the CandidateAccountDO

Throws:

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

getLoginReminder

public int getLoginReminder()
                     throws jobmatch.data.DataObjectException

Get LoginReminder of the CandidateAccountDO

Returns:

LoginReminder of the CandidateAccountDO

Throws:

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

setLoginReminder

public void setLoginReminder(int LoginReminder)
                      throws jobmatch.data.DataObjectException

Set LoginReminder of the CandidateAccountDO

Parameters:

LoginReminder - of the CandidateAccountDO

Throws:

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

getPassphrase

public String getPassphrase()
                     throws jobmatch.data.DataObjectException

Get Passphrase of the CandidateAccountDO

Returns:

Passphrase of the CandidateAccountDO

Throws:

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

setPassphrase

public void setPassphrase(String Passphrase)
                   throws jobmatch.data.DataObjectException

Set Passphrase of the CandidateAccountDO

Parameters:

Passphrase - of the CandidateAccountDO

Throws:

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

getLastIP

public String getLastIP()
                 throws jobmatch.data.DataObjectException

Get LastIP of the CandidateAccountDO

Returns:

LastIP of the CandidateAccountDO

Throws:

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

setLastIP

public void setLastIP(String LastIP)
               throws jobmatch.data.DataObjectException

Set LastIP of the CandidateAccountDO

Parameters:

LastIP - of the CandidateAccountDO

Throws:

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

getLastHost

public String getLastHost()
                   throws jobmatch.data.DataObjectException

Get LastHost of the CandidateAccountDO

Returns:

LastHost of the CandidateAccountDO

Throws:

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

setLastHost

public void setLastHost(String LastHost)
                 throws jobmatch.data.DataObjectException

Set LastHost of the CandidateAccountDO

Parameters:

LastHost - of the CandidateAccountDO

Throws:

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

getCandidate

public CandidateDO getCandidate()
                         throws jobmatch.data.DataObjectException

Get Candidate of the CandidateAccountDO

Returns:

Candidate of the CandidateAccountDO

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 CandidateAccountDO

Parameters:

Candidate - of the CandidateAccountDO

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 CandidateAccountDO

Returns:

BDO-wrapped Candidate of the CandidateAccountDO

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 CandidateAccountDO

Parameters:

BDO-wrapped - Candidate of the CandidateAccountDO

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.

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.