org.tigris.scarab.om
Class BaseUserPreference

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

All Implemented Interfaces:

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

Direct Known Subclasses:

UserPreference

public abstract class BaseUserPreference

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 UserPreference

See Also:

Serialized Form

Field Summary

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

NEW_ID

Constructor Summary

BaseUserPreference()

Method Summary

UserPreference	copy() Makes a copy of this object.
protected UserPreference	copyInto(UserPreference 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.
int	getEnterIssueRedirect() Get the EnterIssueRedirect
static java.util.List	getFieldNames() Generate a list of field names.
java.lang.String	getHomePage() Get the HomePage
java.lang.String	getLocale() Get the Locale
java.util.Date	getPasswordExpire() Get the PasswordExpire
UserPreferencePeer	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.
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	getUserId() Get the UserId
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	setEnterIssueRedirect(int v) Set the value of EnterIssueRedirect
void	setHomePage(java.lang.String v) Set the value of HomePage
void	setLocale(java.lang.String v) Set the value of Locale
void	setPasswordExpire(java.util.Date v) Set the value of PasswordExpire
void	setPrimaryKey(org.apache.torque.om.ObjectKey key) 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	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	setUserId(java.lang.Integer v) Set the value of UserId
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

BaseUserPreference

public BaseUserPreference()

Method Detail

getUserId

public java.lang.Integer getUserId()

Get the UserId

Returns:

Integer

setUserId

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

Set the value of UserId

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

getPasswordExpire

public java.util.Date getPasswordExpire()

Get the PasswordExpire

Returns:

Date

setPasswordExpire

public void setPasswordExpire(java.util.Date v)

Set the value of PasswordExpire

Parameters:

v - new value

getEnterIssueRedirect

public int getEnterIssueRedirect()

Get the EnterIssueRedirect

Returns:

int

setEnterIssueRedirect

public void setEnterIssueRedirect(int v)

Set the value of EnterIssueRedirect

Parameters:

v - new value

getHomePage

public java.lang.String getHomePage()

Get the HomePage

Returns:

String

setHomePage

public void setHomePage(java.lang.String v)

Set the value of HomePage

Parameters:

v - new value

getLocale

public java.lang.String getLocale()

Get the Locale

Returns:

String

setLocale

public void setLocale(java.lang.String v)

Set the value of Locale

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

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 using ObjectKey.

Specified by:

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

Parameters:

key - userId ObjectKey

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

Parameters:

key -

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

Throws:

org.apache.torque.TorqueException

getPeer

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