org.tigris.scarab.om
Class BasePendingGroupUserRole

java.lang.Object
  org.apache.torque.om.BaseObject
      org.tigris.scarab.om.BasePendingGroupUserRole

All Implemented Interfaces:

org.apache.torque.om.Persistent, org.apache.fulcrum.intake.Retrievable, java.io.Serializable

Direct Known Subclasses:

PendingGroupUserRole

public abstract class BasePendingGroupUserRole

extends org.apache.torque.om.BaseObject

implements org.apache.fulcrum.intake.Retrievable

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

See Also:

Serialized Form

Field Summary

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

NEW_ID

Constructor Summary

BasePendingGroupUserRole()

Method Summary

PendingGroupUserRole	copy() Makes a copy of this object.
protected PendingGroupUserRole	copyInto(PendingGroupUserRole 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.Integer	getGroupId() Get the GroupId
Module	getModule() Returns the associated Module object.
Module	getModule(java.sql.Connection connection) Return the associated Module object If it was not retrieved before, the object is retrieved from the database using the passed connection
PendingGroupUserRolePeer	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.
java.lang.String	getQueryKey() get an id that differentiates this object from others of its class.
java.lang.String	getRoleName() Get the RoleName
ScarabUser	getScarabUser() Returns the associated ScarabUser object.
ScarabUser	getScarabUser(java.sql.Connection connection) Return the associated ScarabUser object If it was not retrieved before, the object is retrieved from the database using the passed connection
java.lang.Integer	getUserId() Get the UserId
protected boolean	isCacheOnSave() Specify whether to cache the object after saving to the db.
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	setGroupId(java.lang.Integer v) Set the value of GroupId
void	setModule(Module v) Declares an association between this object and a Module object
void	setModuleKey(org.apache.torque.om.ObjectKey key) Provides convenient way to set a relationship based on a ObjectKey, for example bar.setFooKey(foo.getPrimaryKey())
void	setPrimaryKey(java.lang.Integer userId, java.lang.Integer groupId, java.lang.String roleName) 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	setQueryKey(java.lang.String key) set an id that differentiates this object from others of its class.
void	setRoleName(java.lang.String v) Set the value of RoleName
void	setScarabUser(ScarabUser v) Declares an association between this object and a ScarabUser object
void	setScarabUserKey(org.apache.torque.om.ObjectKey key) Provides convenient way to set a relationship based on a ObjectKey, for example bar.setFooKey(foo.getPrimaryKey())
void	setUserId(java.lang.Integer v) Set the value of UserId
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

BasePendingGroupUserRole

public BasePendingGroupUserRole()

Method Detail

getUserId

public java.lang.Integer getUserId()

Get the UserId

Returns:

Integer

setUserId

public void setUserId(java.lang.Integer v)
               throws org.apache.torque.TorqueException

Set the value of UserId

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

getGroupId

public java.lang.Integer getGroupId()

Get the GroupId

Returns:

Integer

setGroupId

public void setGroupId(java.lang.Integer v)
                throws org.apache.torque.TorqueException

Set the value of GroupId

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

getRoleName

public java.lang.String getRoleName()

Get the RoleName

Returns:

String

setRoleName

public void setRoleName(java.lang.String v)

Set the value of RoleName

Parameters:

v - new value

setScarabUser

public void setScarabUser(ScarabUser v)
                   throws org.apache.torque.TorqueException

Declares an association between this object and a ScarabUser object

Parameters:

v - ScarabUser

Throws:

org.apache.torque.TorqueException

getScarabUser

public ScarabUser getScarabUser()
                         throws org.apache.torque.TorqueException

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

Returns:

the associated ScarabUser object

Throws:

org.apache.torque.TorqueException

getScarabUser

public ScarabUser getScarabUser(java.sql.Connection connection)
                         throws org.apache.torque.TorqueException

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

Throws:

org.apache.torque.TorqueException

setScarabUserKey

public void setScarabUserKey(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

setModule

public void setModule(Module v)
               throws org.apache.torque.TorqueException

Declares an association between this object and a Module object

Parameters:

v - Module

Throws:

org.apache.torque.TorqueException

getModule

public Module getModule()
                 throws org.apache.torque.TorqueException

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

Returns:

the associated Module object

Throws:

org.apache.torque.TorqueException

getModule

public Module getModule(java.sql.Connection connection)
                 throws org.apache.torque.TorqueException

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

Throws:

org.apache.torque.TorqueException

setModuleKey

public void setModuleKey(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 name passed in as a String.

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.

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.

Parameters:

pos - position in xml schema

Returns:

value

save

public void save()
          throws org.apache.torque.TorqueException

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

Throws:

org.apache.torque.TorqueException

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

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

Parameters:

con -

Throws:

org.apache.torque.TorqueException

isCacheOnSave

protected boolean isCacheOnSave()

Specify whether to cache the object after saving to the db. This method returns true

setPrimaryKey

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

Set the PrimaryKey with an ObjectKey

Specified by:

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

Parameters:

key -

Throws:

org.apache.torque.TorqueException

setPrimaryKey

public void setPrimaryKey(java.lang.Integer userId,
                          java.lang.Integer groupId,
                          java.lang.String roleName)
                   throws org.apache.torque.TorqueException

Set the PrimaryKey using SimpleKeys.

Parameters:

userId - Integer

groupId - Integer

roleName - String

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

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

getQueryKey

public java.lang.String getQueryKey()

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

Specified by:

getQueryKey in interface org.apache.fulcrum.intake.Retrievable

setQueryKey

public void setQueryKey(java.lang.String key)
                 throws org.apache.torque.TorqueException

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

Specified by:

setQueryKey in interface org.apache.fulcrum.intake.Retrievable

Throws:

org.apache.torque.TorqueException

copy

public PendingGroupUserRole 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 PendingGroupUserRole copyInto(PendingGroupUserRole copyObj)
                                 throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

getPeer

public PendingGroupUserRolePeer 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()