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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

TurbinePermission

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

This class was autogenerated by Torque on: [Mon May 28 10:17:20 EST 2007] You should not use this class directly. It should not even be extended all references should be to TurbinePermission

See Also:

Serialized Form

Field Summary

protected java.util.List

collTurbineRolePermissions Collection to store aggregation of collTurbineRolePermissions

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

NEW_ID

Constructor Summary

BaseTurbinePermission()

Method Summary

void	addTurbineRolePermission(TurbineRolePermission l) Method called to associate a TurbineRolePermission object to this object through the TurbineRolePermission foreign key attribute
TurbinePermission	copy() Makes a copy of this object.
protected TurbinePermission	copyInto(TurbinePermission copyObj)
java.lang.Object	getByName(java.lang.String name) Retrieves a field from the object by 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
TurbinePermissionPeer	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.
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.
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.
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.
void	setName(java.lang.String v) Set the value of Name
void	setPermissionId(int v) Set the value of PermissionId
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.
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

Constructor Detail

BaseTurbinePermission

public BaseTurbinePermission()

Method Detail

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

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

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 TurbinePermission has previously been saved, it will retrieve related TurbineRolePermissions from storage. If this TurbinePermission 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 TurbinePermission has previously been saved, it will retrieve related TurbineRolePermissions from storage. If this TurbinePermission 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 TurbinePermission is new, it will return an empty collection; or if this TurbinePermission 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 TurbinePermission.

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 TurbinePermission is new, it will return an empty collection; or if this TurbinePermission 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 TurbinePermission.

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 name passed in as a String.

Overrides:

getByName in class org.apache.torque.om.BaseObject

Parameters:

name - field name

Returns:

value

getByPeerName

public java.lang.Object getByPeerName(java.lang.String name)

Retrieves a field from the object by name passed in as a String. The String must be one of the static Strings defined in this Class' Peer.

Overrides:

getByPeerName in class org.apache.torque.om.BaseObject

Parameters:

name - peer name

Returns:

value

getByPosition

public java.lang.Object getByPosition(int pos)

Retrieves a field from the object by Position as specified in the xml schema. Zero-based.

Overrides:

getByPosition in class org.apache.torque.om.BaseObject

Parameters:

pos - position in xml schema

Returns:

value

save

public void save()
          throws java.lang.Exception

Stores the object in the database. If the object is new, it inserts it; otherwise an update is performed.

Specified by:

save in interface org.apache.torque.om.Persistent

Specified by:

save in class org.apache.torque.om.BaseObject

Throws:

java.lang.Exception

save

public void save(java.lang.String dbName)
          throws org.apache.torque.TorqueException

Stores the object in the database. If the object is new, it inserts it; otherwise an update is performed. Note: this code is here because the method body is auto-generated conditionally and therefore needs to be in this file instead of in the super class, BaseObject.

Specified by:

save in interface org.apache.torque.om.Persistent

Specified by:

save in class org.apache.torque.om.BaseObject

Parameters:

dbName -

Throws:

org.apache.torque.TorqueException

save

public void save(java.sql.Connection con)
          throws org.apache.torque.TorqueException

Stores the object in the database. If the object is new, it inserts it; otherwise an update is performed. This method is meant to be used as part of a transaction, otherwise use the save() method and the connection details will be handled internally

Specified by:

save in interface org.apache.torque.om.Persistent

Specified by:

save in class org.apache.torque.om.BaseObject

Parameters:

con -

Throws:

org.apache.torque.TorqueException

setPrimaryKey

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

Set the PrimaryKey using ObjectKey.

Specified by:

setPrimaryKey in interface org.apache.torque.om.Persistent

Overrides:

setPrimaryKey in class org.apache.torque.om.BaseObject

Parameters:

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

Specified by:

setPrimaryKey in interface org.apache.torque.om.Persistent

Overrides:

setPrimaryKey in class org.apache.torque.om.BaseObject

Parameters:

key -

Throws:

org.apache.torque.TorqueException

getPrimaryKey

public org.apache.torque.om.ObjectKey getPrimaryKey()

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

Specified by:

getPrimaryKey in interface org.apache.torque.om.Persistent

Overrides:

getPrimaryKey in class org.apache.torque.om.BaseObject

copy

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

copyInto

protected TurbinePermission copyInto(TurbinePermission copyObj)
                              throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

getPeer

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object