org.tigris.scarab.om
Class BaseDepend

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

All Implemented Interfaces:

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

Direct Known Subclasses:

Depend

public abstract class BaseDepend

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 Depend

See Also:

Serialized Form

Field Summary

protected java.util.List

collActivitys Collection to store aggregation of collActivitys

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

NEW_ID

Constructor Summary

BaseDepend()

Method Summary

void	addActivity(Activity l) Method called to associate a Activity object to this object through the Activity foreign key attribute
Depend	copy() Makes a copy of this object.
protected Depend	copyInto(Depend copyObj)
java.util.List	getActivitys() If this collection has already been initialized, returns the collection.
java.util.List	getActivitys(java.sql.Connection con) If this collection has already been initialized, returns the collection.
java.util.List	getActivitys(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.util.List	getActivitys(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	getActivitysJoinActivitySet(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	getActivitysJoinAttachment(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	getActivitysJoinAttribute(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	getActivitysJoinAttributeOptionRelatedByNewOptionId(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	getActivitysJoinAttributeOptionRelatedByOldOptionId(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	getActivitysJoinDepend(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	getActivitysJoinIssue(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	getActivitysJoinScarabUserImplRelatedByNewUserId(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	getActivitysJoinScarabUserImplRelatedByOldUserId(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
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.
boolean	getDeleted() Get the Deleted
java.lang.Integer	getDependId() Get the DependId
DependType	getDependType() Returns the associated DependType object.
DependType	getDependType(java.sql.Connection connection) Return the associated DependType object If it was not retrieved before, the object is retrieved from the database using the passed connection
static java.util.List	getFieldNames() Generate a list of field names.
Issue	getIssueRelatedByObservedId() Returns the associated Issue object.
Issue	getIssueRelatedByObservedId(java.sql.Connection connection) Return the associated Issue object If it was not retrieved before, the object is retrieved from the database using the passed connection
Issue	getIssueRelatedByObserverId() Returns the associated Issue object.
Issue	getIssueRelatedByObserverId(java.sql.Connection connection) Return the associated Issue object If it was not retrieved before, the object is retrieved from the database using the passed connection
java.lang.Long	getObservedId() Get the ObservedId
java.lang.Long	getObserverId() Get the ObserverId
DependPeer	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.Integer	getTypeId() Get the TypeId
protected void	initActivitys() Temporary storage of collActivitys to save a possible db hit in the event objects are add to the collection, but the complete collection is never requested.
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	setDeleted(boolean v) Set the value of Deleted
void	setDependId(java.lang.Integer v) Set the value of DependId
void	setDependType(DependType v) Declares an association between this object and a DependType object
void	setDependTypeKey(org.apache.torque.om.ObjectKey key) Provides convenient way to set a relationship based on a ObjectKey, for example bar.setFooKey(foo.getPrimaryKey())
void	setIssueRelatedByObservedId(Issue v) Declares an association between this object and a Issue object
void	setIssueRelatedByObservedIdKey(org.apache.torque.om.ObjectKey key) Provides convenient way to set a relationship based on a ObjectKey, for example bar.setFooKey(foo.getPrimaryKey())
void	setIssueRelatedByObserverId(Issue v) Declares an association between this object and a Issue object
void	setIssueRelatedByObserverIdKey(org.apache.torque.om.ObjectKey key) Provides convenient way to set a relationship based on a ObjectKey, for example bar.setFooKey(foo.getPrimaryKey())
void	setObservedId(java.lang.Long v) Set the value of ObservedId
void	setObserverId(java.lang.Long v) Set the value of ObserverId
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	setQueryKey(java.lang.String key) set an id that differentiates this object from others of its class.
void	setTypeId(java.lang.Integer v) Set the value of TypeId
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

collActivitys

protected java.util.List collActivitys

Collection to store aggregation of collActivitys

Constructor Detail

BaseDepend

public BaseDepend()

Method Detail

getDependId

public java.lang.Integer getDependId()

Get the DependId

Returns:

Integer

setDependId

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

Set the value of DependId

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

getObservedId

public java.lang.Long getObservedId()

Get the ObservedId

Returns:

Long

setObservedId

public void setObservedId(java.lang.Long v)
                   throws org.apache.torque.TorqueException

Set the value of ObservedId

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

getObserverId

public java.lang.Long getObserverId()

Get the ObserverId

Returns:

Long

setObserverId

public void setObserverId(java.lang.Long v)
                   throws org.apache.torque.TorqueException

Set the value of ObserverId

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

getTypeId

public java.lang.Integer getTypeId()

Get the TypeId

Returns:

Integer

setTypeId

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

Set the value of TypeId

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

getDeleted

public boolean getDeleted()

Get the Deleted

Returns:

boolean

setDeleted

public void setDeleted(boolean v)

Set the value of Deleted

Parameters:

v - new value

setIssueRelatedByObservedId

public void setIssueRelatedByObservedId(Issue v)
                                 throws org.apache.torque.TorqueException

Declares an association between this object and a Issue object

Parameters:

v - Issue

Throws:

org.apache.torque.TorqueException

getIssueRelatedByObservedId

public Issue getIssueRelatedByObservedId()
                                  throws org.apache.torque.TorqueException

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

Returns:

the associated Issue object

Throws:

org.apache.torque.TorqueException

getIssueRelatedByObservedId

public Issue getIssueRelatedByObservedId(java.sql.Connection connection)
                                  throws org.apache.torque.TorqueException

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

Throws:

org.apache.torque.TorqueException

setIssueRelatedByObservedIdKey

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

setIssueRelatedByObserverId

public void setIssueRelatedByObserverId(Issue v)
                                 throws org.apache.torque.TorqueException

Declares an association between this object and a Issue object

Parameters:

v - Issue

Throws:

org.apache.torque.TorqueException

getIssueRelatedByObserverId

public Issue getIssueRelatedByObserverId()
                                  throws org.apache.torque.TorqueException

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

Returns:

the associated Issue object

Throws:

org.apache.torque.TorqueException

getIssueRelatedByObserverId

public Issue getIssueRelatedByObserverId(java.sql.Connection connection)
                                  throws org.apache.torque.TorqueException

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

Throws:

org.apache.torque.TorqueException

setIssueRelatedByObserverIdKey

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

setDependType

public void setDependType(DependType v)
                   throws org.apache.torque.TorqueException

Declares an association between this object and a DependType object

Parameters:

v - DependType

Throws:

org.apache.torque.TorqueException

getDependType

public DependType getDependType()
                         throws org.apache.torque.TorqueException

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

Returns:

the associated DependType object

Throws:

org.apache.torque.TorqueException

getDependType

public DependType getDependType(java.sql.Connection connection)
                         throws org.apache.torque.TorqueException

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

Throws:

org.apache.torque.TorqueException

setDependTypeKey

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

initActivitys

protected void initActivitys()

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

addActivity

public void addActivity(Activity l)
                 throws org.apache.torque.TorqueException

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

Parameters:

l - Activity

Throws:

org.apache.torque.TorqueException

getActivitys

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

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

Returns:

the collection of associated objects

Throws:

org.apache.torque.TorqueException

getActivitys

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

getActivitys

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

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

getActivitys

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

getActivitysJoinIssue

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

Throws:

org.apache.torque.TorqueException

getActivitysJoinAttribute

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

Throws:

org.apache.torque.TorqueException

getActivitysJoinActivitySet

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

Throws:

org.apache.torque.TorqueException

getActivitysJoinScarabUserImplRelatedByOldUserId

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

Throws:

org.apache.torque.TorqueException

getActivitysJoinScarabUserImplRelatedByNewUserId

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

Throws:

org.apache.torque.TorqueException

getActivitysJoinAttributeOptionRelatedByOldOptionId

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

Throws:

org.apache.torque.TorqueException

getActivitysJoinAttributeOptionRelatedByNewOptionId

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

Throws:

org.apache.torque.TorqueException

getActivitysJoinAttachment

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

Throws:

org.apache.torque.TorqueException

getActivitysJoinDepend

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

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

Specified by:

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

Parameters:

key - dependId 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

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

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

Throws:

org.apache.torque.TorqueException

getPeer

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