org.tigris.scarab.om
Class BaseScope

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

All Implemented Interfaces:

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

Direct Known Subclasses:

Scope

public abstract class BaseScope

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 Scope

See Also:

Serialized Form

Field Summary

protected java.util.List	collIssueTemplateInfos Collection to store aggregation of collIssueTemplateInfos
protected java.util.List	collQuerys Collection to store aggregation of collQuerys
protected java.util.List	collReports Collection to store aggregation of collReports

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

NEW_ID

Constructor Summary

BaseScope()

Method Summary

void	addIssueTemplateInfo(IssueTemplateInfo l) Method called to associate a IssueTemplateInfo object to this object through the IssueTemplateInfo foreign key attribute
void	addQuery(Query l) Method called to associate a Query object to this object through the Query foreign key attribute
void	addReport(Report l) Method called to associate a Report object to this object through the Report foreign key attribute
Scope	copy() Makes a copy of this object.
protected Scope	copyInto(Scope 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.util.List	getIssueTemplateInfos() If this collection has already been initialized, returns the collection.
java.util.List	getIssueTemplateInfos(java.sql.Connection con) If this collection has already been initialized, returns the collection.
java.util.List	getIssueTemplateInfos(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.util.List	getIssueTemplateInfos(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	getIssueTemplateInfosJoinIssue(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	getIssueTemplateInfosJoinScope(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.lang.String	getName() Get the Name
ScopePeer	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.util.List	getQuerys() If this collection has already been initialized, returns the collection.
java.util.List	getQuerys(java.sql.Connection con) If this collection has already been initialized, returns the collection.
java.util.List	getQuerys(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.util.List	getQuerys(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	getQuerysJoinFrequency(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	getQuerysJoinIssueType(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	getQuerysJoinMITList(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	getQuerysJoinScarabModule(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	getQuerysJoinScarabUserImpl(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	getQuerysJoinScope(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.util.List	getReports() If this collection has already been initialized, returns the collection.
java.util.List	getReports(java.sql.Connection con) If this collection has already been initialized, returns the collection.
java.util.List	getReports(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.util.List	getReports(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	getReportsJoinIssueType(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	getReportsJoinScarabModule(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	getReportsJoinScarabUserImpl(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	getReportsJoinScope(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.lang.Integer	getScopeId() Get the ScopeId
protected void	initIssueTemplateInfos() Temporary storage of collIssueTemplateInfos to save a possible db hit in the event objects are add to the collection, but the complete collection is never requested.
protected void	initQuerys() Temporary storage of collQuerys to save a possible db hit in the event objects are add to the collection, but the complete collection is never requested.
protected void	initReports() Temporary storage of collReports 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	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	setQueryKey(java.lang.String key) set an id that differentiates this object from others of its class.
void	setScopeId(java.lang.Integer v) Set the value of ScopeId
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

collQuerys

protected java.util.List collQuerys

Collection to store aggregation of collQuerys

collIssueTemplateInfos

protected java.util.List collIssueTemplateInfos

Collection to store aggregation of collIssueTemplateInfos

collReports

protected java.util.List collReports

Collection to store aggregation of collReports

Constructor Detail

BaseScope

public BaseScope()

Method Detail

getScopeId

public java.lang.Integer getScopeId()

Get the ScopeId

Returns:

Integer

setScopeId

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

Set the value of ScopeId

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

initQuerys

protected void initQuerys()

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

addQuery

public void addQuery(Query l)
              throws org.apache.torque.TorqueException

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

Parameters:

l - Query

Throws:

org.apache.torque.TorqueException

getQuerys

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

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

Returns:

the collection of associated objects

Throws:

org.apache.torque.TorqueException

getQuerys

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

getQuerys

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

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

getQuerys

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

getQuerysJoinScarabUserImpl

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

Throws:

org.apache.torque.TorqueException

getQuerysJoinScope

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

Throws:

org.apache.torque.TorqueException

getQuerysJoinScarabModule

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

Throws:

org.apache.torque.TorqueException

getQuerysJoinIssueType

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

Throws:

org.apache.torque.TorqueException

getQuerysJoinMITList

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

Throws:

org.apache.torque.TorqueException

getQuerysJoinFrequency

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

Throws:

org.apache.torque.TorqueException

initIssueTemplateInfos

protected void initIssueTemplateInfos()

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

addIssueTemplateInfo

public void addIssueTemplateInfo(IssueTemplateInfo l)
                          throws org.apache.torque.TorqueException

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

Parameters:

l - IssueTemplateInfo

Throws:

org.apache.torque.TorqueException

getIssueTemplateInfos

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

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

Returns:

the collection of associated objects

Throws:

org.apache.torque.TorqueException

getIssueTemplateInfos

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

getIssueTemplateInfos

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

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

getIssueTemplateInfos

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

getIssueTemplateInfosJoinIssue

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

Throws:

org.apache.torque.TorqueException

getIssueTemplateInfosJoinScope

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

Throws:

org.apache.torque.TorqueException

initReports

protected void initReports()

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

addReport

public void addReport(Report l)
               throws org.apache.torque.TorqueException

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

Parameters:

l - Report

Throws:

org.apache.torque.TorqueException

getReports

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

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

Returns:

the collection of associated objects

Throws:

org.apache.torque.TorqueException

getReports

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

getReports

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

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

getReports

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

getReportsJoinIssueType

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

Throws:

org.apache.torque.TorqueException

getReportsJoinScarabUserImpl

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

Throws:

org.apache.torque.TorqueException

getReportsJoinScarabModule

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

Throws:

org.apache.torque.TorqueException

getReportsJoinScope

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

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

Throws:

org.apache.torque.TorqueException

getPeer

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