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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

MessageHeader

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

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 MessageHeader

See Also:

Serialized Form

Field Summary

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

NEW_ID

Constructor Summary

BaseMessageHeader()

Method Summary

MessageHeader	copy() Makes a copy of this object.
MessageHeader	copy(boolean deepcopy) Makes a copy of this object.
protected MessageHeader	copyInto(MessageHeader copyObj) Fills the copyObj with the contents of this object.
protected MessageHeader	copyInto(MessageHeader 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.
java.lang.String	getField() Get the Field
static java.util.List	getFieldNames() Generate a list of field names.
int	getLineNumber() Get the LineNumber
long	getMailboxId() Get the MailboxId
MessageRow	getMessageRow() Returns the associated MessageRow object.
MessageRow	getMessageRow(java.sql.Connection connection) Return the associated MessageRow object If it was not retrieved before, the object is retrieved from the database using the passed connection
MessageHeaderPeer	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.
org.apache.torque.map.TableMap	getTableMap() Retrieves the TableMap object related to this Table data without compiler warnings of using getPeer().getTableMap().
long	getUid() Get the Uid
java.lang.String	getValue() Get the Value
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	setField(java.lang.String v) Set the value of Field
void	setLineNumber(int v) Set the value of LineNumber
void	setMailboxId(long v) Set the value of MailboxId
void	setMessageRow(MessageRow v) Declares an association between this object and a MessageRow object
void	setMessageRowKey(org.apache.torque.om.ObjectKey key) Provides convenient way to set a relationship based on a ObjectKey, for example bar.setFooKey(foo.getPrimaryKey()) Note: It is important that the xml schema used to create this class maintains consistency in the order of related columns between message_header and message.
void	setPrimaryKey(long mailboxId, long uid, int lineNumber) 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	setUid(long v) Set the value of Uid
void	setValue(java.lang.String v) Set the value of Value
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

BaseMessageHeader

public BaseMessageHeader()

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

getUid

public long getUid()

Get the Uid

Returns:

long

setUid

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

Set the value of Uid

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

getLineNumber

public int getLineNumber()

Get the LineNumber

Returns:

int

setLineNumber

public void setLineNumber(int v)

Set the value of LineNumber

Parameters:

v - new value

getField

public java.lang.String getField()

Get the Field

Returns:

String

setField

public void setField(java.lang.String v)

Set the value of Field

Parameters:

v - new value

getValue

public java.lang.String getValue()

Get the Value

Returns:

String

setValue

public void setValue(java.lang.String v)

Set the value of Value

Parameters:

v - new value

setMessageRow

public void setMessageRow(MessageRow v)
                   throws org.apache.torque.TorqueException

Declares an association between this object and a MessageRow object

Parameters:

v - MessageRow

Throws:

org.apache.torque.TorqueException

getMessageRow

public MessageRow getMessageRow()
                         throws org.apache.torque.TorqueException

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

Returns:

the associated MessageRow object

Throws:

org.apache.torque.TorqueException

getMessageRow

public MessageRow getMessageRow(java.sql.Connection connection)
                         throws org.apache.torque.TorqueException

Return the associated MessageRow 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 MessageRow object

Throws:

org.apache.torque.TorqueException

setMessageRowKey

public void setMessageRowKey(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()) Note: It is important that the xml schema used to create this class maintains consistency in the order of related columns between message_header and message. If for some reason this is impossible, this method should be overridden in MessageHeader.

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 java.lang.Exception

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

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 with an ObjectKey

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

setPrimaryKey

public void setPrimaryKey(long mailboxId,
                          long uid,
                          int lineNumber)
                   throws org.apache.torque.TorqueException

Set the PrimaryKey using SimpleKeys.

Parameters:

mailboxId - long

uid - long

lineNumber - int

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

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 MessageHeader 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 MessageHeader 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 MessageHeader copyInto(MessageHeader 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 MessageHeader copyInto(MessageHeader 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 MessageHeaderPeer 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