com.konakart.om
Class BaseCategoriesDescription

java.lang.Object
  org.apache.torque.om.BaseObject
      com.konakart.om.BaseCategoriesDescription

All Implemented Interfaces:

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

Direct Known Subclasses:

CategoriesDescription

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

This class was autogenerated by Torque on: [Wed Jun 13 21:13:35 BST 2012] Object.vm template overriden for KonaKart You should not use this class directly. It should not even be extended all references should be to CategoriesDescription

See Also:

Serialized Form

Field Summary

protected java.util.List

collCategoriess Collection to store aggregation of collCategoriess

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

NEW_ID

Constructor Summary

BaseCategoriesDescription()

Method Summary

void	addCategories(Categories l) Method called to associate a Categories object to this object through the Categories foreign key attribute
void	addCategories(Categories l, java.sql.Connection con) Method called to associate a Categories object to this object through the Categories foreign key attribute using connection.
CategoriesDescription	copy() Makes a copy of this object.
CategoriesDescription	copy(boolean deepcopy) Makes a copy of this object.
CategoriesDescription	copy(boolean deepcopy, java.sql.Connection con) Makes a copy of this object using connection.
CategoriesDescription	copy(java.sql.Connection con) Makes a copy of this object using connection.
protected CategoriesDescription	copyInto(CategoriesDescription copyObj) Fills the copyObj with the contents of this object.
protected CategoriesDescription	copyInto(CategoriesDescription copyObj, boolean deepcopy) Fills the copyObj with the contents of this object.
protected CategoriesDescription	copyInto(CategoriesDescription copyObj, boolean deepcopy, java.sql.Connection con) Fills the copyObj with the contents of this object using connection.
protected CategoriesDescription	copyInto(CategoriesDescription copyObj, java.sql.Connection con) Fills the copyObj with the contents of this object using connection.
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.
int	getCategoriesId() Get the CategoriesId
java.lang.String	getCategoriesName() Get the CategoriesName
java.util.List	getCategoriess() If this collection has already been initialized, returns the collection.
java.util.List	getCategoriess(java.sql.Connection con) If this collection has already been initialized, returns the collection.
java.util.List	getCategoriess(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.util.List	getCategoriess(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	getCategoriessJoinCategoriesDescription(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.lang.String	getDescription() Get the Description
static java.util.List<java.lang.String>	getFieldNames() Generate a list of field names.
int	getLanguageId() Get the LanguageId
CategoriesDescriptionPeer	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	getStoreId() Get the StoreId
org.apache.torque.map.TableMap	getTableMap() Retrieves the TableMap object related to this Table data without compiler warnings of using getPeer().getTableMap().
protected void	initCategoriess() Temporary storage of collCategoriess to save a possible db hit in the event objects are add to the collection, but the complete collection is never requested.
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	setCategoriesId(int v) Set the value of CategoriesId
void	setCategoriesName(java.lang.String v) Set the value of CategoriesName
void	setDescription(java.lang.String v) Set the value of Description
void	setLanguageId(int v) Set the value of LanguageId
void	setPrimaryKey(int categoriesId, int languageId) 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	setStoreId(java.lang.String v) Set the value of StoreId
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

collCategoriess

protected java.util.List collCategoriess

Collection to store aggregation of collCategoriess

Constructor Detail

BaseCategoriesDescription

public BaseCategoriesDescription()

Method Detail

getCategoriesId

public int getCategoriesId()

Get the CategoriesId

Returns:

int

setCategoriesId

public void setCategoriesId(int v)
                     throws org.apache.torque.TorqueException

Set the value of CategoriesId

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

getStoreId

public java.lang.String getStoreId()

Get the StoreId

Returns:

String

setStoreId

public void setStoreId(java.lang.String v)

Set the value of StoreId

Parameters:

v - new value

getLanguageId

public int getLanguageId()

Get the LanguageId

Returns:

int

setLanguageId

public void setLanguageId(int v)

Set the value of LanguageId

Parameters:

v - new value

getCategoriesName

public java.lang.String getCategoriesName()

Get the CategoriesName

Returns:

String

setCategoriesName

public void setCategoriesName(java.lang.String v)

Set the value of CategoriesName

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

initCategoriess

protected void initCategoriess()

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

addCategories

public void addCategories(Categories l)
                   throws org.apache.torque.TorqueException

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

Parameters:

l - Categories

Throws:

org.apache.torque.TorqueException

addCategories

public void addCategories(Categories l,
                          java.sql.Connection con)
                   throws org.apache.torque.TorqueException

Method called to associate a Categories object to this object through the Categories foreign key attribute using connection.

Parameters:

l - Categories

Throws:

org.apache.torque.TorqueException

getCategoriess

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

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

Returns:

the collection of associated objects

Throws:

org.apache.torque.TorqueException

getCategoriess

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

getCategoriess

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

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

getCategoriess

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

getCategoriessJoinCategoriesDescription

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

Throws:

org.apache.torque.TorqueException

getFieldNames

public static java.util.List<java.lang.String> 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 occurs 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 occurs 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 occurs 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(int categoriesId,
                          int languageId)
                   throws org.apache.torque.TorqueException

Set the PrimaryKey using SimpleKeys.

Parameters:

categoriesId - int

languageId - 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 CategoriesDescription 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.

Returns:

a CategoriesDescription object

Throws:

org.apache.torque.TorqueException

copy

public CategoriesDescription copy(java.sql.Connection con)
                           throws org.apache.torque.TorqueException

Makes a copy of this object using connection. 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.

Parameters:

con - the database connection to read associated objects.

Returns:

a CategoriesDescription object

Throws:

org.apache.torque.TorqueException

copy

public CategoriesDescription 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.

Returns:

a CategoriesDescription object

Throws:

org.apache.torque.TorqueException

copy

public CategoriesDescription copy(boolean deepcopy,
                                  java.sql.Connection con)
                           throws org.apache.torque.TorqueException

Makes a copy of this object using connection. 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.

con - the database connection to read associated objects.

Returns:

a CategoriesDescription object

Throws:

org.apache.torque.TorqueException

copyInto

protected CategoriesDescription copyInto(CategoriesDescription 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 CategoriesDescription copyInto(CategoriesDescription copyObj,
                                         java.sql.Connection con)
                                  throws org.apache.torque.TorqueException

Fills the copyObj with the contents of this object using connection. The associated objects are also copied and treated as new objects.

Parameters:

copyObj - the object to fill.

con - the database connection to read associated objects.

Throws:

org.apache.torque.TorqueException

copyInto

protected CategoriesDescription copyInto(CategoriesDescription 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

copyInto

protected CategoriesDescription copyInto(CategoriesDescription copyObj,
                                         boolean deepcopy,
                                         java.sql.Connection con)
                                  throws org.apache.torque.TorqueException

Fills the copyObj with the contents of this object using connection. 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.

con - the database connection to read associated objects.

Returns:

a CategoriesDescription object

Throws:

org.apache.torque.TorqueException

getPeer

public CategoriesDescriptionPeer 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.

Returns:

The CategoriesDescriptionPeer object.

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