br.usp.ime.xpusp.om
Class BaseCourse

java.lang.Object
  |
  +--org.apache.turbine.om.BaseObject
        |
        +--br.usp.ime.xpusp.om.BaseCourse

All Implemented Interfaces:

org.apache.turbine.om.Persistent, org.apache.turbine.om.Retrievable, java.io.Serializable

Direct Known Subclasses:

Course

public abstract class BaseCourse

extends org.apache.turbine.om.BaseObject

implements org.apache.turbine.om.Retrievable

This class was autogenerated by Torque. You should not use this class directly. It should not even be extended all references should be to Course

See Also:

Serialized Form

Field Summary

private Department	aDepartment
private boolean	alreadyInSave
private Source	aSource
private Unit	aUnit
protected java.util.Vector	collCourseDisciplines Collection to store aggregation of collCourseDisciplines
protected java.util.Vector	collPoolResultss Collection to store aggregation of collPoolResultss
protected java.util.Vector	collStudents Collection to store aggregation of collStudents
private org.apache.turbine.om.ComboKey	comboPK
private org.apache.turbine.om.NumberKey	course_id the value for the course_id field
private org.apache.turbine.om.StringKey	department_code the value for the department_code field
private org.apache.turbine.om.NumberKey	hab_id the value for the hab_id field
private org.apache.turbine.util.db.Criteria	lastCourseDisciplinesCriteria The criteria used to select the current contents of collCourseDisciplines
private org.apache.turbine.util.db.Criteria	lastPoolResultssCriteria The criteria used to select the current contents of collPoolResultss
private org.apache.turbine.util.db.Criteria	lastStudentsCriteria The criteria used to select the current contents of collStudents
private java.lang.String	name the value for the name field
private java.lang.String	period the value for the period field
private org.apache.turbine.om.SimpleKey[]	pks
private org.apache.turbine.om.NumberKey	source_id the value for the source_id field
private org.apache.turbine.om.NumberKey	unit_id the value for the unit_id field

Fields inherited from class org.apache.turbine.om.BaseObject

errMsg, is_new, modified, NEW_ID, primaryKey

Constructor Summary

BaseCourse()

Method Summary

void	addCourseDiscipline(CourseDiscipline l) Method called to associate a CourseDiscipline object to this object through the CourseDiscipline foreign key attribute
void	addPoolResults(PoolResults l) Method called to associate a PoolResults object to this object through the PoolResults foreign key attribute
void	addStudent(Student l) Method called to associate a Student object to this object through the Student foreign key attribute
Course	copy() Makes a copy of this object.
java.util.Vector	getCourseDisciplines() If this collection has already been initialized, returns the collection.
java.util.Vector	getCourseDisciplines(org.apache.turbine.util.db.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
protected java.util.Vector	getCourseDisciplinesJoinDiscipline(org.apache.turbine.util.db.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
org.apache.turbine.om.NumberKey	getCourseId() Get the CourseId
Department	getDepartment()
org.apache.turbine.om.StringKey	getDepartmentCode() Get the DepartmentCode
org.apache.turbine.om.NumberKey	getHabId() Get the HabId
java.lang.String	getName() Get the Name
java.lang.String	getPeriod() Get the Period
java.util.Vector	getPoolResultss() If this collection has already been initialized, returns the collection.
java.util.Vector	getPoolResultss(org.apache.turbine.util.db.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
protected java.util.Vector	getPoolResultssJoinYear(org.apache.turbine.util.db.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
org.apache.turbine.om.ObjectKey	getPrimaryKey() returns an id that differentiates this object from others of its class.
java.lang.String	getQueryKey() get an id that differentiates this object from others of its class.
Source	getSource()
org.apache.turbine.om.NumberKey	getSourceId() Get the SourceId
java.util.Vector	getStudents() If this collection has already been initialized, returns the collection.
java.util.Vector	getStudents(org.apache.turbine.util.db.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
Unit	getUnit()
org.apache.turbine.om.NumberKey	getUnitId() Get the UnitId
protected void	initCourseDisciplines() Temporary storage of collCourseDisciplines to save a possible db hit in the event objects are add to the collection, but the complete collection is never requested.
protected void	initPoolResultss() Temporary storage of collPoolResultss to save a possible db hit in the event objects are add to the collection, but the complete collection is never requested.
protected void	initStudents() Temporary storage of collStudents to save a possible db hit in the event objects are add to the collection, but the complete collection is never requested.
void	save() Stores the object in the database.
void	save(org.apache.turbine.util.db.pool.DBConnection dbCon) Stores the object in the database.
void	save(java.lang.String dbName) Stores the object in the database.
void	setCourseId(org.apache.turbine.om.NumberKey v) Set the value of CourseId
void	setCourseId(java.lang.String v) Set the value of CourseId as a string.
void	setDepartment(Department v) Declares an association between this object and a Department object
void	setDepartmentCode(java.lang.String v) Set the value of DepartmentCode as a string.
void	setDepartmentCode(org.apache.turbine.om.StringKey v) Set the value of DepartmentCode
void	setDepartmentKey(org.apache.turbine.om.ObjectKey key) Provides convenient way to set a relationship based on a ObjectKey.
void	setHabId(org.apache.turbine.om.NumberKey v) Set the value of HabId
void	setHabId(java.lang.String v) Set the value of HabId as a string.
void	setName(java.lang.String v) Set the value of Name
void	setPeriod(java.lang.String v) Set the value of Period
void	setPrimaryKey(org.apache.turbine.om.NumberKey course_id, org.apache.turbine.om.NumberKey hab_id) Set the PrimaryKey using SimpleKeys.
void	setPrimaryKey(org.apache.turbine.om.ObjectKey key) Set the PrimaryKey with an ObjectKey
void	setPrimaryKey(java.lang.String key) Set the PrimaryKey using a String.
void	setPrimaryKey(java.lang.String course_id, java.lang.String hab_id) Set the PrimaryKey with Strings.
void	setQueryKey(java.lang.String key) set an id that differentiates this object from others of its class.
void	setSource(Source v) Declares an association between this object and a Source object
void	setSourceId(org.apache.turbine.om.NumberKey v) Set the value of SourceId
void	setSourceId(java.lang.String v) Set the value of SourceId as a string.
void	setSourceKey(org.apache.turbine.om.ObjectKey key) Provides convenient way to set a relationship based on a ObjectKey.
void	setUnit(Unit v) Declares an association between this object and a Unit object
void	setUnitId(org.apache.turbine.om.NumberKey v) Set the value of UnitId
void	setUnitId(java.lang.String v) Set the value of UnitId as a string.
void	setUnitKey(org.apache.turbine.om.ObjectKey key) Provides convenient way to set a relationship based on a ObjectKey.

Methods inherited from class org.apache.turbine.om.BaseObject

, equals, equals, getByName, getByPeerName, getByPosition, getPrimaryKeyAsBigDecimal, getPrimaryKeyAsInt, getPrimaryKeyAsLong, getPrimaryKeyAsString, hashCode, isModified, isNew, resetModified, setModified, setNew, setPrimaryKey, setPrimaryKey, setPrimaryKey

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, registerNatives, toString, wait, wait, wait

Field Detail

course_id

private org.apache.turbine.om.NumberKey course_id

the value for the course_id field

hab_id

private org.apache.turbine.om.NumberKey hab_id

the value for the hab_id field

department_code

private org.apache.turbine.om.StringKey department_code

the value for the department_code field

name

private java.lang.String name

the value for the name field

period

private java.lang.String period

the value for the period field

unit_id

private org.apache.turbine.om.NumberKey unit_id

the value for the unit_id field

source_id

private org.apache.turbine.om.NumberKey source_id

the value for the source_id field

aSource

private Source aSource

aDepartment

private Department aDepartment

aUnit

private Unit aUnit

collStudents

protected java.util.Vector collStudents

Collection to store aggregation of collStudents

lastStudentsCriteria

private org.apache.turbine.util.db.Criteria lastStudentsCriteria

The criteria used to select the current contents of collStudents

collPoolResultss

protected java.util.Vector collPoolResultss

Collection to store aggregation of collPoolResultss

lastPoolResultssCriteria

private org.apache.turbine.util.db.Criteria lastPoolResultssCriteria

The criteria used to select the current contents of collPoolResultss

collCourseDisciplines

protected java.util.Vector collCourseDisciplines

Collection to store aggregation of collCourseDisciplines

lastCourseDisciplinesCriteria

private org.apache.turbine.util.db.Criteria lastCourseDisciplinesCriteria

The criteria used to select the current contents of collCourseDisciplines

alreadyInSave

private boolean alreadyInSave

pks

private final org.apache.turbine.om.SimpleKey[] pks

comboPK

private final org.apache.turbine.om.ComboKey comboPK

Constructor Detail

BaseCourse

public BaseCourse()

Method Detail

getCourseId

public org.apache.turbine.om.NumberKey getCourseId()

Get the CourseId

Returns:

NumberKey

setCourseId

public void setCourseId(org.apache.turbine.om.NumberKey v)
                 throws java.lang.Exception

Set the value of CourseId

setCourseId

public void setCourseId(java.lang.String v)
                 throws java.lang.Exception

Set the value of CourseId as a string.

getHabId

public org.apache.turbine.om.NumberKey getHabId()

Get the HabId

Returns:

NumberKey

setHabId

public void setHabId(org.apache.turbine.om.NumberKey v)
              throws java.lang.Exception

Set the value of HabId

setHabId

public void setHabId(java.lang.String v)
              throws java.lang.Exception

Set the value of HabId as a string.

getDepartmentCode

public org.apache.turbine.om.StringKey getDepartmentCode()

Get the DepartmentCode

Returns:

StringKey

setDepartmentCode

public void setDepartmentCode(org.apache.turbine.om.StringKey v)
                       throws java.lang.Exception

Set the value of DepartmentCode

setDepartmentCode

public void setDepartmentCode(java.lang.String v)
                       throws java.lang.Exception

Set the value of DepartmentCode as a string.

getName

public java.lang.String getName()

Get the Name

Returns:

String

setName

public void setName(java.lang.String v)

Set the value of Name

getPeriod

public java.lang.String getPeriod()

Get the Period

Returns:

String

setPeriod

public void setPeriod(java.lang.String v)

Set the value of Period

getUnitId

public org.apache.turbine.om.NumberKey getUnitId()

Get the UnitId

Returns:

NumberKey

setUnitId

public void setUnitId(org.apache.turbine.om.NumberKey v)
               throws java.lang.Exception

Set the value of UnitId

setUnitId

public void setUnitId(java.lang.String v)
               throws java.lang.Exception

Set the value of UnitId as a string.

getSourceId

public org.apache.turbine.om.NumberKey getSourceId()

Get the SourceId

Returns:

NumberKey

setSourceId

public void setSourceId(org.apache.turbine.om.NumberKey v)
                 throws java.lang.Exception

Set the value of SourceId

setSourceId

public void setSourceId(java.lang.String v)
                 throws java.lang.Exception

Set the value of SourceId as a string.

setSource

public void setSource(Source v)
               throws java.lang.Exception

Declares an association between this object and a Source object

Parameters:

Source - v

getSource

public Source getSource()
                 throws java.lang.Exception

setSourceKey

public void setSourceKey(org.apache.turbine.om.ObjectKey key)
                  throws java.lang.Exception

Provides convenient way to set a relationship based on a ObjectKey. e.g. bar.setFooKey(foo.getPrimaryKey())

setDepartment

public void setDepartment(Department v)
                   throws java.lang.Exception

Declares an association between this object and a Department object

Parameters:

Department - v

getDepartment

public Department getDepartment()
                         throws java.lang.Exception

setDepartmentKey

public void setDepartmentKey(org.apache.turbine.om.ObjectKey key)
                      throws java.lang.Exception

Provides convenient way to set a relationship based on a ObjectKey. e.g. bar.setFooKey(foo.getPrimaryKey())

setUnit

public void setUnit(Unit v)
             throws java.lang.Exception

Declares an association between this object and a Unit object

Parameters:

Unit - v

getUnit

public Unit getUnit()
             throws java.lang.Exception

setUnitKey

public void setUnitKey(org.apache.turbine.om.ObjectKey key)
                throws java.lang.Exception

Provides convenient way to set a relationship based on a ObjectKey. e.g. bar.setFooKey(foo.getPrimaryKey())

initStudents

protected void initStudents()

Temporary storage of collStudents to save a possible db hit in the event objects are add to the collection, but the complete collection is never requested.

addStudent

public void addStudent(Student l)
                throws java.lang.Exception

Method called to associate a Student object to this object through the Student foreign key attribute

Parameters:

Student - l

getStudents

public java.util.Vector getStudents()
                             throws java.lang.Exception

If this collection has already been initialized, returns the collection. Otherwise returns the results of getStudents(new Criteria())

getStudents

public java.util.Vector getStudents(org.apache.turbine.util.db.Criteria criteria)
                             throws java.lang.Exception

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this Course has previously been saved, it will retrieve related Students from storage. If this Course is new, it will return an empty collection or the current collection, the criteria is ignored on a new object.

initPoolResultss

protected void initPoolResultss()

Temporary storage of collPoolResultss to save a possible db hit in the event objects are add to the collection, but the complete collection is never requested.

addPoolResults

public void addPoolResults(PoolResults l)
                    throws java.lang.Exception

Method called to associate a PoolResults object to this object through the PoolResults foreign key attribute

Parameters:

PoolResults - l

getPoolResultss

public java.util.Vector getPoolResultss()
                                 throws java.lang.Exception

If this collection has already been initialized, returns the collection. Otherwise returns the results of getPoolResultss(new Criteria())

getPoolResultss

public java.util.Vector getPoolResultss(org.apache.turbine.util.db.Criteria criteria)
                                 throws java.lang.Exception

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this Course has previously been saved, it will retrieve related PoolResultss from storage. If this Course is new, it will return an empty collection or the current collection, the criteria is ignored on a new object.

getPoolResultssJoinYear

protected java.util.Vector getPoolResultssJoinYear(org.apache.turbine.util.db.Criteria criteria)
                                            throws java.lang.Exception

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this Course is new, it will return an empty collection; or if this Course has previously been saved, it will retrieve related PoolResultss from storage.

initCourseDisciplines

protected void initCourseDisciplines()

Temporary storage of collCourseDisciplines to save a possible db hit in the event objects are add to the collection, but the complete collection is never requested.

addCourseDiscipline

public void addCourseDiscipline(CourseDiscipline l)
                         throws java.lang.Exception

Method called to associate a CourseDiscipline object to this object through the CourseDiscipline foreign key attribute

Parameters:

CourseDiscipline - l

getCourseDisciplines

public java.util.Vector getCourseDisciplines()
                                      throws java.lang.Exception

If this collection has already been initialized, returns the collection. Otherwise returns the results of getCourseDisciplines(new Criteria())

getCourseDisciplines

public java.util.Vector getCourseDisciplines(org.apache.turbine.util.db.Criteria criteria)
                                      throws java.lang.Exception

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this Course has previously been saved, it will retrieve related CourseDisciplines from storage. If this Course is new, it will return an empty collection or the current collection, the criteria is ignored on a new object.

getCourseDisciplinesJoinDiscipline

protected java.util.Vector getCourseDisciplinesJoinDiscipline(org.apache.turbine.util.db.Criteria criteria)
                                                       throws java.lang.Exception

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this Course is new, it will return an empty collection; or if this Course has previously been saved, it will retrieve related CourseDisciplines from storage.

save

public void save()
          throws java.lang.Exception

Stores the object in the database. If the object is new, it inserts it; otherwise an update is performed.

Overrides:

save in class org.apache.turbine.om.BaseObject

save

public void save(java.lang.String dbName)
          throws java.lang.Exception

Stores the object in the database. If the object is new, it inserts it; otherwise an update is performed.

save

public void save(org.apache.turbine.util.db.pool.DBConnection dbCon)
          throws java.lang.Exception

Stores the object in the database. If the object is new, it inserts it; otherwise an update is performed. This method is meant to be used as part of a transaction, otherwise use the save() method and the connection details will be handled internally

setPrimaryKey

public void setPrimaryKey(org.apache.turbine.om.ObjectKey key)
                   throws java.lang.Exception

Set the PrimaryKey with an ObjectKey

Overrides:

setPrimaryKey in class org.apache.turbine.om.BaseObject

setPrimaryKey

public void setPrimaryKey(org.apache.turbine.om.NumberKey course_id,
                          org.apache.turbine.om.NumberKey hab_id)
                   throws java.lang.Exception

Set the PrimaryKey using SimpleKeys.

Parameters:

NumberKey - course_id

NumberKey - hab_id

setPrimaryKey

public void setPrimaryKey(java.lang.String course_id,
                          java.lang.String hab_id)
                   throws java.lang.Exception

Set the PrimaryKey with Strings.

Parameters:

String - course_id

String - hab_id

setPrimaryKey

public void setPrimaryKey(java.lang.String key)
                   throws java.lang.Exception

Set the PrimaryKey using a String.

Overrides:

setPrimaryKey in class org.apache.turbine.om.BaseObject

getPrimaryKey

public org.apache.turbine.om.ObjectKey getPrimaryKey()

returns an id that differentiates this object from others of its class.

Overrides:

getPrimaryKey in class org.apache.turbine.om.BaseObject

getQueryKey

public java.lang.String getQueryKey()

get an id that differentiates this object from others of its class.

Specified by:

getQueryKey in interface org.apache.turbine.om.Retrievable

setQueryKey

public void setQueryKey(java.lang.String key)
                 throws java.lang.Exception

set an id that differentiates this object from others of its class.

Specified by:

setQueryKey in interface org.apache.turbine.om.Retrievable

copy

public Course copy()
            throws java.lang.Exception

Makes a copy of this object. It creates a new object filling in the simple attributes. It then fills all the association collections and sets the related objects to isNew=true.