org.tigris.scarab.om
Class BaseROptionOption

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ROptionOption

public abstract class BaseROptionOption

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 ROptionOption

See Also:

Serialized Form

Field Summary

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

NEW_ID

Constructor Summary

BaseROptionOption()

Method Summary

ROptionOption	copy() Makes a copy of this object.
protected ROptionOption	copyInto(ROptionOption copyObj)
AttributeOption	getAttributeOptionRelatedByOption1Id() Returns the associated AttributeOption object.
AttributeOption	getAttributeOptionRelatedByOption1Id(java.sql.Connection connection) Return the associated AttributeOption object If it was not retrieved before, the object is retrieved from the database using the passed connection
AttributeOption	getAttributeOptionRelatedByOption2Id() Returns the associated AttributeOption object.
AttributeOption	getAttributeOptionRelatedByOption2Id(java.sql.Connection connection) Return the associated AttributeOption object If it was not retrieved before, the object is retrieved from the database using the passed connection
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.
static java.util.List	getFieldNames() Generate a list of field names.
java.lang.Integer	getOption1Id() Get the Option1Id
java.lang.Integer	getOption2Id() Get the Option2Id
OptionRelationship	getOptionRelationship() Returns the associated OptionRelationship object.
OptionRelationship	getOptionRelationship(java.sql.Connection connection) Return the associated OptionRelationship object If it was not retrieved before, the object is retrieved from the database using the passed connection
ROptionOptionPeer	getPeer() returns a peer instance associated with this om.
int	getPreferredOrder() Get the PreferredOrder
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	getRelationshipId() Get the RelationshipId
int	getWeight() Get the Weight
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	setAttributeOptionRelatedByOption1Id(AttributeOption v) Declares an association between this object and a AttributeOption object
void	setAttributeOptionRelatedByOption1IdKey(org.apache.torque.om.ObjectKey key) Provides convenient way to set a relationship based on a ObjectKey, for example bar.setFooKey(foo.getPrimaryKey())
void	setAttributeOptionRelatedByOption2Id(AttributeOption v) Declares an association between this object and a AttributeOption object
void	setAttributeOptionRelatedByOption2IdKey(org.apache.torque.om.ObjectKey key) Provides convenient way to set a relationship based on a ObjectKey, for example bar.setFooKey(foo.getPrimaryKey())
void	setOption1Id(java.lang.Integer v) Set the value of Option1Id
void	setOption2Id(java.lang.Integer v) Set the value of Option2Id
void	setOptionRelationship(OptionRelationship v) Declares an association between this object and a OptionRelationship object
void	setOptionRelationshipKey(org.apache.torque.om.ObjectKey key) Provides convenient way to set a relationship based on a ObjectKey, for example bar.setFooKey(foo.getPrimaryKey())
void	setPreferredOrder(int v) Set the value of PreferredOrder
void	setPrimaryKey(java.lang.Integer option1Id, java.lang.Integer option2Id) 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	setRelationshipId(java.lang.Integer v) Set the value of RelationshipId
void	setWeight(int v) Set the value of Weight
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

BaseROptionOption

public BaseROptionOption()

Method Detail

getOption1Id

public java.lang.Integer getOption1Id()

Get the Option1Id

Returns:

Integer

setOption1Id

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

Set the value of Option1Id

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

getOption2Id

public java.lang.Integer getOption2Id()

Get the Option2Id

Returns:

Integer

setOption2Id

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

Set the value of Option2Id

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

getRelationshipId

public java.lang.Integer getRelationshipId()

Get the RelationshipId

Returns:

Integer

setRelationshipId

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

Set the value of RelationshipId

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

getWeight

public int getWeight()

Get the Weight

Returns:

int

setWeight

public void setWeight(int v)

Set the value of Weight

Parameters:

v - new value

getPreferredOrder

public int getPreferredOrder()

Get the PreferredOrder

Returns:

int

setPreferredOrder

public void setPreferredOrder(int v)

Set the value of PreferredOrder

Parameters:

v - new value

setAttributeOptionRelatedByOption1Id

public void setAttributeOptionRelatedByOption1Id(AttributeOption v)
                                          throws org.apache.torque.TorqueException

Declares an association between this object and a AttributeOption object

Parameters:

v - AttributeOption

Throws:

org.apache.torque.TorqueException

getAttributeOptionRelatedByOption1Id

public AttributeOption getAttributeOptionRelatedByOption1Id()
                                                     throws org.apache.torque.TorqueException

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

Returns:

the associated AttributeOption object

Throws:

org.apache.torque.TorqueException

getAttributeOptionRelatedByOption1Id

public AttributeOption getAttributeOptionRelatedByOption1Id(java.sql.Connection connection)
                                                     throws org.apache.torque.TorqueException

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

Throws:

org.apache.torque.TorqueException

setAttributeOptionRelatedByOption1IdKey

public void setAttributeOptionRelatedByOption1IdKey(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

setAttributeOptionRelatedByOption2Id

public void setAttributeOptionRelatedByOption2Id(AttributeOption v)
                                          throws org.apache.torque.TorqueException

Declares an association between this object and a AttributeOption object

Parameters:

v - AttributeOption

Throws:

org.apache.torque.TorqueException

getAttributeOptionRelatedByOption2Id

public AttributeOption getAttributeOptionRelatedByOption2Id()
                                                     throws org.apache.torque.TorqueException

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

Returns:

the associated AttributeOption object

Throws:

org.apache.torque.TorqueException

getAttributeOptionRelatedByOption2Id

public AttributeOption getAttributeOptionRelatedByOption2Id(java.sql.Connection connection)
                                                     throws org.apache.torque.TorqueException

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

Throws:

org.apache.torque.TorqueException

setAttributeOptionRelatedByOption2IdKey

public void setAttributeOptionRelatedByOption2IdKey(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

setOptionRelationship

public void setOptionRelationship(OptionRelationship v)
                           throws org.apache.torque.TorqueException

Declares an association between this object and a OptionRelationship object

Parameters:

v - OptionRelationship

Throws:

org.apache.torque.TorqueException

getOptionRelationship

public OptionRelationship getOptionRelationship()
                                         throws org.apache.torque.TorqueException

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

Returns:

the associated OptionRelationship object

Throws:

org.apache.torque.TorqueException

getOptionRelationship

public OptionRelationship getOptionRelationship(java.sql.Connection connection)
                                         throws org.apache.torque.TorqueException

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

Throws:

org.apache.torque.TorqueException

setOptionRelationshipKey

public void setOptionRelationshipKey(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.Integer option1Id,
                          java.lang.Integer option2Id)
                   throws org.apache.torque.TorqueException

Set the PrimaryKey using SimpleKeys.

Parameters:

option1Id - Integer

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

Throws:

org.apache.torque.TorqueException

getPeer

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