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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

TurbineRolePermission

public abstract class BaseTurbineRolePermission

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 TurbineRolePermission

See Also:

Serialized Form

Field Summary

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

NEW_ID

Constructor Summary

BaseTurbineRolePermission()

Method Summary

TurbineRolePermission	copy() Makes a copy of this object.
TurbineRolePermission	copy(boolean deepcopy) Makes a copy of this object.
TurbineRolePermission	copy(boolean deepcopy, java.sql.Connection con) Makes a copy of this object using connection.
TurbineRolePermission	copy(java.sql.Connection con) Makes a copy of this object using connection.
protected TurbineRolePermission	copyInto(TurbineRolePermission copyObj) Fills the copyObj with the contents of this object.
protected TurbineRolePermission	copyInto(TurbineRolePermission copyObj, boolean deepcopy) Fills the copyObj with the contents of this object.
protected TurbineRolePermission	copyInto(TurbineRolePermission copyObj, boolean deepcopy, java.sql.Connection con) Fills the copyObj with the contents of this object using connection.
protected TurbineRolePermission	copyInto(TurbineRolePermission 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.
TurbineRolePermissionPeer	getPeer() returns a peer instance associated with this om.
int	getPermissionId() Get the PermissionId
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().
TurbinePermission	getTurbinePermission() Returns the associated TurbinePermission object.
TurbinePermission	getTurbinePermission(java.sql.Connection connection) Return the associated TurbinePermission object If it was not retrieved before, the object is retrieved from the database using the passed connection
TurbineRole	getTurbineRole() Returns the associated TurbineRole object.
TurbineRole	getTurbineRole(java.sql.Connection connection) Return the associated TurbineRole object If it was not retrieved before, the object is retrieved from the database using the passed connection
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	setPermissionId(int v) Set the value of PermissionId
void	setPrimaryKey(int roleId, int permissionId) 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	setRoleId(int v) Set the value of RoleId
void	setTurbinePermission(TurbinePermission v) Declares an association between this object and a TurbinePermission object
void	setTurbinePermissionKey(org.apache.torque.om.ObjectKey key) Provides convenient way to set a relationship based on a ObjectKey, for example bar.setFooKey(foo.getPrimaryKey())
void	setTurbineRole(TurbineRole v) Declares an association between this object and a TurbineRole object
void	setTurbineRoleKey(org.apache.torque.om.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 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

Constructor Detail

BaseTurbineRolePermission

public BaseTurbineRolePermission()

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

getPermissionId

public int getPermissionId()

Get the PermissionId

Returns:

int

setPermissionId

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

Set the value of PermissionId

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

setTurbineRole

public void setTurbineRole(TurbineRole v)
                    throws org.apache.torque.TorqueException

Declares an association between this object and a TurbineRole object

Parameters:

v - TurbineRole

Throws:

org.apache.torque.TorqueException

getTurbineRole

public TurbineRole getTurbineRole()
                           throws org.apache.torque.TorqueException

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

Returns:

the associated TurbineRole object

Throws:

org.apache.torque.TorqueException

getTurbineRole

public TurbineRole getTurbineRole(java.sql.Connection connection)
                           throws org.apache.torque.TorqueException

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

Throws:

org.apache.torque.TorqueException

setTurbineRoleKey

public void setTurbineRoleKey(org.apache.torque.om.ObjectKey key)
                       throws org.apache.torque.TorqueException

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

Throws:

org.apache.torque.TorqueException

setTurbinePermission

public void setTurbinePermission(TurbinePermission v)
                          throws org.apache.torque.TorqueException

Declares an association between this object and a TurbinePermission object

Parameters:

v - TurbinePermission

Throws:

org.apache.torque.TorqueException

getTurbinePermission

public TurbinePermission getTurbinePermission()
                                       throws org.apache.torque.TorqueException

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

Returns:

the associated TurbinePermission object

Throws:

org.apache.torque.TorqueException

getTurbinePermission

public TurbinePermission getTurbinePermission(java.sql.Connection connection)
                                       throws org.apache.torque.TorqueException

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

Throws:

org.apache.torque.TorqueException

setTurbinePermissionKey

public void setTurbinePermissionKey(org.apache.torque.om.ObjectKey key)
                             throws org.apache.torque.TorqueException

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

Throws:

org.apache.torque.TorqueException

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 with an ObjectKey

Parameters:

key -

Throws:

org.apache.torque.TorqueException

setPrimaryKey

public void setPrimaryKey(int roleId,
                          int permissionId)
                   throws org.apache.torque.TorqueException

Set the PrimaryKey using SimpleKeys.

Parameters:

roleId - int

permissionId - 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.

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 TurbineRolePermission 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 TurbineRolePermission 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 TurbineRolePermission 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 TurbineRolePermission 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 TurbineRolePermission copyInto(TurbineRolePermission 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 TurbineRolePermission copyInto(TurbineRolePermission 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 TurbineRolePermission copyInto(TurbineRolePermission 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 TurbineRolePermission copyInto(TurbineRolePermission 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 TurbineRolePermissionPeer 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()