PSE 2000 Group 4

jobmatch.data
Class SoftwareCandidateBDO

java.lang.Object
  |
  +--jobmatch.data.SoftwareCandidateBDO
Direct Known Subclasses:
SoftwareSkill

public class SoftwareCandidateBDO
extends Object
implements Serializable

SoftwareCandidateBDO contains the same set and get methods as the SoftwareCandidateDO 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  SoftwareCandidateDO DO
          The SoftwareCandidateDO object upon which the set and get methods operate.
 
Constructor Summary
SoftwareCandidateBDO()
          Constructor required by SoftwareCandidateBDO.create methods.
SoftwareCandidateBDO(SoftwareCandidateDO DO)
          Constructor for use by classes derived from SoftwareCandidateBDO.
 
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 SoftwareCandidateBDO createExisting(SoftwareCandidateDO DO)
          The createExisting method is used to create a SoftwareCandidateBDO from a SoftwareCandidateDO that was returned by the SoftwareCandidateQuery class.
static SoftwareCandidateBDO createVirgin()
          Like the class SoftwareCandidateDO, 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 SoftwareCandidateBDO[] getBDOarray()
          The getBDOarray method performs a database query to return an array of SoftwareCandidateBDO objects representing all the rows in the SoftwareCandidate table.
 CandidateDO getCandidate()
          Get Candidate of the SoftwareCandidateDO
 CandidateBDO getCandidateBDO()
          Get BDO-wrapped Candidate of the SoftwareCandidateDO
 CompcapabilityDO getCapability()
          Get Capability of the SoftwareCandidateDO
 CompcapabilityBDO getCapabilityBDO()
          Get BDO-wrapped Capability of the SoftwareCandidateDO
 SoftwareCandidateDO 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 SoftwareCandidateBDO objects as options.
 SoftwareDO getSoftware()
          Get Software of the SoftwareCandidateDO
 SoftwareBDO getSoftwareBDO()
          Get BDO-wrapped Software of the SoftwareCandidateDO
 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 okToCommitCapability(CompcapabilityDO member)
          A stub method for implementing pre-commit assertions for the Capability data member.
protected  void okToCommitSoftware(SoftwareDO member)
          A stub method for implementing pre-commit assertions for the Software data member.
protected  void okToDeleteCandidate(CandidateDO member)
          A stub method for implementing pre-delete assertions for the Candidate data member.
protected  void okToDeleteCapability(CompcapabilityDO member)
          A stub method for implementing pre-delete assertions for the Capability data member.
protected  void okToDeleteSoftware(SoftwareDO member)
          A stub method for implementing pre-delete assertions for the Software data member.
 void setCandidate(CandidateBDO Candidate)
          Set Candidate of the SoftwareCandidateDO
 void setCandidate(CandidateDO Candidate)
          Set Candidate of the SoftwareCandidateDO
 void setCapability(CompcapabilityBDO Capability)
          Set Capability of the SoftwareCandidateDO
 void setCapability(CompcapabilityDO Capability)
          Set Capability of the SoftwareCandidateDO
 void setSoftware(SoftwareBDO Software)
          Set Software of the SoftwareCandidateDO
 void setSoftware(SoftwareDO Software)
          Set Software of the SoftwareCandidateDO
 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 SoftwareCandidateDO DO
The SoftwareCandidateDO object upon which the set and get methods operate. This member is protected so that classes derived from SoftwareCandidateBDO can access the underlying Data Object.
Constructor Detail

SoftwareCandidateBDO

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

SoftwareCandidateBDO

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

getDO

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

getBDOarray

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

getCapability

public CompcapabilityDO getCapability()
                               throws jobmatch.data.DataObjectException
Get Capability of the SoftwareCandidateDO
Returns:
Capability of the SoftwareCandidateDO
Throws:
jobmatch.data.DataObjectException - If the object is not found in the database.

setCapability

public void setCapability(CompcapabilityDO Capability)
                   throws jobmatch.data.DataObjectException
Set Capability of the SoftwareCandidateDO
Parameters:
Capability - of the SoftwareCandidateDO
Throws:
jobmatch.data.DataObjectException - If the object is not found in the database.

getCapabilityBDO

public CompcapabilityBDO getCapabilityBDO()
                                   throws jobmatch.data.DataObjectException
Get BDO-wrapped Capability of the SoftwareCandidateDO
Returns:
BDO-wrapped Capability of the SoftwareCandidateDO
Throws:
jobmatch.data.DataObjectException - If the object is not found in the database.

setCapability

public void setCapability(CompcapabilityBDO Capability)
                   throws jobmatch.data.DataObjectException
Set Capability of the SoftwareCandidateDO
Parameters:
BDO-wrapped - Capability of the SoftwareCandidateDO
Throws:
jobmatch.data.DataObjectException - If the object is not found in the database.

getSoftware

public SoftwareDO getSoftware()
                       throws jobmatch.data.DataObjectException
Get Software of the SoftwareCandidateDO
Returns:
Software of the SoftwareCandidateDO
Throws:
jobmatch.data.DataObjectException - If the object is not found in the database.

setSoftware

public void setSoftware(SoftwareDO Software)
                 throws jobmatch.data.DataObjectException
Set Software of the SoftwareCandidateDO
Parameters:
Software - of the SoftwareCandidateDO
Throws:
jobmatch.data.DataObjectException - If the object is not found in the database.

getSoftwareBDO

public SoftwareBDO getSoftwareBDO()
                           throws jobmatch.data.DataObjectException
Get BDO-wrapped Software of the SoftwareCandidateDO
Returns:
BDO-wrapped Software of the SoftwareCandidateDO
Throws:
jobmatch.data.DataObjectException - If the object is not found in the database.

setSoftware

public void setSoftware(SoftwareBDO Software)
                 throws jobmatch.data.DataObjectException
Set Software of the SoftwareCandidateDO
Parameters:
BDO-wrapped - Software of the SoftwareCandidateDO
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.

okToCommitCapability

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

okToDeleteCapability

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

okToCommitSoftware

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

okToDeleteSoftware

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