org.tigris.scarab.om
Class BaseModification

java.lang.Object
  org.apache.torque.om.BaseObject
      org.tigris.scarab.om.BaseModification

All Implemented Interfaces:

org.apache.torque.om.Persistent, org.apache.fulcrum.intake.Retrievable, java.io.Serializable

Direct Known Subclasses:

Modification

public abstract class BaseModification

extends org.apache.torque.om.BaseObject

implements org.apache.fulcrum.intake.Retrievable

You should not use this class directly. It should not even be extended all references should be to Modification

See Also:

Serialized Form

Field Summary

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

NEW_ID

Constructor Summary

BaseModification()

Method Summary

Modification	copy() Makes a copy of this object.
protected Modification	copyInto(Modification copyObj)
java.lang.Object	getByName(java.lang.String name) Retrieves a field from the object by name passed in as a String.
java.lang.Object	getByPeerName(java.lang.String name) Retrieves a field from the object by name passed in as a String.
java.lang.Object	getByPosition(int pos) Retrieves a field from the object by Position as specified in the xml schema.
java.lang.Integer	getColumnId() Get the ColumnId
java.lang.Integer	getCreatedBy() Get the CreatedBy
java.util.Date	getCreatedDate() Get the CreatedDate
static java.util.List	getFieldNames() Generate a list of field names.
java.lang.Integer	getModifiedBy() Get the ModifiedBy
java.util.Date	getModifiedDate() Get the ModifiedDate
ModificationPeer	getPeer() returns a peer instance associated with this om.
org.apache.torque.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.lang.Integer	getTableId() Get the TableId
protected boolean	isCacheOnSave() Specify whether to cache the object after saving to the db.
void	save() Stores the object in the database.
void	save(java.sql.Connection con) Stores the object in the database.
void	save(java.lang.String dbName) Stores the object in the database.
void	setColumnId(java.lang.Integer v) Set the value of ColumnId
void	setCreatedBy(java.lang.Integer v) Set the value of CreatedBy
void	setCreatedDate(java.util.Date v) Set the value of CreatedDate
void	setModifiedBy(java.lang.Integer v) Set the value of ModifiedBy
void	setModifiedDate(java.util.Date v) Set the value of ModifiedDate
void	setPrimaryKey(java.lang.Integer tableId, java.lang.Integer columnId) Set the PrimaryKey using SimpleKeys.
void	setPrimaryKey(org.apache.torque.om.ObjectKey key) Set the PrimaryKey with an 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	setTableId(java.lang.Integer v) Set the value of TableId
java.lang.String	toString()

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

equals, equals, getLog, hashCode, isModified, isNew, resetModified, setModified, setNew, setPrimaryKey

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BaseModification

public BaseModification()

Method Detail

getTableId

public java.lang.Integer getTableId()

Get the TableId

Returns:

Integer

setTableId

public void setTableId(java.lang.Integer v)

Set the value of TableId

Parameters:

v - new value

getColumnId

public java.lang.Integer getColumnId()

Get the ColumnId

Returns:

Integer

setColumnId

public void setColumnId(java.lang.Integer v)

Set the value of ColumnId

Parameters:

v - new value

getModifiedBy

public java.lang.Integer getModifiedBy()

Get the ModifiedBy

Returns:

Integer

setModifiedBy

public void setModifiedBy(java.lang.Integer v)

Set the value of ModifiedBy

Parameters:

v - new value

getCreatedBy

public java.lang.Integer getCreatedBy()

Get the CreatedBy

Returns:

Integer

setCreatedBy

public void setCreatedBy(java.lang.Integer v)

Set the value of CreatedBy

Parameters:

v - new value

getModifiedDate

public java.util.Date getModifiedDate()

Get the ModifiedDate

Returns:

Date

setModifiedDate

public void setModifiedDate(java.util.Date v)

Set the value of ModifiedDate

Parameters:

v - new value

getCreatedDate

public java.util.Date getCreatedDate()

Get the CreatedDate

Returns:

Date

setCreatedDate

public void setCreatedDate(java.util.Date v)

Set the value of CreatedDate

Parameters:

v - new value

getFieldNames

public static java.util.List getFieldNames()

Generate a list of field names.

Returns:

a list of field names

getByName

public java.lang.Object getByName(java.lang.String name)

Retrieves a field from the object by name passed in as a String.

Parameters:

name - field name

Returns:

value

getByPeerName

public java.lang.Object getByPeerName(java.lang.String name)

Retrieves a field from the object by name passed in as a String. The String must be one of the static Strings defined in this Class' Peer.

Parameters:

name - peer name

Returns:

value

getByPosition

public java.lang.Object getByPosition(int pos)

Retrieves a field from the object by Position as specified in the xml schema. Zero-based.

Parameters:

pos - position in xml schema

Returns:

value

save

public void save()
          throws org.apache.torque.TorqueException

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

Specified by:

save in interface org.apache.torque.om.Persistent

Throws:

org.apache.torque.TorqueException

save

public void save(java.lang.String dbName)
          throws org.apache.torque.TorqueException

Stores the object in the database. If the object is new, it inserts it; otherwise an update is performed. Note: this code is here because the method body is auto-generated conditionally and therefore needs to be in this file instead of in the super class, BaseObject.

Specified by:

save in interface org.apache.torque.om.Persistent

Parameters:

dbName -

Throws:

org.apache.torque.TorqueException

save

public void save(java.sql.Connection con)
          throws org.apache.torque.TorqueException

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

Specified by:

save in interface org.apache.torque.om.Persistent

Parameters:

con -

Throws:

org.apache.torque.TorqueException

isCacheOnSave

protected boolean isCacheOnSave()

Specify whether to cache the object after saving to the db. This method returns true

setPrimaryKey

public void setPrimaryKey(org.apache.torque.om.ObjectKey key)
                   throws org.apache.torque.TorqueException

Set the PrimaryKey with an ObjectKey

Specified by:

setPrimaryKey in interface org.apache.torque.om.Persistent

Parameters:

key -

Throws:

org.apache.torque.TorqueException

setPrimaryKey

public void setPrimaryKey(java.lang.Integer tableId,
                          java.lang.Integer columnId)

Set the PrimaryKey using SimpleKeys.

Parameters:

tableId - Integer

columnId - Integer

setPrimaryKey

public void setPrimaryKey(java.lang.String key)
                   throws org.apache.torque.TorqueException

Set the PrimaryKey using a String.

Specified by:

setPrimaryKey in interface org.apache.torque.om.Persistent

Throws:

org.apache.torque.TorqueException

getPrimaryKey

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

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

Specified by:

getPrimaryKey in interface org.apache.torque.om.Persistent

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.fulcrum.intake.Retrievable

setQueryKey

public void setQueryKey(java.lang.String key)
                 throws org.apache.torque.TorqueException

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

Specified by:

setQueryKey in interface org.apache.fulcrum.intake.Retrievable

Throws:

org.apache.torque.TorqueException

copy

public Modification copy()
                  throws org.apache.torque.TorqueException

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.

Throws:

org.apache.torque.TorqueException

copyInto

protected Modification copyInto(Modification copyObj)
                         throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

getPeer

public ModificationPeer getPeer()

returns a peer instance associated with this om. Since Peer classes are not to have any instance attributes, this method returns the same instance for all member of this class. The method could therefore be static, but this would prevent one from overriding the behavior.

toString

public java.lang.String toString()