org.tigris.scarab.om
Class BaseNotificationStatus

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

All Implemented Interfaces:

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

Direct Known Subclasses:

NotificationStatus

public abstract class BaseNotificationStatus

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 NotificationStatus

See Also:

Serialized Form

Field Summary

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

NEW_ID

Constructor Summary

BaseNotificationStatus()

Method Summary

NotificationStatus	copy() Makes a copy of this object.
protected NotificationStatus	copyInto(NotificationStatus copyObj)
Activity	getActivity() Returns the associated Activity object.
Activity	getActivity(java.sql.Connection connection) Return the associated Activity object If it was not retrieved before, the object is retrieved from the database using the passed connection
java.lang.Long	getActivityId() Get the ActivityId
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.util.Date	getChangeDate() Get the ChangeDate
java.lang.String	getComment() Get the Comment
java.util.Date	getCreationDate() Get the CreationDate
java.lang.Integer	getCreatorId() Get the CreatorId
static java.util.List	getFieldNames() Generate a list of field names.
NotificationStatusPeer	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	getReceiverId() Get the ReceiverId
ScarabUser	getScarabUser() Returns the associated ScarabUser object.
ScarabUser	getScarabUser(java.sql.Connection connection) Return the associated ScarabUser object If it was not retrieved before, the object is retrieved from the database using the passed connection
java.lang.Integer	getStatus() Get the Status
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	setActivity(Activity v) Declares an association between this object and a Activity object
void	setActivityId(java.lang.Long v) Set the value of ActivityId
void	setActivityKey(org.apache.torque.om.ObjectKey key) Provides convenient way to set a relationship based on a ObjectKey, for example bar.setFooKey(foo.getPrimaryKey())
void	setChangeDate(java.util.Date v) Set the value of ChangeDate
void	setComment(java.lang.String v) Set the value of Comment
void	setCreationDate(java.util.Date v) Set the value of CreationDate
void	setCreatorId(java.lang.Integer v) Set the value of CreatorId
void	setPrimaryKey(java.lang.Long activityId, java.lang.Integer creatorId, java.lang.Integer receiverId) 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	setReceiverId(java.lang.Integer v) Set the value of ReceiverId
void	setScarabUser(ScarabUser v) Declares an association between this object and a ScarabUser object
void	setScarabUserKey(org.apache.torque.om.ObjectKey key) Provides convenient way to set a relationship based on a ObjectKey, for example bar.setFooKey(foo.getPrimaryKey())
void	setStatus(java.lang.Integer v) Set the value of Status
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

BaseNotificationStatus

public BaseNotificationStatus()

Method Detail

getActivityId

public java.lang.Long getActivityId()

Get the ActivityId

Returns:

Long

setActivityId

public void setActivityId(java.lang.Long v)
                   throws org.apache.torque.TorqueException

Set the value of ActivityId

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

getCreatorId

public java.lang.Integer getCreatorId()

Get the CreatorId

Returns:

Integer

setCreatorId

public void setCreatorId(java.lang.Integer v)
                  throws org.apache.torque.TorqueException

Set the value of CreatorId

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

getReceiverId

public java.lang.Integer getReceiverId()

Get the ReceiverId

Returns:

Integer

setReceiverId

public void setReceiverId(java.lang.Integer v)

Set the value of ReceiverId

Parameters:

v - new value

getStatus

public java.lang.Integer getStatus()

Get the Status

Returns:

Integer

setStatus

public void setStatus(java.lang.Integer v)

Set the value of Status

Parameters:

v - new value

getCreationDate

public java.util.Date getCreationDate()

Get the CreationDate

Returns:

Date

setCreationDate

public void setCreationDate(java.util.Date v)

Set the value of CreationDate

Parameters:

v - new value

getChangeDate

public java.util.Date getChangeDate()

Get the ChangeDate

Returns:

Date

setChangeDate

public void setChangeDate(java.util.Date v)

Set the value of ChangeDate

Parameters:

v - new value

getComment

public java.lang.String getComment()

Get the Comment

Returns:

String

setComment

public void setComment(java.lang.String v)

Set the value of Comment

Parameters:

v - new value

setScarabUser

public void setScarabUser(ScarabUser v)
                   throws org.apache.torque.TorqueException

Declares an association between this object and a ScarabUser object

Parameters:

v - ScarabUser

Throws:

org.apache.torque.TorqueException

getScarabUser

public ScarabUser getScarabUser()
                         throws org.apache.torque.TorqueException

Returns the associated ScarabUser object. If it was not retrieved before, the object is retrieved from the database

Returns:

the associated ScarabUser object

Throws:

org.apache.torque.TorqueException

getScarabUser

public ScarabUser getScarabUser(java.sql.Connection connection)
                         throws org.apache.torque.TorqueException

Return the associated ScarabUser object If it was not retrieved before, the object is retrieved from the database using the passed connection

Parameters:

connection - the connection used to retrieve the associated object from the database, if it was not retrieved before

Returns:

the associated ScarabUser object

Throws:

org.apache.torque.TorqueException

setScarabUserKey

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

Provides convenient way to set a relationship based on a ObjectKey, for example bar.setFooKey(foo.getPrimaryKey())

Throws:

org.apache.torque.TorqueException

setActivity

public void setActivity(Activity v)
                 throws org.apache.torque.TorqueException

Declares an association between this object and a Activity object

Parameters:

v - Activity

Throws:

org.apache.torque.TorqueException

getActivity

public Activity getActivity()
                     throws org.apache.torque.TorqueException

Returns the associated Activity object. If it was not retrieved before, the object is retrieved from the database

Returns:

the associated Activity object

Throws:

org.apache.torque.TorqueException

getActivity

public Activity getActivity(java.sql.Connection connection)
                     throws org.apache.torque.TorqueException

Return the associated Activity object If it was not retrieved before, the object is retrieved from the database using the passed connection

Parameters:

connection - the connection used to retrieve the associated object from the database, if it was not retrieved before

Returns:

the associated Activity object

Throws:

org.apache.torque.TorqueException

setActivityKey

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

Provides convenient way to set a relationship based on a ObjectKey, for example bar.setFooKey(foo.getPrimaryKey())

Throws:

org.apache.torque.TorqueException

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.Long activityId,
                          java.lang.Integer creatorId,
                          java.lang.Integer receiverId)
                   throws org.apache.torque.TorqueException

Set the PrimaryKey using SimpleKeys.

Parameters:

activityId - Long

creatorId - Integer

receiverId - Integer

Throws:

org.apache.torque.TorqueException

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 NotificationStatus 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 NotificationStatus copyInto(NotificationStatus copyObj)
                               throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

getPeer

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