org.tigris.scarab.om
Class BaseRAttributeAttributeGroup

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

All Implemented Interfaces:

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

Direct Known Subclasses:

RAttributeAttributeGroup

public abstract class BaseRAttributeAttributeGroup

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 RAttributeAttributeGroup

See Also:

Serialized Form

Field Summary

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

NEW_ID

Constructor Summary

BaseRAttributeAttributeGroup()

Method Summary

RAttributeAttributeGroup	copy() Makes a copy of this object.
protected RAttributeAttributeGroup	copyInto(RAttributeAttributeGroup 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
AttributeGroup	getAttributeGroup() Returns the associated AttributeGroup object.
AttributeGroup	getAttributeGroup(java.sql.Connection connection) Return the associated AttributeGroup 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
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	getGroupId() Get the GroupId
int	getOrder() Get the Order
RAttributeAttributeGroupPeer	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.
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	setAttributeGroup(AttributeGroup v) Declares an association between this object and a AttributeGroup object
void	setAttributeGroupKey(org.apache.torque.om.ObjectKey key) Provides convenient way to set a relationship based on a ObjectKey, for example bar.setFooKey(foo.getPrimaryKey())
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	setGroupId(java.lang.Integer v) Set the value of GroupId
void	setOrder(int v) Set the value of Order
void	setPrimaryKey(java.lang.Integer groupId, java.lang.Integer attributeId) 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.
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

BaseRAttributeAttributeGroup

public BaseRAttributeAttributeGroup()

Method Detail

getGroupId

public java.lang.Integer getGroupId()

Get the GroupId

Returns:

Integer

setGroupId

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

Set the value of GroupId

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

getOrder

public int getOrder()

Get the Order

Returns:

int

setOrder

public void setOrder(int v)

Set the value of Order

Parameters:

v - new value

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

setAttributeGroup

public void setAttributeGroup(AttributeGroup v)
                       throws org.apache.torque.TorqueException

Declares an association between this object and a AttributeGroup object

Parameters:

v - AttributeGroup

Throws:

org.apache.torque.TorqueException

getAttributeGroup

public AttributeGroup getAttributeGroup()
                                 throws org.apache.torque.TorqueException

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

Returns:

the associated AttributeGroup object

Throws:

org.apache.torque.TorqueException

getAttributeGroup

public AttributeGroup getAttributeGroup(java.sql.Connection connection)
                                 throws org.apache.torque.TorqueException

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

Throws:

org.apache.torque.TorqueException

setAttributeGroupKey

public void setAttributeGroupKey(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 groupId,
                          java.lang.Integer attributeId)
                   throws org.apache.torque.TorqueException

Set the PrimaryKey using SimpleKeys.

Parameters:

groupId - Integer

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

Throws:

org.apache.torque.TorqueException

getPeer

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