org.tigris.scarab.om
Class BaseAttributeGroup

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AttributeGroup

public abstract class BaseAttributeGroup

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 AttributeGroup

See Also:

Serialized Form

Field Summary

protected java.util.List

collRAttributeAttributeGroups Collection to store aggregation of collRAttributeAttributeGroups

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

NEW_ID

Constructor Summary

BaseAttributeGroup()

Method Summary

void	addRAttributeAttributeGroup(RAttributeAttributeGroup l) Method called to associate a RAttributeAttributeGroup object to this object through the RAttributeAttributeGroup foreign key attribute
AttributeGroup	copy() Makes a copy of this object.
protected AttributeGroup	copyInto(AttributeGroup copyObj)
boolean	getActive() Get the Active
java.lang.Integer	getAttributeGroupId() Get the AttributeGroupId
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	getDedupe() Get the Dedupe
java.lang.String	getDescription() Get the Description
static java.util.List	getFieldNames() Generate a list of field names.
IssueType	getIssueType() Returns the associated IssueType object.
IssueType	getIssueType(java.sql.Connection connection) Return the associated IssueType object If it was not retrieved before, the object is retrieved from the database using the passed connection
java.lang.Integer	getIssueTypeId() Get the IssueTypeId
Module	getModule() Returns the associated Module object.
Module	getModule(java.sql.Connection connection) Return the associated Module object If it was not retrieved before, the object is retrieved from the database using the passed connection
java.lang.Integer	getModuleId() Get the ModuleId
java.lang.String	getName() Get the Name
int	getOrder() Get the Order
AttributeGroupPeer	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.
java.util.List	getRAttributeAttributeGroups() If this collection has already been initialized, returns the collection.
java.util.List	getRAttributeAttributeGroups(java.sql.Connection con) If this collection has already been initialized, returns the collection.
java.util.List	getRAttributeAttributeGroups(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.util.List	getRAttributeAttributeGroups(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	getRAttributeAttributeGroupsJoinAttribute(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
protected java.util.List	getRAttributeAttributeGroupsJoinAttributeGroup(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
protected void	initRAttributeAttributeGroups() Temporary storage of collRAttributeAttributeGroups to save a possible db hit in the event objects are add to the collection, but the complete collection is never requested.
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	setActive(boolean v) Set the value of Active
void	setAttributeGroupId(java.lang.Integer v) Set the value of AttributeGroupId
void	setDedupe(boolean v) Set the value of Dedupe
void	setDescription(java.lang.String v) Set the value of Description
void	setIssueType(IssueType v) Declares an association between this object and a IssueType object
void	setIssueTypeId(java.lang.Integer v) Set the value of IssueTypeId
void	setIssueTypeKey(org.apache.torque.om.ObjectKey key) Provides convenient way to set a relationship based on a ObjectKey, for example bar.setFooKey(foo.getPrimaryKey())
void	setModule(Module v) Declares an association between this object and a Module object
void	setModuleId(java.lang.Integer v) Set the value of ModuleId
void	setModuleKey(org.apache.torque.om.ObjectKey key) Provides convenient way to set a relationship based on a ObjectKey, for example bar.setFooKey(foo.getPrimaryKey())
void	setName(java.lang.String v) Set the value of Name
void	setOrder(int v) Set the value of Order
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.
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

collRAttributeAttributeGroups

protected java.util.List collRAttributeAttributeGroups

Collection to store aggregation of collRAttributeAttributeGroups

Constructor Detail

BaseAttributeGroup

public BaseAttributeGroup()

Method Detail

getAttributeGroupId

public java.lang.Integer getAttributeGroupId()

Get the AttributeGroupId

Returns:

Integer

setAttributeGroupId

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

Set the value of AttributeGroupId

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

getDescription

public java.lang.String getDescription()

Get the Description

Returns:

String

setDescription

public void setDescription(java.lang.String v)

Set the value of Description

Parameters:

v - new value

getModuleId

public java.lang.Integer getModuleId()

Get the ModuleId

Returns:

Integer

setModuleId

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

Set the value of ModuleId

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

getIssueTypeId

public java.lang.Integer getIssueTypeId()

Get the IssueTypeId

Returns:

Integer

setIssueTypeId

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

Set the value of IssueTypeId

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

getActive

public boolean getActive()

Get the Active

Returns:

boolean

setActive

public void setActive(boolean v)

Set the value of Active

Parameters:

v - new value

getDedupe

public boolean getDedupe()

Get the Dedupe

Returns:

boolean

setDedupe

public void setDedupe(boolean v)

Set the value of Dedupe

Parameters:

v - new value

getOrder

public int getOrder()

Get the Order

Returns:

int

setOrder

public void setOrder(int v)

Set the value of Order

Parameters:

v - new value

setModule

public void setModule(Module v)
               throws org.apache.torque.TorqueException

Declares an association between this object and a Module object

Parameters:

v - Module

Throws:

org.apache.torque.TorqueException

getModule

public Module getModule()
                 throws org.apache.torque.TorqueException

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

Returns:

the associated Module object

Throws:

org.apache.torque.TorqueException

getModule

public Module getModule(java.sql.Connection connection)
                 throws org.apache.torque.TorqueException

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

Throws:

org.apache.torque.TorqueException

setModuleKey

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

setIssueType

public void setIssueType(IssueType v)
                  throws org.apache.torque.TorqueException

Declares an association between this object and a IssueType object

Parameters:

v - IssueType

Throws:

org.apache.torque.TorqueException

getIssueType

public IssueType getIssueType()
                       throws org.apache.torque.TorqueException

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

Returns:

the associated IssueType object

Throws:

org.apache.torque.TorqueException

getIssueType

public IssueType getIssueType(java.sql.Connection connection)
                       throws org.apache.torque.TorqueException

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

Throws:

org.apache.torque.TorqueException

setIssueTypeKey

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

initRAttributeAttributeGroups

protected void initRAttributeAttributeGroups()

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

addRAttributeAttributeGroup

public void addRAttributeAttributeGroup(RAttributeAttributeGroup l)
                                 throws org.apache.torque.TorqueException

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

Parameters:

l - RAttributeAttributeGroup

Throws:

org.apache.torque.TorqueException

getRAttributeAttributeGroups

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

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

Returns:

the collection of associated objects

Throws:

org.apache.torque.TorqueException

getRAttributeAttributeGroups

public java.util.List getRAttributeAttributeGroups(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 AttributeGroup has previously been saved, it will retrieve related RAttributeAttributeGroups from storage. If this AttributeGroup 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

getRAttributeAttributeGroups

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

If this collection has already been initialized, returns the collection. Otherwise returns the results of getRAttributeAttributeGroups(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

getRAttributeAttributeGroups

public java.util.List getRAttributeAttributeGroups(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 AttributeGroup has previously been saved, it will retrieve related RAttributeAttributeGroups from storage. If this AttributeGroup 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

getRAttributeAttributeGroupsJoinAttribute

protected java.util.List getRAttributeAttributeGroupsJoinAttribute(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 AttributeGroup is new, it will return an empty collection; or if this AttributeGroup has previously been saved, it will retrieve related RAttributeAttributeGroups 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 AttributeGroup.

Throws:

org.apache.torque.TorqueException

getRAttributeAttributeGroupsJoinAttributeGroup

protected java.util.List getRAttributeAttributeGroupsJoinAttributeGroup(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 AttributeGroup is new, it will return an empty collection; or if this AttributeGroup has previously been saved, it will retrieve related RAttributeAttributeGroups 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 AttributeGroup.

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 using ObjectKey.

Specified by:

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

Parameters:

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

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

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

Throws:

org.apache.torque.TorqueException

getPeer

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