org.apache.james.mailboxmanager.torque.om
Class BaseMailboxRow

java.lang.Object
  org.apache.torque.om.BaseObject
      org.apache.james.mailboxmanager.torque.om.BaseMailboxRow

All Implemented Interfaces:

java.io.Serializable, org.apache.torque.om.Persistent

Direct Known Subclasses:

MailboxRow

public abstract class BaseMailboxRow
extends org.apache.torque.om.BaseObject

Mailbox Table This class was autogenerated by Torque on: [Sun Dec 09 17:45:09 GMT 2007] You should not use this class directly. It should not even be extended all references should be to MailboxRow

See Also:

Serialized Form

Field Summary

protected java.util.List

collMessageRows Collection to store aggregation of collMessageRows

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

NEW_ID

Constructor Summary

BaseMailboxRow()

Method Summary

void	addMessageRow(MessageRow l) Method called to associate a MessageRow object to this object through the MessageRow foreign key attribute
MailboxRow	copy() Makes a copy of this object.
MailboxRow	copy(boolean deepcopy) Makes a copy of this object.
protected MailboxRow	copyInto(MailboxRow copyObj) Fills the copyObj with the contents of this object.
protected MailboxRow	copyInto(MailboxRow copyObj, boolean deepcopy) Fills the copyObj with the contents of this object.
java.lang.Object	getByName(java.lang.String name) Retrieves a field from the object by field (Java) 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.
static java.util.List	getFieldNames() Generate a list of field names.
long	getLastUid() Get the LastUid
long	getMailboxId() Get the MailboxId
int	getMessageCount() Get the MessageCount
java.util.List	getMessageRows() If this collection has already been initialized, returns the collection.
java.util.List	getMessageRows(java.sql.Connection con) If this collection has already been initialized, returns the collection.
java.util.List	getMessageRows(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.util.List	getMessageRows(org.apache.torque.util.Criteria criteria, java.sql.Connection con) If this collection has already been initialized with an identical criteria, it returns the collection.
protected java.util.List	getMessageRowsJoinMailboxRow(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.lang.String	getName() Get the Name
MailboxRowPeer	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.
long	getSize() Get the Size
org.apache.torque.map.TableMap	getTableMap() Retrieves the TableMap object related to this Table data without compiler warnings of using getPeer().getTableMap().
long	getUidValidity() Get the UidValidity
protected void	initMessageRows() Temporary storage of collMessageRows 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(java.sql.Connection con) Stores the object in the database.
void	save(java.lang.String dbName) Stores the object in the database.
boolean	setByName(java.lang.String name, java.lang.Object value) Set a field in the object by field (Java) name.
boolean	setByPeerName(java.lang.String name, java.lang.Object value) Set field values by Peer Field Name
boolean	setByPosition(int position, java.lang.Object value) Set field values by its position (zero based) in the XML schema.
void	setLastUid(long v) Set the value of LastUid
void	setMailboxId(long v) Set the value of MailboxId
void	setMessageCount(int v) Set the value of MessageCount
void	setName(java.lang.String v) Set the value of Name
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	setSize(long v) Set the value of Size
void	setUidValidity(long v) Set the value of UidValidity
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

Field Detail

collMessageRows

protected java.util.List collMessageRows

Collection to store aggregation of collMessageRows

Constructor Detail

BaseMailboxRow

public BaseMailboxRow()

Method Detail

getMailboxId

public long getMailboxId()

Get the MailboxId

Returns:

long

setMailboxId

public void setMailboxId(long v)
                  throws org.apache.torque.TorqueException

Set the value of MailboxId

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

getName

public java.lang.String getName()

Get the Name

Returns:

String

setName

public void setName(java.lang.String v)

Set the value of Name

Parameters:

v - new value

getUidValidity

public long getUidValidity()

Get the UidValidity

Returns:

long

setUidValidity

public void setUidValidity(long v)

Set the value of UidValidity

Parameters:

v - new value

getLastUid

public long getLastUid()

Get the LastUid

Returns:

long

setLastUid

public void setLastUid(long v)

Set the value of LastUid

Parameters:

v - new value

getMessageCount

public int getMessageCount()

Get the MessageCount

Returns:

int

setMessageCount

public void setMessageCount(int v)

Set the value of MessageCount

Parameters:

v - new value

getSize

public long getSize()

Get the Size

Returns:

long

setSize

public void setSize(long v)

Set the value of Size

Parameters:

v - new value

initMessageRows

protected void initMessageRows()

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

addMessageRow

public void addMessageRow(MessageRow l)
                   throws org.apache.torque.TorqueException

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

Parameters:

l - MessageRow

Throws:

org.apache.torque.TorqueException

getMessageRows

public java.util.List getMessageRows()
                              throws org.apache.torque.TorqueException

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

Returns:

the collection of associated objects

Throws:

org.apache.torque.TorqueException

getMessageRows

public java.util.List getMessageRows(org.apache.torque.util.Criteria criteria)
                              throws org.apache.torque.TorqueException

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this MailboxRow has previously been saved, it will retrieve related MessageRows from storage. If this MailboxRow is new, it will return an empty collection or the current collection, the criteria is ignored on a new object.

Throws:

org.apache.torque.TorqueException

getMessageRows

public java.util.List getMessageRows(java.sql.Connection con)
                              throws org.apache.torque.TorqueException

If this collection has already been initialized, returns the collection. Otherwise returns the results of getMessageRows(new Criteria(),Connection) This method takes in the Connection also as input so that referenced objects can also be obtained using a Connection that is taken as input

Throws:

org.apache.torque.TorqueException

getMessageRows

public java.util.List getMessageRows(org.apache.torque.util.Criteria criteria,
                                     java.sql.Connection con)
                              throws org.apache.torque.TorqueException

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this MailboxRow has previously been saved, it will retrieve related MessageRows from storage. If this MailboxRow is new, it will return an empty collection or the current collection, the criteria is ignored on a new object. This method takes in the Connection also as input so that referenced objects can also be obtained using a Connection that is taken as input

Throws:

org.apache.torque.TorqueException

getMessageRowsJoinMailboxRow

protected java.util.List getMessageRowsJoinMailboxRow(org.apache.torque.util.Criteria criteria)
                                               throws org.apache.torque.TorqueException

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this MailboxRow is new, it will return an empty collection; or if this MailboxRow has previously been saved, it will retrieve related MessageRows from storage. This method is protected by default in order to keep the public api reasonable. You can provide public methods for those you actually need in MailboxRow.

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 field (Java) name passed in as a String.

Overrides:

getByName in class org.apache.torque.om.BaseObject

Parameters:

name - field name

Returns:

value

setByName

public boolean setByName(java.lang.String name,
                         java.lang.Object value)
                  throws org.apache.torque.TorqueException,
                         java.lang.IllegalArgumentException

Set a field in the object by field (Java) name.

Overrides:

setByName in class org.apache.torque.om.BaseObject

Parameters:

name - field name

value - field value

Returns:

True if value was set, false if not (invalid name / protected field).

Throws:

java.lang.IllegalArgumentException - if object type of value does not match field object type.

org.apache.torque.TorqueException - If a problem occures with the set[Field] method.

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.

Overrides:

getByPeerName in class org.apache.torque.om.BaseObject

Parameters:

name - peer name

Returns:

value

setByPeerName

public boolean setByPeerName(java.lang.String name,
                             java.lang.Object value)
                      throws org.apache.torque.TorqueException,
                             java.lang.IllegalArgumentException

Set field values by Peer Field Name

Overrides:

setByPeerName in class org.apache.torque.om.BaseObject

Parameters:

name - field name

value - field value

Returns:

True if value was set, false if not (invalid name / protected field).

Throws:

java.lang.IllegalArgumentException - if object type of value does not match field object type.

org.apache.torque.TorqueException - If a problem occures with the set[Field] method.

getByPosition

public java.lang.Object getByPosition(int pos)

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

Overrides:

getByPosition in class org.apache.torque.om.BaseObject

Parameters:

pos - position in xml schema

Returns:

value

setByPosition

public boolean setByPosition(int position,
                             java.lang.Object value)
                      throws org.apache.torque.TorqueException,
                             java.lang.IllegalArgumentException

Set field values by its position (zero based) in the XML schema.

Overrides:

setByPosition in class org.apache.torque.om.BaseObject

Parameters:

position - The field position

value - field value

Returns:

True if value was set, false if not (invalid position / protected field).

Throws:

java.lang.IllegalArgumentException - if object type of value does not match field object type.

org.apache.torque.TorqueException - If a problem occures with the set[Field] method.

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

Specified by:

save in class org.apache.torque.om.BaseObject

Throws:

java.lang.Exception

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

Specified by:

save in class org.apache.torque.om.BaseObject

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

Specified by:

save in class org.apache.torque.om.BaseObject

Parameters:

con -

Throws:

org.apache.torque.TorqueException

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

Overrides:

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

Parameters:

key - mailboxId 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

Overrides:

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

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

Overrides:

getPrimaryKey in class org.apache.torque.om.BaseObject

copy

public MailboxRow 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

copy

public MailboxRow copy(boolean deepcopy)
                throws org.apache.torque.TorqueException

Makes a copy of this object. It creates a new object filling in the simple attributes. If the parameter deepcopy is true, it then fills all the association collections and sets the related objects to isNew=true.

Parameters:

deepcopy - whether to copy the associated objects.

Throws:

org.apache.torque.TorqueException

copyInto

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

Fills the copyObj with the contents of this object. The associated objects are also copied and treated as new objects.

Parameters:

copyObj - the object to fill.

Throws:

org.apache.torque.TorqueException

copyInto

protected MailboxRow copyInto(MailboxRow copyObj,
                              boolean deepcopy)
                       throws org.apache.torque.TorqueException

Fills the copyObj with the contents of this object. If deepcopy is true, The associated objects are also copied and treated as new objects.

Parameters:

copyObj - the object to fill.

deepcopy - whether the associated objects should be copied.

Throws:

org.apache.torque.TorqueException

getPeer

public MailboxRowPeer 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.

getTableMap

public org.apache.torque.map.TableMap getTableMap()
                                           throws org.apache.torque.TorqueException

Retrieves the TableMap object related to this Table data without compiler warnings of using getPeer().getTableMap().

Overrides:

getTableMap in class org.apache.torque.om.BaseObject

Returns:

The associated TableMap object.

Throws:

org.apache.torque.TorqueException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object