jobmatch.data
Class AssociationCandidateBDO

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

public class AssociationCandidateBDO

extends Object

implements Serializable

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

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

Constructor Summary

AssociationCandidateBDO()
Constructor required by AssociationCandidateBDO.create methods.

AssociationCandidateBDO(AssociationCandidateDO DO)
Constructor for use by classes derived from AssociationCandidateBDO.

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 AssociationCandidateBDO	createExisting(AssociationCandidateDO DO) The createExisting method is used to create a AssociationCandidateBDO from a AssociationCandidateDO that was returned by the AssociationCandidateQuery class.
static AssociationCandidateBDO	createVirgin() Like the class AssociationCandidateDO, 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.
AssociationDO	getAssociation() Get Association of the AssociationCandidateDO
AssociationBDO	getAssociationBDO() Get BDO-wrapped Association of the AssociationCandidateDO
static AssociationCandidateBDO[]	getBDOarray() The getBDOarray method performs a database query to return an array of AssociationCandidateBDO objects representing all the rows in the AssociationCandidate table.
CandidateDO	getCandidate() Get Candidate of the AssociationCandidateDO
CandidateBDO	getCandidateBDO() Get BDO-wrapped Candidate of the AssociationCandidateDO
AssociationCandidateDO	getDO() Note: This method is intended for use only by other BDO classes.
String	getFunction() Get Function of the AssociationCandidateDO
String	getHandle() The methods getHandle hasMatchingHandle are used by Presentation Objects that need to populate HTML select lists with AssociationCandidateBDO objects as options.
boolean	hasMatchingHandle(String handle)
protected void	modifyDO(jobmatch.data.DBTransaction dbt, boolean delete) Modifies the DO within its table.
protected void	okToCommitAssociation(AssociationDO member) A stub method for implementing pre-commit assertions for the Association data member.
protected void	okToCommitCandidate(CandidateDO member) A stub method for implementing pre-commit assertions for the Candidate data member.
protected void	okToDeleteAssociation(AssociationDO member) A stub method for implementing pre-delete assertions for the Association data member.
protected void	okToDeleteCandidate(CandidateDO member) A stub method for implementing pre-delete assertions for the Candidate data member.
void	setAssociation(AssociationBDO Association) Set Association of the AssociationCandidateDO
void	setAssociation(AssociationDO Association) Set Association of the AssociationCandidateDO
void	setCandidate(CandidateBDO Candidate) Set Candidate of the AssociationCandidateDO
void	setCandidate(CandidateDO Candidate) Set Candidate of the AssociationCandidateDO
void	setFunction(String Function) Set Function of the AssociationCandidateDO
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 AssociationCandidateDO DO

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

Constructor Detail

AssociationCandidateBDO

public AssociationCandidateBDO(AssociationCandidateDO DO)

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

AssociationCandidateBDO

public AssociationCandidateBDO()
                        throws Exception

Constructor required by AssociationCandidateBDO.create methods.

Method Detail

getDO

public AssociationCandidateDO 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 AssociationCandidateBDO createVirgin()
                                            throws Exception

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

The createExisting method is used to create a AssociationCandidateBDO from a AssociationCandidateDO that was returned by the AssociationCandidateQuery class.

getBDOarray

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

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

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 AssociationCandidateDO

Returns:

Candidate of the AssociationCandidateDO

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 AssociationCandidateDO

Parameters:

Candidate - of the AssociationCandidateDO

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 AssociationCandidateDO

Returns:

BDO-wrapped Candidate of the AssociationCandidateDO

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 AssociationCandidateDO

Parameters:

BDO-wrapped - Candidate of the AssociationCandidateDO

Throws:

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

getAssociation

public AssociationDO getAssociation()
                             throws jobmatch.data.DataObjectException

Get Association of the AssociationCandidateDO

Returns:

Association of the AssociationCandidateDO

Throws:

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

setAssociation

public void setAssociation(AssociationDO Association)
                    throws jobmatch.data.DataObjectException

Set Association of the AssociationCandidateDO

Parameters:

Association - of the AssociationCandidateDO

Throws:

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

getAssociationBDO

public AssociationBDO getAssociationBDO()
                                 throws jobmatch.data.DataObjectException

Get BDO-wrapped Association of the AssociationCandidateDO

Returns:

BDO-wrapped Association of the AssociationCandidateDO

Throws:

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

setAssociation

public void setAssociation(AssociationBDO Association)
                    throws jobmatch.data.DataObjectException

Set Association of the AssociationCandidateDO

Parameters:

BDO-wrapped - Association of the AssociationCandidateDO

Throws:

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

getFunction

public String getFunction()
                   throws jobmatch.data.DataObjectException

Get Function of the AssociationCandidateDO

Returns:

Function of the AssociationCandidateDO

Throws:

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

setFunction

public void setFunction(String Function)
                 throws jobmatch.data.DataObjectException

Set Function of the AssociationCandidateDO

Parameters:

Function - of the AssociationCandidateDO

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.

okToCommitAssociation

protected void okToCommitAssociation(AssociationDO member)
                              throws jobmatch.data.RefAssertionException

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

okToDeleteAssociation

protected void okToDeleteAssociation(AssociationDO member)
                              throws jobmatch.data.RefAssertionException

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