br.usp.ime.xpusp.om
Class BasePoolResults

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

All Implemented Interfaces:

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

Direct Known Subclasses:

PoolResults

public abstract class BasePoolResults

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 PoolResults

See Also:

Serialized Form

Field Summary

private Course	aCourse
private boolean	alreadyInSave
private Year	aYear
protected java.util.Vector	collElectivePools Collection to store aggregation of collElectivePools
protected java.util.Vector	collRequiredPools Collection to store aggregation of collRequiredPools
private org.apache.turbine.om.NumberKey	course_id the value for the course_id field
private org.apache.turbine.om.NumberKey	hab_id the value for the hab_id field
private org.apache.turbine.util.db.Criteria	lastElectivePoolsCriteria The criteria used to select the current contents of collElectivePools
private org.apache.turbine.util.db.Criteria	lastRequiredPoolsCriteria The criteria used to select the current contents of collRequiredPools
private org.apache.turbine.om.NumberKey	pool_id the value for the pool_id field
private int	students_course the value for the students_course field
private int	students_pooled the value for the students_pooled field
private org.apache.turbine.om.NumberKey	year_id the value for the year_id field

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

errMsg, is_new, modified, NEW_ID, primaryKey

Constructor Summary

BasePoolResults()

Method Summary

void	addElectivePool(ElectivePool l) Method called to associate a ElectivePool object to this object through the ElectivePool foreign key attribute
void	addRequiredPool(RequiredPool l) Method called to associate a RequiredPool object to this object through the RequiredPool foreign key attribute
PoolResults	copy() Makes a copy of this object.
Course	getCourse()
org.apache.turbine.om.NumberKey	getCourseId() Get the CourseId
java.util.Vector	getElectivePools() If this collection has already been initialized, returns the collection.
java.util.Vector	getElectivePools(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	getElectivePoolsJoinDiscipline(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	getHabId() Get the HabId
org.apache.turbine.om.NumberKey	getPoolId() Get the PoolId
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.
java.util.Vector	getRequiredPools() If this collection has already been initialized, returns the collection.
java.util.Vector	getRequiredPools(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	getRequiredPoolsJoinDiscipline(org.apache.turbine.util.db.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
int	getStudentsCourse() Get the StudentsCourse
int	getStudentsPooled() Get the StudentsPooled
Year	getYear()
org.apache.turbine.om.NumberKey	getYearId() Get the YearId
protected void	initElectivePools() Temporary storage of collElectivePools to save a possible db hit in the event objects are add to the collection, but the complete collection is never requested.
protected void	initRequiredPools() Temporary storage of collRequiredPools 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	setCourse(Course v) Declares an association between this object and a Course object
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	setCourseKey(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	setPoolId(org.apache.turbine.om.NumberKey v) Set the value of PoolId
void	setPoolId(java.lang.String v) Set the value of PoolId as a string.
void	setPrimaryKey(org.apache.turbine.om.ObjectKey pool_id) Set the PrimaryKey using ObjectKey.
void	setPrimaryKey(java.lang.String key) Set the PrimaryKey using a String.
void	setQueryKey(java.lang.String key) set an id that differentiates this object from others of its class.
void	setStudentsCourse(int v) Set the value of StudentsCourse
void	setStudentsPooled(int v) Set the value of StudentsPooled
void	setYear(Year v) Declares an association between this object and a Year object
void	setYearId(org.apache.turbine.om.NumberKey v) Set the value of YearId
void	setYearId(java.lang.String v) Set the value of YearId as a string.
void	setYearKey(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

pool_id

private org.apache.turbine.om.NumberKey pool_id

the value for the pool_id field

year_id

private org.apache.turbine.om.NumberKey year_id

the value for the year_id field

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

students_pooled

private int students_pooled

the value for the students_pooled field

students_course

private int students_course

the value for the students_course field

aYear

private Year aYear

aCourse

private Course aCourse

collRequiredPools

protected java.util.Vector collRequiredPools

Collection to store aggregation of collRequiredPools

lastRequiredPoolsCriteria

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

The criteria used to select the current contents of collRequiredPools

collElectivePools

protected java.util.Vector collElectivePools

Collection to store aggregation of collElectivePools

lastElectivePoolsCriteria

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

The criteria used to select the current contents of collElectivePools

alreadyInSave

private boolean alreadyInSave

Constructor Detail

BasePoolResults

public BasePoolResults()

Method Detail

getPoolId

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

Get the PoolId

Returns:

NumberKey

setPoolId

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

Set the value of PoolId

setPoolId

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

Set the value of PoolId as a string.

getYearId

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

Get the YearId

Returns:

NumberKey

setYearId

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

Set the value of YearId

setYearId

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

Set the value of YearId as a string.

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.

getStudentsPooled

public int getStudentsPooled()

Get the StudentsPooled

Returns:

int

setStudentsPooled

public void setStudentsPooled(int v)

Set the value of StudentsPooled

getStudentsCourse

public int getStudentsCourse()

Get the StudentsCourse

Returns:

int

setStudentsCourse

public void setStudentsCourse(int v)

Set the value of StudentsCourse

setYear

public void setYear(Year v)
             throws java.lang.Exception

Declares an association between this object and a Year object

Parameters:

Year - v

getYear

public Year getYear()
             throws java.lang.Exception

setYearKey

public void setYearKey(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())

setCourse

public void setCourse(Course v)
               throws java.lang.Exception

Declares an association between this object and a Course object

Parameters:

Course - v

getCourse

public Course getCourse()
                 throws java.lang.Exception

setCourseKey

public void setCourseKey(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()) Note: It is important that the xml schema used to create this class maintains consistency in the order of related columns between pool_results and course. If for some reason this is impossible, this method should be overridden in PoolResults.

initRequiredPools

protected void initRequiredPools()

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

addRequiredPool

public void addRequiredPool(RequiredPool l)
                     throws java.lang.Exception

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

Parameters:

RequiredPool - l

getRequiredPools

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

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

getRequiredPools

public java.util.Vector getRequiredPools(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 PoolResults has previously been saved, it will retrieve related RequiredPools from storage. If this PoolResults is new, it will return an empty collection or the current collection, the criteria is ignored on a new object.

getRequiredPoolsJoinDiscipline

protected java.util.Vector getRequiredPoolsJoinDiscipline(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 PoolResults is new, it will return an empty collection; or if this PoolResults has previously been saved, it will retrieve related RequiredPools from storage.

initElectivePools

protected void initElectivePools()

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

addElectivePool

public void addElectivePool(ElectivePool l)
                     throws java.lang.Exception

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

Parameters:

ElectivePool - l

getElectivePools

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

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

getElectivePools

public java.util.Vector getElectivePools(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 PoolResults has previously been saved, it will retrieve related ElectivePools from storage. If this PoolResults is new, it will return an empty collection or the current collection, the criteria is ignored on a new object.

getElectivePoolsJoinDiscipline

protected java.util.Vector getElectivePoolsJoinDiscipline(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 PoolResults is new, it will return an empty collection; or if this PoolResults has previously been saved, it will retrieve related ElectivePools 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 pool_id)
                   throws java.lang.Exception

Set the PrimaryKey using ObjectKey.

Overrides:

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

Parameters:

ObjectKey - pool_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 PoolResults 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.