org.tigris.scarab.om
Class BaseAttributeValue

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AttributeValue

public abstract class BaseAttributeValue

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 AttributeValue

See Also:

Serialized Form

Field Summary

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

NEW_ID

Constructor Summary

BaseAttributeValue()

Method Summary

abstract AttributeValue	copy() Makes a copy of this object.
protected AttributeValue	copyInto(AttributeValue copyObj)
Attribute	getAttribute() Returns the associated Attribute object.
Attribute	getAttribute(java.sql.Connection connection) Return the associated Attribute object If it was not retrieved before, the object is retrieved from the database using the passed connection
java.lang.Integer	getAttributeId() Get the AttributeId
AttributeOption	getAttributeOption() Returns the associated AttributeOption object.
AttributeOption	getAttributeOption(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.
boolean	getDeleted() Get the Deleted
static java.util.List	getFieldNames() Generate a list of field names.
Issue	getIssue() Returns the associated Issue object.
Issue	getIssue(java.sql.Connection connection) Return the associated Issue object If it was not retrieved before, the object is retrieved from the database using the passed connection
java.lang.Long	getIssueId() Get the IssueId
java.lang.Integer	getNumericValue() Get the NumericValue
java.lang.Integer	getOptionId() Get the OptionId
AttributeValuePeer	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
java.lang.String	getValue() Get the Value
java.lang.Long	getValueId() Get the ValueId
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	setAttribute(Attribute v) Declares an association between this object and a Attribute object
void	setAttributeId(java.lang.Integer v) Set the value of AttributeId
void	setAttributeKey(org.apache.torque.om.ObjectKey key) Provides convenient way to set a relationship based on a ObjectKey, for example bar.setFooKey(foo.getPrimaryKey())
void	setAttributeOption(AttributeOption v) Declares an association between this object and a AttributeOption object
void	setAttributeOptionKey(org.apache.torque.om.ObjectKey key) Provides convenient way to set a relationship based on a ObjectKey, for example bar.setFooKey(foo.getPrimaryKey())
void	setDeleted(boolean v) Set the value of Deleted
void	setIssue(Issue v) Declares an association between this object and a Issue object
void	setIssueId(java.lang.Long v) Set the value of IssueId
void	setIssueKey(org.apache.torque.om.ObjectKey key) Provides convenient way to set a relationship based on a ObjectKey, for example bar.setFooKey(foo.getPrimaryKey())
void	setNumericValue(java.lang.Integer v) Set the value of NumericValue
void	setOptionId(java.lang.Integer v) Set the value of OptionId
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
void	setValue(java.lang.String v) Set the value of Value
void	setValueId(java.lang.Long v) Set the value of ValueId
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

BaseAttributeValue

public BaseAttributeValue()

Method Detail

getValueId

public java.lang.Long getValueId()

Get the ValueId

Returns:

Long

setValueId

public void setValueId(java.lang.Long v)

Set the value of ValueId

Parameters:

v - new value

getIssueId

public java.lang.Long getIssueId()

Get the IssueId

Returns:

Long

setIssueId

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

Set the value of IssueId

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

getAttributeId

public java.lang.Integer getAttributeId()

Get the AttributeId

Returns:

Integer

setAttributeId

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

Set the value of AttributeId

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

getNumericValue

public java.lang.Integer getNumericValue()

Get the NumericValue

Returns:

Integer

setNumericValue

public void setNumericValue(java.lang.Integer v)

Set the value of NumericValue

Parameters:

v - new value

getOptionId

public java.lang.Integer getOptionId()

Get the OptionId

Returns:

Integer

setOptionId

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

Set the value of OptionId

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

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

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

getDeleted

public boolean getDeleted()

Get the Deleted

Returns:

boolean

setDeleted

public void setDeleted(boolean v)

Set the value of Deleted

Parameters:

v - new value

setIssue

public void setIssue(Issue v)
              throws org.apache.torque.TorqueException

Declares an association between this object and a Issue object

Parameters:

v - Issue

Throws:

org.apache.torque.TorqueException

getIssue

public Issue getIssue()
               throws org.apache.torque.TorqueException

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

Returns:

the associated Issue object

Throws:

org.apache.torque.TorqueException

getIssue

public Issue getIssue(java.sql.Connection connection)
               throws org.apache.torque.TorqueException

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

Throws:

org.apache.torque.TorqueException

setIssueKey

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

setAttribute

public void setAttribute(Attribute v)
                  throws org.apache.torque.TorqueException

Declares an association between this object and a Attribute object

Parameters:

v - Attribute

Throws:

org.apache.torque.TorqueException

getAttribute

public Attribute getAttribute()
                       throws org.apache.torque.TorqueException

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

Returns:

the associated Attribute object

Throws:

org.apache.torque.TorqueException

getAttribute

public Attribute getAttribute(java.sql.Connection connection)
                       throws org.apache.torque.TorqueException

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

Throws:

org.apache.torque.TorqueException

setAttributeKey

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

setAttributeOption

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

getAttributeOption

public AttributeOption getAttributeOption()
                                   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

getAttributeOption

public AttributeOption getAttributeOption(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

setAttributeOptionKey

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

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)

Set the PrimaryKey using ObjectKey.

Specified by:

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

Parameters:

key - valueId ObjectKey

setPrimaryKey

public void setPrimaryKey(java.lang.String key)

Set the PrimaryKey using a String.

Specified by:

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

Parameters:

key -

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

Throws:

org.apache.torque.TorqueException

getPeer

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