br.usp.ime.xpusp.om
Class BaseUnit

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

All Implemented Interfaces:

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

Direct Known Subclasses:

Unit

public abstract class BaseUnit

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 Unit

See Also:

Serialized Form

Field Summary

private boolean	alreadyInSave
private Source	aSource
private java.lang.String	campus the value for the campus field
protected java.util.Vector	collCourses Collection to store aggregation of collCourses
protected java.util.Vector	collDepartments Collection to store aggregation of collDepartments
private org.apache.turbine.util.db.Criteria	lastCoursesCriteria The criteria used to select the current contents of collCourses
private org.apache.turbine.util.db.Criteria	lastDepartmentsCriteria The criteria used to select the current contents of collDepartments
private java.lang.String	name the value for the name field
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

BaseUnit()

Method Summary

void	addCourse(Course l) Method called to associate a Course object to this object through the Course foreign key attribute
void	addDepartment(Department l) Method called to associate a Department object to this object through the Department foreign key attribute
Unit	copy() Makes a copy of this object.
java.lang.String	getCampus() Get the Campus
java.util.Vector	getCourses() If this collection has already been initialized, returns the collection.
java.util.Vector	getCourses(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	getCoursesJoinDepartment(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	getCoursesJoinSource(org.apache.turbine.util.db.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.util.Vector	getDepartments() If this collection has already been initialized, returns the collection.
java.util.Vector	getDepartments(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	getDepartmentsJoinSource(org.apache.turbine.util.db.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.lang.String	getName() Get the Name
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
org.apache.turbine.om.NumberKey	getUnitId() Get the UnitId
protected void	initCourses() Temporary storage of collCourses to save a possible db hit in the event objects are add to the collection, but the complete collection is never requested.
protected void	initDepartments() Temporary storage of collDepartments 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	setCampus(java.lang.String v) Set the value of Campus
void	setName(java.lang.String v) Set the value of Name
void	setPrimaryKey(org.apache.turbine.om.ObjectKey unit_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	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	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.

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

unit_id

private org.apache.turbine.om.NumberKey unit_id

the value for the unit_id field

name

private java.lang.String name

the value for the name field

campus

private java.lang.String campus

the value for the campus field

source_id

private org.apache.turbine.om.NumberKey source_id

the value for the source_id field

aSource

private Source aSource

collDepartments

protected java.util.Vector collDepartments

Collection to store aggregation of collDepartments

lastDepartmentsCriteria

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

The criteria used to select the current contents of collDepartments

collCourses

protected java.util.Vector collCourses

Collection to store aggregation of collCourses

lastCoursesCriteria

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

The criteria used to select the current contents of collCourses

alreadyInSave

private boolean alreadyInSave

Constructor Detail

BaseUnit

public BaseUnit()

Method Detail

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.

getName

public java.lang.String getName()

Get the Name

Returns:

String

setName

public void setName(java.lang.String v)

Set the value of Name

getCampus

public java.lang.String getCampus()

Get the Campus

Returns:

String

setCampus

public void setCampus(java.lang.String v)

Set the value of Campus

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())

initDepartments

protected void initDepartments()

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

addDepartment

public void addDepartment(Department l)
                   throws java.lang.Exception

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

Parameters:

Department - l

getDepartments

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

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

getDepartments

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

getDepartmentsJoinSource

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

initCourses

protected void initCourses()

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

addCourse

public void addCourse(Course l)
               throws java.lang.Exception

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

Parameters:

Course - l

getCourses

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

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

getCourses

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

getCoursesJoinSource

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

getCoursesJoinDepartment

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

Set the PrimaryKey using ObjectKey.

Overrides:

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

Parameters:

ObjectKey - unit_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 Unit 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.