org.apache.turbine.services.security.torque.om
Class BaseTurbineRole

java.lang.Object
  org.apache.torque.om.BaseObject
      org.apache.turbine.services.security.torque.om.BaseTurbineRole

All Implemented Interfaces:

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

Direct Known Subclasses:

TurbineRole

public abstract class BaseTurbineRole

extends org.apache.torque.om.BaseObject

This class was autogenerated by Torque on: [Tue Nov 04 15:53:51 CET 2008] You should not use this class directly. It should not even be extended all references should be to TurbineRole

See Also:

Serialized Form

Field Summary

protected java.util.List	collTurbineRolePermissions Collection to store aggregation of collTurbineRolePermissions
protected java.util.List	collTurbineUserGroupRoles Collection to store aggregation of collTurbineUserGroupRoles

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

NEW_ID

Constructor Summary

BaseTurbineRole()

Method Summary

void	addTurbineRolePermission(TurbineRolePermission l) Method called to associate a TurbineRolePermission object to this object through the TurbineRolePermission foreign key attribute
void	addTurbineRolePermission(TurbineRolePermission l, java.sql.Connection con) Method called to associate a TurbineRolePermission object to this object through the TurbineRolePermission foreign key attribute using connection.
void	addTurbineUserGroupRole(TurbineUserGroupRole l) Method called to associate a TurbineUserGroupRole object to this object through the TurbineUserGroupRole foreign key attribute
void	addTurbineUserGroupRole(TurbineUserGroupRole l, java.sql.Connection con) Method called to associate a TurbineUserGroupRole object to this object through the TurbineUserGroupRole foreign key attribute using connection.
TurbineRole	copy() Makes a copy of this object.
TurbineRole	copy(boolean deepcopy) Makes a copy of this object.
TurbineRole	copy(boolean deepcopy, java.sql.Connection con) Makes a copy of this object using connection.
TurbineRole	copy(java.sql.Connection con) Makes a copy of this object using connection.
protected TurbineRole	copyInto(TurbineRole copyObj) Fills the copyObj with the contents of this object.
protected TurbineRole	copyInto(TurbineRole copyObj, boolean deepcopy) Fills the copyObj with the contents of this object.
protected TurbineRole	copyInto(TurbineRole copyObj, boolean deepcopy, java.sql.Connection con) Fills the copyObj with the contents of this object using connection.
protected TurbineRole	copyInto(TurbineRole 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.
static java.util.List	getFieldNames() Generate a list of field names.
java.lang.String	getName() Get the Name
TurbineRolePeer	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.
int	getRoleId() Get the RoleId
org.apache.torque.map.TableMap	getTableMap() Retrieves the TableMap object related to this Table data without compiler warnings of using getPeer().getTableMap().
java.util.List	getTurbineRolePermissions() If this collection has already been initialized, returns the collection.
java.util.List	getTurbineRolePermissions(java.sql.Connection con) If this collection has already been initialized, returns the collection.
java.util.List	getTurbineRolePermissions(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.util.List	getTurbineRolePermissions(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	getTurbineRolePermissionsJoinTurbinePermission(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	getTurbineRolePermissionsJoinTurbineRole(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.util.List	getTurbineUserGroupRoles() If this collection has already been initialized, returns the collection.
java.util.List	getTurbineUserGroupRoles(java.sql.Connection con) If this collection has already been initialized, returns the collection.
java.util.List	getTurbineUserGroupRoles(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.util.List	getTurbineUserGroupRoles(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	getTurbineUserGroupRolesJoinTurbineGroup(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	getTurbineUserGroupRolesJoinTurbineRole(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	getTurbineUserGroupRolesJoinTurbineUser(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
protected void	initTurbineRolePermissions() Temporary storage of collTurbineRolePermissions to save a possible db hit in the event objects are add to the collection, but the complete collection is never requested.
protected void	initTurbineUserGroupRoles() Temporary storage of collTurbineUserGroupRoles 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	setName(java.lang.String v) Set the value of Name
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	setRoleId(int v) Set the value of RoleId
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

collTurbineRolePermissions

protected java.util.List collTurbineRolePermissions

Collection to store aggregation of collTurbineRolePermissions

collTurbineUserGroupRoles

protected java.util.List collTurbineUserGroupRoles

Collection to store aggregation of collTurbineUserGroupRoles

Constructor Detail

BaseTurbineRole

public BaseTurbineRole()

Method Detail

getRoleId

public int getRoleId()

Get the RoleId

Returns:

int

setRoleId

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

Set the value of RoleId

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

initTurbineRolePermissions

protected void initTurbineRolePermissions()

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

addTurbineRolePermission

public void addTurbineRolePermission(TurbineRolePermission l)
                              throws org.apache.torque.TorqueException

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

Parameters:

l - TurbineRolePermission

Throws:

org.apache.torque.TorqueException

addTurbineRolePermission

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

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

Parameters:

l - TurbineRolePermission

Throws:

org.apache.torque.TorqueException

getTurbineRolePermissions

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

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

Returns:

the collection of associated objects

Throws:

org.apache.torque.TorqueException

getTurbineRolePermissions

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

getTurbineRolePermissions

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

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

getTurbineRolePermissions

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

getTurbineRolePermissionsJoinTurbineRole

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

Throws:

org.apache.torque.TorqueException

getTurbineRolePermissionsJoinTurbinePermission

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

Throws:

org.apache.torque.TorqueException

initTurbineUserGroupRoles

protected void initTurbineUserGroupRoles()

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

addTurbineUserGroupRole

public void addTurbineUserGroupRole(TurbineUserGroupRole l)
                             throws org.apache.torque.TorqueException

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

Parameters:

l - TurbineUserGroupRole

Throws:

org.apache.torque.TorqueException

addTurbineUserGroupRole

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

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

Parameters:

l - TurbineUserGroupRole

Throws:

org.apache.torque.TorqueException

getTurbineUserGroupRoles

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

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

Returns:

the collection of associated objects

Throws:

org.apache.torque.TorqueException

getTurbineUserGroupRoles

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

getTurbineUserGroupRoles

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

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

getTurbineUserGroupRoles

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

getTurbineUserGroupRolesJoinTurbineUser

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

Throws:

org.apache.torque.TorqueException

getTurbineUserGroupRolesJoinTurbineGroup

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

Throws:

org.apache.torque.TorqueException

getTurbineUserGroupRolesJoinTurbineRole

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

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 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 org.apache.torque.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.

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.

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

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.

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.

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.

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.

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

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

Parameters:

key - roleId 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.

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.

copy

public TurbineRole 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

copy

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

Throws:

org.apache.torque.TorqueException

copy

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

Throws:

org.apache.torque.TorqueException

copy

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

Throws:

org.apache.torque.TorqueException

copyInto

protected TurbineRole copyInto(TurbineRole 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 TurbineRole copyInto(TurbineRole 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 TurbineRole copyInto(TurbineRole 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 TurbineRole copyInto(TurbineRole 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.

Throws:

org.apache.torque.TorqueException

getPeer

public TurbineRolePeer 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 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().

Returns:

The associated TableMap object.

Throws:

org.apache.torque.TorqueException

toString

public java.lang.String toString()