jobmatch.data
Class SoftwareProfileBDO

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

public class SoftwareProfileBDO

extends Object

implements Serializable

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

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

Constructor Summary

SoftwareProfileBDO()
Constructor required by SoftwareProfileBDO.create methods.

SoftwareProfileBDO(SoftwareProfileDO DO)
Constructor for use by classes derived from SoftwareProfileBDO.

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 SoftwareProfileBDO	createExisting(SoftwareProfileDO DO) The createExisting method is used to create a SoftwareProfileBDO from a SoftwareProfileDO that was returned by the SoftwareProfileQuery class.
static SoftwareProfileBDO	createVirgin() Like the class SoftwareProfileDO, 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 SoftwareProfileBDO[]	getBDOarray() The getBDOarray method performs a database query to return an array of SoftwareProfileBDO objects representing all the rows in the SoftwareProfile table.
SoftwareProfileDO	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 SoftwareProfileBDO objects as options.
int	getLeafNumber() Get LeafNumber of the SoftwareProfileDO
boolean	getMandatory() Get Mandatory of the SoftwareProfileDO
CompcapabilityDO	getMinCapability() Get MinCapability of the SoftwareProfileDO
CompcapabilityBDO	getMinCapabilityBDO() Get BDO-wrapped MinCapability of the SoftwareProfileDO
ProfileDO	getProfile() Get Profile of the SoftwareProfileDO
ProfileBDO	getProfileBDO() Get BDO-wrapped Profile of the SoftwareProfileDO
SoftwareDO	getSoftware() Get Software of the SoftwareProfileDO
SoftwareBDO	getSoftwareBDO() Get BDO-wrapped Software of the SoftwareProfileDO
boolean	hasMatchingHandle(String handle)
protected void	modifyDO(jobmatch.data.DBTransaction dbt, boolean delete) Modifies the DO within its table.
protected void	okToCommitMinCapability(CompcapabilityDO member) A stub method for implementing pre-commit assertions for the MinCapability data member.
protected void	okToCommitProfile(ProfileDO member) A stub method for implementing pre-commit assertions for the Profile data member.
protected void	okToCommitSoftware(SoftwareDO member) A stub method for implementing pre-commit assertions for the Software data member.
protected void	okToDeleteMinCapability(CompcapabilityDO member) A stub method for implementing pre-delete assertions for the MinCapability data member.
protected void	okToDeleteProfile(ProfileDO member) A stub method for implementing pre-delete assertions for the Profile data member.
protected void	okToDeleteSoftware(SoftwareDO member) A stub method for implementing pre-delete assertions for the Software data member.
void	setLeafNumber(int LeafNumber) Set LeafNumber of the SoftwareProfileDO
void	setMandatory(boolean Mandatory) Set Mandatory of the SoftwareProfileDO
void	setMinCapability(CompcapabilityBDO MinCapability) Set MinCapability of the SoftwareProfileDO
void	setMinCapability(CompcapabilityDO MinCapability) Set MinCapability of the SoftwareProfileDO
void	setProfile(ProfileBDO Profile) Set Profile of the SoftwareProfileDO
void	setProfile(ProfileDO Profile) Set Profile of the SoftwareProfileDO
void	setSoftware(SoftwareBDO Software) Set Software of the SoftwareProfileDO
void	setSoftware(SoftwareDO Software) Set Software of the SoftwareProfileDO
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 SoftwareProfileDO DO

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

Constructor Detail

SoftwareProfileBDO

public SoftwareProfileBDO(SoftwareProfileDO DO)

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

SoftwareProfileBDO

public SoftwareProfileBDO()
                   throws Exception

Constructor required by SoftwareProfileBDO.create methods.

Method Detail

getDO

public SoftwareProfileDO 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 SoftwareProfileBDO createVirgin()
                                       throws Exception

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

The createExisting method is used to create a SoftwareProfileBDO from a SoftwareProfileDO that was returned by the SoftwareProfileQuery class.

getBDOarray

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

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

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

getLeafNumber

public int getLeafNumber()
                  throws jobmatch.data.DataObjectException

Get LeafNumber of the SoftwareProfileDO

Returns:

LeafNumber of the SoftwareProfileDO

Throws:

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

setLeafNumber

public void setLeafNumber(int LeafNumber)
                   throws jobmatch.data.DataObjectException

Set LeafNumber of the SoftwareProfileDO

Parameters:

LeafNumber - of the SoftwareProfileDO

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 SoftwareProfileDO

Returns:

Profile of the SoftwareProfileDO

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 SoftwareProfileDO

Parameters:

Profile - of the SoftwareProfileDO

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 SoftwareProfileDO

Returns:

BDO-wrapped Profile of the SoftwareProfileDO

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 SoftwareProfileDO

Parameters:

BDO-wrapped - Profile of the SoftwareProfileDO

Throws:

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

getMandatory

public boolean getMandatory()
                     throws jobmatch.data.DataObjectException

Get Mandatory of the SoftwareProfileDO

Returns:

Mandatory of the SoftwareProfileDO

Throws:

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

setMandatory

public void setMandatory(boolean Mandatory)
                  throws jobmatch.data.DataObjectException

Set Mandatory of the SoftwareProfileDO

Parameters:

Mandatory - of the SoftwareProfileDO

Throws:

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

getMinCapability

public CompcapabilityDO getMinCapability()
                                  throws jobmatch.data.DataObjectException

Get MinCapability of the SoftwareProfileDO

Returns:

MinCapability of the SoftwareProfileDO

Throws:

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

setMinCapability

public void setMinCapability(CompcapabilityDO MinCapability)
                      throws jobmatch.data.DataObjectException

Set MinCapability of the SoftwareProfileDO

Parameters:

MinCapability - of the SoftwareProfileDO

Throws:

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

getMinCapabilityBDO

public CompcapabilityBDO getMinCapabilityBDO()
                                      throws jobmatch.data.DataObjectException

Get BDO-wrapped MinCapability of the SoftwareProfileDO

Returns:

BDO-wrapped MinCapability of the SoftwareProfileDO

Throws:

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

setMinCapability

public void setMinCapability(CompcapabilityBDO MinCapability)
                      throws jobmatch.data.DataObjectException

Set MinCapability of the SoftwareProfileDO

Parameters:

BDO-wrapped - MinCapability of the SoftwareProfileDO

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 SoftwareProfileDO

Returns:

Software of the SoftwareProfileDO

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 SoftwareProfileDO

Parameters:

Software - of the SoftwareProfileDO

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 SoftwareProfileDO

Returns:

BDO-wrapped Software of the SoftwareProfileDO

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 SoftwareProfileDO

Parameters:

BDO-wrapped - Software of the SoftwareProfileDO

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.

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.

okToCommitMinCapability

protected void okToCommitMinCapability(CompcapabilityDO member)
                                throws jobmatch.data.RefAssertionException

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

okToDeleteMinCapability

protected void okToDeleteMinCapability(CompcapabilityDO member)
                                throws jobmatch.data.RefAssertionException

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