com.aurel.track.persist
Class BaseTDashboardField

java.lang.Object
  BaseObject
      com.aurel.track.persist.BaseTDashboardField

Direct Known Subclasses:

TDashboardField

public abstract class BaseTDashboardField
extends BaseObject

You should not use this class directly. It should not even be extended all references should be to TDashboardField

Field Summary

protected java.util.List

collTDashboardParameters Collection to store aggregation of collTDashboardParameters

Constructor Summary

BaseTDashboardField()

Method Summary

void	addTDashboardParameter(TDashboardParameter l) Method called to associate a TDashboardParameter object to this object through the TDashboardParameter foreign key attribute
void	addTDashboardParameter(TDashboardParameter l, java.sql.Connection con) Method called to associate a TDashboardParameter object to this object through the TDashboardParameter foreign key attribute using connection.
protected void	addTDashboardParameterFromBean(TDashboardParameter toAdd) Method called to associate a TDashboardParameter object to this object.
TDashboardField	copy() Makes a copy of this object.
TDashboardField	copy(boolean deepcopy) Makes a copy of this object.
TDashboardField	copy(boolean deepcopy, java.sql.Connection con) Makes a copy of this object using connection.
TDashboardField	copy(java.sql.Connection con) Makes a copy of this object using connection.
protected TDashboardField	copyInto(TDashboardField copyObj) Fills the copyObj with the contents of this object.
protected TDashboardField	copyInto(TDashboardField copyObj, boolean deepcopy) Fills the copyObj with the contents of this object.
protected TDashboardField	copyInto(TDashboardField copyObj, boolean deepcopy, java.sql.Connection con) Fills the copyObj with the contents of this object using connection.
protected TDashboardField	copyInto(TDashboardField copyObj, java.sql.Connection con) Fills the copyObj with the contents of this object using connection.
static TDashboardField	createTDashboardField(TDashboardFieldBean bean) Creates an instance of TDashboardField with the contents of a TDashboardFieldBean.
static TDashboardField	createTDashboardField(TDashboardFieldBean bean, IdentityMap createdObjects) Creates an instance of TDashboardField with the contents of a TDashboardFieldBean.
TDashboardFieldBean	getBean() Creates a TDashboardFieldBean with the contents of this object This also creates beans for cached related objects, if they exist
TDashboardFieldBean	getBean(IdentityMap createdBeans) Creates a TDashboardFieldBean with the contents of this object intended for internal use only
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.
java.lang.Integer	getColIndex() Get the ColIndex
java.lang.Integer	getColSpan() Get the ColSpan
java.lang.String	getDashboardID() Get the DashboardID
java.lang.String	getDescription() Get the Description
static java.util.List	getFieldNames() Generate a list of field names.
java.lang.Integer	getIndex() Get the Index
java.lang.String	getName() Get the Name
java.lang.Integer	getObjectID() Get the ObjectID
java.lang.Integer	getParent() Get the Parent
TDashboardFieldPeer	getPeer() returns a peer instance associated with this om.
ObjectKey	getPrimaryKey() returns an id that differentiates this object from others of its class.
java.lang.Integer	getRowIndex() Get the RowIndex
java.lang.Integer	getRowSpan() Get the RowSpan
TableMap	getTableMap() Retrieves the TableMap object related to this Table data without compiler warnings of using getPeer().getTableMap().
TDashboardPanel	getTDashboardPanel() Returns the associated TDashboardPanel object.
TDashboardPanel	getTDashboardPanel(java.sql.Connection connection) Return the associated TDashboardPanel object If it was not retrieved before, the object is retrieved from the database using the passed connection
java.util.List	getTDashboardParameters() If this collection has already been initialized, returns the collection.
java.util.List	getTDashboardParameters(Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.util.List	getTDashboardParameters(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	getTDashboardParametersJoinTDashboardField(Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.lang.String	getTheDescription() Get the TheDescription
protected void	initTDashboardParameters() Temporary storage of collTDashboardParameters 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	setColIndex(java.lang.Integer v) Set the value of ColIndex
void	setColSpan(java.lang.Integer v) Set the value of ColSpan
void	setDashboardID(java.lang.String v) Set the value of DashboardID
void	setDescription(java.lang.String v) Set the value of Description
void	setIndex(java.lang.Integer v) Set the value of Index
void	setName(java.lang.String v) Set the value of Name
void	setObjectID(java.lang.Integer v) Set the value of ObjectID
void	setParent(java.lang.Integer v) Set the value of Parent
void	setPrimaryKey(ObjectKey key) Set the PrimaryKey using ObjectKey.
void	setRowIndex(java.lang.Integer v) Set the value of RowIndex
void	setRowSpan(java.lang.Integer v) Set the value of RowSpan
void	setTDashboardPanel(TDashboardPanel v) Declares an association between this object and a TDashboardPanel object
void	setTDashboardPanelKey(ObjectKey key) Provides convenient way to set a relationship based on a ObjectKey, for example bar.setFooKey(foo.getPrimaryKey())
void	setTheDescription(java.lang.String v) Set the value of TheDescription
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

collTDashboardParameters

protected java.util.List collTDashboardParameters

Collection to store aggregation of collTDashboardParameters

Constructor Detail

BaseTDashboardField

public BaseTDashboardField()

Method Detail

getObjectID

public java.lang.Integer getObjectID()

Get the ObjectID

Returns:

Integer

setObjectID

public void setObjectID(java.lang.Integer v)
                 throws TorqueException

Set the value of ObjectID

Parameters:

v - new value

Throws:

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

getIndex

public java.lang.Integer getIndex()

Get the Index

Returns:

Integer

setIndex

public void setIndex(java.lang.Integer v)

Set the value of Index

Parameters:

v - new value

getColIndex

public java.lang.Integer getColIndex()

Get the ColIndex

Returns:

Integer

setColIndex

public void setColIndex(java.lang.Integer v)

Set the value of ColIndex

Parameters:

v - new value

getRowIndex

public java.lang.Integer getRowIndex()

Get the RowIndex

Returns:

Integer

setRowIndex

public void setRowIndex(java.lang.Integer v)

Set the value of RowIndex

Parameters:

v - new value

getColSpan

public java.lang.Integer getColSpan()

Get the ColSpan

Returns:

Integer

setColSpan

public void setColSpan(java.lang.Integer v)

Set the value of ColSpan

Parameters:

v - new value

getRowSpan

public java.lang.Integer getRowSpan()

Get the RowSpan

Returns:

Integer

setRowSpan

public void setRowSpan(java.lang.Integer v)

Set the value of RowSpan

Parameters:

v - new value

getParent

public java.lang.Integer getParent()

Get the Parent

Returns:

Integer

setParent

public void setParent(java.lang.Integer v)
               throws TorqueException

Set the value of Parent

Parameters:

v - new value

Throws:

TorqueException

getDashboardID

public java.lang.String getDashboardID()

Get the DashboardID

Returns:

String

setDashboardID

public void setDashboardID(java.lang.String v)

Set the value of DashboardID

Parameters:

v - new value

getTheDescription

public java.lang.String getTheDescription()

Get the TheDescription

Returns:

String

setTheDescription

public void setTheDescription(java.lang.String v)

Set the value of TheDescription

Parameters:

v - new value

setTDashboardPanel

public void setTDashboardPanel(TDashboardPanel v)
                        throws TorqueException

Declares an association between this object and a TDashboardPanel object

Parameters:

v - TDashboardPanel

Throws:

TorqueException

getTDashboardPanel

public TDashboardPanel getTDashboardPanel()
                                   throws TorqueException

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

Returns:

the associated TDashboardPanel object

Throws:

TorqueException

getTDashboardPanel

public TDashboardPanel getTDashboardPanel(java.sql.Connection connection)
                                   throws TorqueException

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

Throws:

TorqueException

setTDashboardPanelKey

public void setTDashboardPanelKey(ObjectKey key)
                           throws TorqueException

Provides convenient way to set a relationship based on a ObjectKey, for example bar.setFooKey(foo.getPrimaryKey())

Throws:

TorqueException

initTDashboardParameters

protected void initTDashboardParameters()

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

addTDashboardParameter

public void addTDashboardParameter(TDashboardParameter l)
                            throws TorqueException

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

Parameters:

l - TDashboardParameter

Throws:

TorqueException

addTDashboardParameter

public void addTDashboardParameter(TDashboardParameter l,
                                   java.sql.Connection con)
                            throws TorqueException

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

Parameters:

l - TDashboardParameter

Throws:

TorqueException

getTDashboardParameters

public java.util.List getTDashboardParameters()
                                       throws TorqueException

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

Returns:

the collection of associated objects

Throws:

TorqueException

getTDashboardParameters

public java.util.List getTDashboardParameters(Criteria criteria)
                                       throws TorqueException

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this TDashboardField has previously been saved, it will retrieve related TDashboardParameters from storage. If this TDashboardField is new, it will return an empty collection or the current collection, the criteria is ignored on a new object.

Throws:

TorqueException

getTDashboardParameters

public java.util.List getTDashboardParameters(Criteria criteria,
                                              java.sql.Connection con)
                                       throws TorqueException

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this TDashboardField has previously been saved, it will retrieve related TDashboardParameters from storage. If this TDashboardField 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:

TorqueException

getTDashboardParametersJoinTDashboardField

protected java.util.List getTDashboardParametersJoinTDashboardField(Criteria criteria)
                                                             throws TorqueException

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this TDashboardField is new, it will return an empty collection; or if this TDashboardField has previously been saved, it will retrieve related TDashboardParameters 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 TDashboardField.

Throws:

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 field (Java) name passed in as a String.

Parameters:

name - field name

Returns:

value

setByName

public boolean setByName(java.lang.String name,
                         java.lang.Object value)
                  throws TorqueException,
                         java.lang.IllegalArgumentException

Set a field in the object by field (Java) name.

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.

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.

Parameters:

name - peer name

Returns:

value

setByPeerName

public boolean setByPeerName(java.lang.String name,
                             java.lang.Object value)
                      throws TorqueException,
                             java.lang.IllegalArgumentException

Set field values by Peer Field Name

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.

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.

Parameters:

pos - position in xml schema

Returns:

value

setByPosition

public boolean setByPosition(int position,
                             java.lang.Object value)
                      throws TorqueException,
                             java.lang.IllegalArgumentException

Set field values by its position (zero based) in the XML schema.

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.

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.

Throws:

java.lang.Exception

save

public void save(java.lang.String dbName)
          throws 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.

Parameters:

dbName -

Throws:

TorqueException

save

public void save(java.sql.Connection con)
          throws 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

Parameters:

con -

Throws:

TorqueException

setPrimaryKey

public void setPrimaryKey(ObjectKey key)
                   throws TorqueException

Set the PrimaryKey using ObjectKey.

Parameters:

key - objectID ObjectKey

Throws:

TorqueException

getPrimaryKey

public ObjectKey getPrimaryKey()

returns an id that differentiates this object from others of its class.

copy

public TDashboardField copy()
                     throws 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:

TorqueException

copy

public TDashboardField copy(java.sql.Connection con)
                     throws 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.

Throws:

TorqueException

copy

public TDashboardField copy(boolean deepcopy)
                     throws 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.

Throws:

TorqueException

copy

public TDashboardField copy(boolean deepcopy,
                            java.sql.Connection con)
                     throws 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.

Throws:

TorqueException

copyInto

protected TDashboardField copyInto(TDashboardField copyObj)
                            throws 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:

TorqueException

copyInto

protected TDashboardField copyInto(TDashboardField copyObj,
                                   java.sql.Connection con)
                            throws 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:

TorqueException

copyInto

protected TDashboardField copyInto(TDashboardField copyObj,
                                   boolean deepcopy)
                            throws 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:

TorqueException

copyInto

protected TDashboardField copyInto(TDashboardField copyObj,
                                   boolean deepcopy,
                                   java.sql.Connection con)
                            throws 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.

Throws:

TorqueException

getPeer

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

getTableMap

public TableMap getTableMap()
                     throws TorqueException

Retrieves the TableMap object related to this Table data without compiler warnings of using getPeer().getTableMap().

Returns:

The associated TableMap object.

Throws:

TorqueException

getBean

public TDashboardFieldBean getBean()

Creates a TDashboardFieldBean with the contents of this object This also creates beans for cached related objects, if they exist

Returns:

a TDashboardFieldBean with the contents of this object

getBean

public TDashboardFieldBean getBean(IdentityMap createdBeans)

Creates a TDashboardFieldBean with the contents of this object intended for internal use only

Parameters:

createdBeans - a IdentityMap which maps objects to already created beans

Returns:

a TDashboardFieldBean with the contents of this object

createTDashboardField

public static TDashboardField createTDashboardField(TDashboardFieldBean bean)
                                             throws TorqueException

Creates an instance of TDashboardField with the contents of a TDashboardFieldBean. This behaviour could have also been achieved using a constructor, however as this class is abstract no constructors are allowed

Parameters:

bean - the TDashboardFieldBean which contents are used to create the resulting class

Returns:

an instance of TDashboardField with the contents of bean

Throws:

TorqueException

createTDashboardField

public static TDashboardField createTDashboardField(TDashboardFieldBean bean,
                                                    IdentityMap createdObjects)
                                             throws TorqueException

Creates an instance of TDashboardField with the contents of a TDashboardFieldBean. This behaviour could have also been achieved using a constructor, however as this class is abstract no constructors are allowed. This method is intended for internal use only.

Parameters:

bean - the TDashboardFieldBean which contents are used to create the resulting class

createdObjects - a IdentityMap which maps beans to already created objects

Returns:

an instance of TDashboardField with the contents of bean

Throws:

TorqueException

addTDashboardParameterFromBean

protected void addTDashboardParameterFromBean(TDashboardParameter toAdd)

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

Parameters:

toAdd - TDashboardParameter

toString

public java.lang.String toString()