jobmatch.data
Class SchoolProfileBDO

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

public class SchoolProfileBDO

extends Object

implements Serializable

SchoolProfileBDO contains the same set and get methods as the SchoolProfileDO 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.3 $

See Also:

Serialized Form

Field Summary

protected SchoolProfileDO

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

Constructor Summary

SchoolProfileBDO()
Constructor required by SchoolProfileBDO.create methods.

SchoolProfileBDO(SchoolProfileDO DO)
Constructor for use by classes derived from SchoolProfileBDO.

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 SchoolProfileBDO	createExisting(SchoolProfileDO DO) The createExisting method is used to create a SchoolProfileBDO from a SchoolProfileDO that was returned by the SchoolProfileQuery class.
static SchoolProfileBDO	createVirgin() Like the class SchoolProfileDO, 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 SchoolProfileBDO[]	getBDOarray() The getBDOarray method performs a database query to return an array of SchoolProfileBDO objects representing all the rows in the SchoolProfile table.
SchoolProfileDO	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 SchoolProfileBDO objects as options.
int	getLeafNumber() Get LeafNumber of the SchoolProfileDO
boolean	getMandatory() Get Mandatory of the SchoolProfileDO
SchooltypeDO	getMaxSchoolType() Get MaxSchoolType of the SchoolProfileDO
SchooltypeBDO	getMaxSchoolTypeBDO() Get BDO-wrapped MaxSchoolType of the SchoolProfileDO
SchooltypeDO	getMinSchoolType() Get MinSchoolType of the SchoolProfileDO
SchooltypeBDO	getMinSchoolTypeBDO() Get BDO-wrapped MinSchoolType of the SchoolProfileDO
ProfileDO	getProfile() Get Profile of the SchoolProfileDO
ProfileBDO	getProfileBDO() Get BDO-wrapped Profile of the SchoolProfileDO
boolean	hasMatchingHandle(String handle)
protected void	modifyDO(jobmatch.data.DBTransaction dbt, boolean delete) Modifies the DO within its table.
protected void	okToCommitMaxSchoolType(SchooltypeDO member) A stub method for implementing pre-commit assertions for the MaxSchoolType data member.
protected void	okToCommitMinSchoolType(SchooltypeDO member) A stub method for implementing pre-commit assertions for the MinSchoolType data member.
protected void	okToCommitProfile(ProfileDO member) A stub method for implementing pre-commit assertions for the Profile data member.
protected void	okToDeleteMaxSchoolType(SchooltypeDO member) A stub method for implementing pre-delete assertions for the MaxSchoolType data member.
protected void	okToDeleteMinSchoolType(SchooltypeDO member) A stub method for implementing pre-delete assertions for the MinSchoolType data member.
protected void	okToDeleteProfile(ProfileDO member) A stub method for implementing pre-delete assertions for the Profile data member.
void	setLeafNumber(int LeafNumber) Set LeafNumber of the SchoolProfileDO
void	setMandatory(boolean Mandatory) Set Mandatory of the SchoolProfileDO
void	setMaxSchoolType(SchooltypeBDO MaxSchoolType) Set MaxSchoolType of the SchoolProfileDO
void	setMaxSchoolType(SchooltypeDO MaxSchoolType) Set MaxSchoolType of the SchoolProfileDO
void	setMinSchoolType(SchooltypeBDO MinSchoolType) Set MinSchoolType of the SchoolProfileDO
void	setMinSchoolType(SchooltypeDO MinSchoolType) Set MinSchoolType of the SchoolProfileDO
void	setProfile(ProfileBDO Profile) Set Profile of the SchoolProfileDO
void	setProfile(ProfileDO Profile) Set Profile of the SchoolProfileDO
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 SchoolProfileDO DO

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

Constructor Detail

SchoolProfileBDO

public SchoolProfileBDO(SchoolProfileDO DO)

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

SchoolProfileBDO

public SchoolProfileBDO()
                 throws Exception

Constructor required by SchoolProfileBDO.create methods.

Method Detail

getDO

public SchoolProfileDO 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 SchoolProfileBDO createVirgin()
                                     throws Exception

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

The createExisting method is used to create a SchoolProfileBDO from a SchoolProfileDO that was returned by the SchoolProfileQuery class.

getBDOarray

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

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

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 SchoolProfileDO

Returns:

LeafNumber of the SchoolProfileDO

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 SchoolProfileDO

Parameters:

LeafNumber - of the SchoolProfileDO

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 SchoolProfileDO

Returns:

Profile of the SchoolProfileDO

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 SchoolProfileDO

Parameters:

Profile - of the SchoolProfileDO

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 SchoolProfileDO

Returns:

BDO-wrapped Profile of the SchoolProfileDO

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 SchoolProfileDO

Parameters:

BDO-wrapped - Profile of the SchoolProfileDO

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 SchoolProfileDO

Returns:

Mandatory of the SchoolProfileDO

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 SchoolProfileDO

Parameters:

Mandatory - of the SchoolProfileDO

Throws:

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

getMinSchoolType

public SchooltypeDO getMinSchoolType()
                              throws jobmatch.data.DataObjectException

Get MinSchoolType of the SchoolProfileDO

Returns:

MinSchoolType of the SchoolProfileDO

Throws:

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

setMinSchoolType

public void setMinSchoolType(SchooltypeDO MinSchoolType)
                      throws jobmatch.data.DataObjectException

Set MinSchoolType of the SchoolProfileDO

Parameters:

MinSchoolType - of the SchoolProfileDO

Throws:

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

getMinSchoolTypeBDO

public SchooltypeBDO getMinSchoolTypeBDO()
                                  throws jobmatch.data.DataObjectException

Get BDO-wrapped MinSchoolType of the SchoolProfileDO

Returns:

BDO-wrapped MinSchoolType of the SchoolProfileDO

Throws:

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

setMinSchoolType

public void setMinSchoolType(SchooltypeBDO MinSchoolType)
                      throws jobmatch.data.DataObjectException

Set MinSchoolType of the SchoolProfileDO

Parameters:

BDO-wrapped - MinSchoolType of the SchoolProfileDO

Throws:

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

getMaxSchoolType

public SchooltypeDO getMaxSchoolType()
                              throws jobmatch.data.DataObjectException

Get MaxSchoolType of the SchoolProfileDO

Returns:

MaxSchoolType of the SchoolProfileDO

Throws:

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

setMaxSchoolType

public void setMaxSchoolType(SchooltypeDO MaxSchoolType)
                      throws jobmatch.data.DataObjectException

Set MaxSchoolType of the SchoolProfileDO

Parameters:

MaxSchoolType - of the SchoolProfileDO

Throws:

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

getMaxSchoolTypeBDO

public SchooltypeBDO getMaxSchoolTypeBDO()
                                  throws jobmatch.data.DataObjectException

Get BDO-wrapped MaxSchoolType of the SchoolProfileDO

Returns:

BDO-wrapped MaxSchoolType of the SchoolProfileDO

Throws:

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

setMaxSchoolType

public void setMaxSchoolType(SchooltypeBDO MaxSchoolType)
                      throws jobmatch.data.DataObjectException

Set MaxSchoolType of the SchoolProfileDO

Parameters:

BDO-wrapped - MaxSchoolType of the SchoolProfileDO

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.

okToCommitMinSchoolType

protected void okToCommitMinSchoolType(SchooltypeDO member)
                                throws jobmatch.data.RefAssertionException

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

okToDeleteMinSchoolType

protected void okToDeleteMinSchoolType(SchooltypeDO member)
                                throws jobmatch.data.RefAssertionException

A stub method for implementing pre-delete assertions for the MinSchoolType data member. Implement this stub to throw an RefAssertionException for cases where MinSchoolType is not valid for deletion from the database.

okToCommitMaxSchoolType

protected void okToCommitMaxSchoolType(SchooltypeDO member)
                                throws jobmatch.data.RefAssertionException

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

okToDeleteMaxSchoolType

protected void okToDeleteMaxSchoolType(SchooltypeDO member)
                                throws jobmatch.data.RefAssertionException

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