com.aurel.track.persist
Class BaseTField

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

Direct Known Subclasses:

TField

public abstract class BaseTField
extends BaseObject

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

Field Summary

protected java.util.List	collTAttributeValues Collection to store aggregation of collTAttributeValues
protected java.util.List	collTFieldConfigs Collection to store aggregation of collTFieldConfigs
protected java.util.List	collTRoleFields Collection to store aggregation of collTRoleFields
protected java.util.List	collTScreenFields Collection to store aggregation of collTScreenFields

Constructor Summary

BaseTField()

Method Summary

void	addTAttributeValue(TAttributeValue l) Method called to associate a TAttributeValue object to this object through the TAttributeValue foreign key attribute
void	addTAttributeValue(TAttributeValue l, java.sql.Connection con) Method called to associate a TAttributeValue object to this object through the TAttributeValue foreign key attribute using connection.
protected void	addTAttributeValueFromBean(TAttributeValue toAdd) Method called to associate a TAttributeValue object to this object.
void	addTFieldConfig(TFieldConfig l) Method called to associate a TFieldConfig object to this object through the TFieldConfig foreign key attribute
void	addTFieldConfig(TFieldConfig l, java.sql.Connection con) Method called to associate a TFieldConfig object to this object through the TFieldConfig foreign key attribute using connection.
protected void	addTFieldConfigFromBean(TFieldConfig toAdd) Method called to associate a TFieldConfig object to this object.
void	addTRoleField(TRoleField l) Method called to associate a TRoleField object to this object through the TRoleField foreign key attribute
void	addTRoleField(TRoleField l, java.sql.Connection con) Method called to associate a TRoleField object to this object through the TRoleField foreign key attribute using connection.
protected void	addTRoleFieldFromBean(TRoleField toAdd) Method called to associate a TRoleField object to this object.
void	addTScreenField(TScreenField l) Method called to associate a TScreenField object to this object through the TScreenField foreign key attribute
void	addTScreenField(TScreenField l, java.sql.Connection con) Method called to associate a TScreenField object to this object through the TScreenField foreign key attribute using connection.
protected void	addTScreenFieldFromBean(TScreenField toAdd) Method called to associate a TScreenField object to this object.
TField	copy() Makes a copy of this object.
TField	copy(boolean deepcopy) Makes a copy of this object.
TField	copy(boolean deepcopy, java.sql.Connection con) Makes a copy of this object using connection.
TField	copy(java.sql.Connection con) Makes a copy of this object using connection.
protected TField	copyInto(TField copyObj) Fills the copyObj with the contents of this object.
protected TField	copyInto(TField copyObj, boolean deepcopy) Fills the copyObj with the contents of this object.
protected TField	copyInto(TField copyObj, boolean deepcopy, java.sql.Connection con) Fills the copyObj with the contents of this object using connection.
protected TField	copyInto(TField copyObj, java.sql.Connection con) Fills the copyObj with the contents of this object using connection.
static TField	createTField(TFieldBean bean) Creates an instance of TField with the contents of a TFieldBean.
static TField	createTField(TFieldBean bean, IdentityMap createdObjects) Creates an instance of TField with the contents of a TFieldBean.
TFieldBean	getBean() Creates a TFieldBean with the contents of this object This also creates beans for cached related objects, if they exist
TFieldBean	getBean(IdentityMap createdBeans) Creates a TFieldBean 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.String	getDeprecated() Get the Deprecated
java.lang.String	getDescription() Get the Description
static java.util.List	getFieldNames() Generate a list of field names.
java.lang.String	getFieldType() Get the FieldType
java.lang.String	getIsCustom() Get the IsCustom
java.lang.String	getName() Get the Name
java.lang.Integer	getObjectID() Get the ObjectID
java.lang.Integer	getOwner() Get the Owner
TFieldPeer	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.String	getRequired() Get the Required
TableMap	getTableMap() Retrieves the TableMap object related to this Table data without compiler warnings of using getPeer().getTableMap().
java.util.List	getTAttributeValues() If this collection has already been initialized, returns the collection.
java.util.List	getTAttributeValues(Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.util.List	getTAttributeValues(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	getTAttributeValuesJoinTField(Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
protected java.util.List	getTAttributeValuesJoinTWorkItem(Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.util.List	getTFieldConfigs() If this collection has already been initialized, returns the collection.
java.util.List	getTFieldConfigs(Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.util.List	getTFieldConfigs(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	getTFieldConfigsJoinTField(Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
protected java.util.List	getTFieldConfigsJoinTListType(Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
protected java.util.List	getTFieldConfigsJoinTProject(Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
protected java.util.List	getTFieldConfigsJoinTProjectType(Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
TPerson	getTPerson() Returns the associated TPerson object.
TPerson	getTPerson(java.sql.Connection connection) Return the associated TPerson object If it was not retrieved before, the object is retrieved from the database using the passed connection
java.util.List	getTRoleFields() If this collection has already been initialized, returns the collection.
java.util.List	getTRoleFields(Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.util.List	getTRoleFields(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	getTRoleFieldsJoinTField(Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
protected java.util.List	getTRoleFieldsJoinTRole(Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.util.List	getTScreenFields() If this collection has already been initialized, returns the collection.
java.util.List	getTScreenFields(Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.util.List	getTScreenFields(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	getTScreenFieldsJoinTField(Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
protected java.util.List	getTScreenFieldsJoinTScreenPanel(Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
protected void	initTAttributeValues() Temporary storage of collTAttributeValues to save a possible db hit in the event objects are add to the collection, but the complete collection is never requested.
protected void	initTFieldConfigs() Temporary storage of collTFieldConfigs to save a possible db hit in the event objects are add to the collection, but the complete collection is never requested.
protected void	initTRoleFields() Temporary storage of collTRoleFields to save a possible db hit in the event objects are add to the collection, but the complete collection is never requested.
protected void	initTScreenFields() Temporary storage of collTScreenFields 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	setDeprecated(java.lang.String v) Set the value of Deprecated
void	setDescription(java.lang.String v) Set the value of Description
void	setFieldType(java.lang.String v) Set the value of FieldType
void	setIsCustom(java.lang.String v) Set the value of IsCustom
void	setName(java.lang.String v) Set the value of Name
void	setObjectID(java.lang.Integer v) Set the value of ObjectID
void	setOwner(java.lang.Integer v) Set the value of Owner
void	setPrimaryKey(ObjectKey key) Set the PrimaryKey using ObjectKey.
void	setRequired(java.lang.String v) Set the value of Required
void	setTPerson(TPerson v) Declares an association between this object and a TPerson object
void	setTPersonKey(ObjectKey key) Provides convenient way to set a relationship based on a ObjectKey, for example bar.setFooKey(foo.getPrimaryKey())
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

collTFieldConfigs

protected java.util.List collTFieldConfigs

Collection to store aggregation of collTFieldConfigs

collTRoleFields

protected java.util.List collTRoleFields

Collection to store aggregation of collTRoleFields

collTAttributeValues

protected java.util.List collTAttributeValues

Collection to store aggregation of collTAttributeValues

collTScreenFields

protected java.util.List collTScreenFields

Collection to store aggregation of collTScreenFields

Constructor Detail

BaseTField

public BaseTField()

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

getFieldType

public java.lang.String getFieldType()

Get the FieldType

Returns:

String

setFieldType

public void setFieldType(java.lang.String v)

Set the value of FieldType

Parameters:

v - new value

getDeprecated

public java.lang.String getDeprecated()

Get the Deprecated

Returns:

String

setDeprecated

public void setDeprecated(java.lang.String v)

Set the value of Deprecated

Parameters:

v - new value

getIsCustom

public java.lang.String getIsCustom()

Get the IsCustom

Returns:

String

setIsCustom

public void setIsCustom(java.lang.String v)

Set the value of IsCustom

Parameters:

v - new value

getRequired

public java.lang.String getRequired()

Get the Required

Returns:

String

setRequired

public void setRequired(java.lang.String v)

Set the value of Required

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

getOwner

public java.lang.Integer getOwner()

Get the Owner

Returns:

Integer

setOwner

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

Set the value of Owner

Parameters:

v - new value

Throws:

TorqueException

setTPerson

public void setTPerson(TPerson v)
                throws TorqueException

Declares an association between this object and a TPerson object

Parameters:

v - TPerson

Throws:

TorqueException

getTPerson

public TPerson getTPerson()
                   throws TorqueException

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

Returns:

the associated TPerson object

Throws:

TorqueException

getTPerson

public TPerson getTPerson(java.sql.Connection connection)
                   throws TorqueException

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

Throws:

TorqueException

setTPersonKey

public void setTPersonKey(ObjectKey key)
                   throws TorqueException

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

Throws:

TorqueException

initTFieldConfigs

protected void initTFieldConfigs()

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

addTFieldConfig

public void addTFieldConfig(TFieldConfig l)
                     throws TorqueException

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

Parameters:

l - TFieldConfig

Throws:

TorqueException

addTFieldConfig

public void addTFieldConfig(TFieldConfig l,
                            java.sql.Connection con)
                     throws TorqueException

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

Parameters:

l - TFieldConfig

Throws:

TorqueException

getTFieldConfigs

public java.util.List getTFieldConfigs()
                                throws TorqueException

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

Returns:

the collection of associated objects

Throws:

TorqueException

getTFieldConfigs

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

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

Throws:

TorqueException

getTFieldConfigs

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

getTFieldConfigsJoinTField

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

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

Throws:

TorqueException

getTFieldConfigsJoinTListType

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

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

Throws:

TorqueException

getTFieldConfigsJoinTProjectType

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

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

Throws:

TorqueException

getTFieldConfigsJoinTProject

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

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

Throws:

TorqueException

initTRoleFields

protected void initTRoleFields()

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

addTRoleField

public void addTRoleField(TRoleField l)
                   throws TorqueException

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

Parameters:

l - TRoleField

Throws:

TorqueException

addTRoleField

public void addTRoleField(TRoleField l,
                          java.sql.Connection con)
                   throws TorqueException

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

Parameters:

l - TRoleField

Throws:

TorqueException

getTRoleFields

public java.util.List getTRoleFields()
                              throws TorqueException

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

Returns:

the collection of associated objects

Throws:

TorqueException

getTRoleFields

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

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

Throws:

TorqueException

getTRoleFields

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

getTRoleFieldsJoinTRole

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

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

Throws:

TorqueException

getTRoleFieldsJoinTField

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

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

Throws:

TorqueException

initTAttributeValues

protected void initTAttributeValues()

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

addTAttributeValue

public void addTAttributeValue(TAttributeValue l)
                        throws TorqueException

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

Parameters:

l - TAttributeValue

Throws:

TorqueException

addTAttributeValue

public void addTAttributeValue(TAttributeValue l,
                               java.sql.Connection con)
                        throws TorqueException

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

Parameters:

l - TAttributeValue

Throws:

TorqueException

getTAttributeValues

public java.util.List getTAttributeValues()
                                   throws TorqueException

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

Returns:

the collection of associated objects

Throws:

TorqueException

getTAttributeValues

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

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

Throws:

TorqueException

getTAttributeValues

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

getTAttributeValuesJoinTField

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

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

Throws:

TorqueException

getTAttributeValuesJoinTWorkItem

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

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

Throws:

TorqueException

initTScreenFields

protected void initTScreenFields()

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

addTScreenField

public void addTScreenField(TScreenField l)
                     throws TorqueException

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

Parameters:

l - TScreenField

Throws:

TorqueException

addTScreenField

public void addTScreenField(TScreenField l,
                            java.sql.Connection con)
                     throws TorqueException

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

Parameters:

l - TScreenField

Throws:

TorqueException

getTScreenFields

public java.util.List getTScreenFields()
                                throws TorqueException

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

Returns:

the collection of associated objects

Throws:

TorqueException

getTScreenFields

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

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

Throws:

TorqueException

getTScreenFields

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

getTScreenFieldsJoinTScreenPanel

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

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

Throws:

TorqueException

getTScreenFieldsJoinTField

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

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

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 TField 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 TField 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 TField 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 TField 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 TField copyInto(TField 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 TField copyInto(TField 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 TField copyInto(TField 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 TField copyInto(TField 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 TFieldPeer 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 TFieldBean getBean()

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

Returns:

a TFieldBean with the contents of this object

getBean

public TFieldBean getBean(IdentityMap createdBeans)

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

Parameters:

createdBeans - a IdentityMap which maps objects to already created beans

Returns:

a TFieldBean with the contents of this object

createTField

public static TField createTField(TFieldBean bean)
                           throws TorqueException

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

Parameters:

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

Returns:

an instance of TField with the contents of bean

Throws:

TorqueException

createTField

public static TField createTField(TFieldBean bean,
                                  IdentityMap createdObjects)
                           throws TorqueException

Creates an instance of TField with the contents of a TFieldBean. 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 TFieldBean which contents are used to create the resulting class

createdObjects - a IdentityMap which maps beans to already created objects

Returns:

an instance of TField with the contents of bean

Throws:

TorqueException

addTFieldConfigFromBean

protected void addTFieldConfigFromBean(TFieldConfig toAdd)

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

Parameters:

toAdd - TFieldConfig

addTRoleFieldFromBean

protected void addTRoleFieldFromBean(TRoleField toAdd)

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

Parameters:

toAdd - TRoleField

addTAttributeValueFromBean

protected void addTAttributeValueFromBean(TAttributeValue toAdd)

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

Parameters:

toAdd - TAttributeValue

addTScreenFieldFromBean

protected void addTScreenFieldFromBean(TScreenField toAdd)

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

Parameters:

toAdd - TScreenField

toString

public java.lang.String toString()