org.tigris.scarab.om
Class BaseReport

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

All Implemented Interfaces:

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

Direct Known Subclasses:

Report

public abstract class BaseReport

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 Report

See Also:

Serialized Form

Field Summary

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

NEW_ID

Constructor Summary

BaseReport()

Method Summary

Report	copy() Makes a copy of this object.
protected Report	copyInto(Report 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.
java.util.Date	getCreatedDate() Get the CreatedDate
boolean	getDeleted() Get the Deleted
java.lang.String	getDescription() Get the Description
static java.util.List	getFieldNames() Generate a list of field names.
IssueType	getIssueType() Returns the associated IssueType object.
IssueType	getIssueType(java.sql.Connection connection) Return the associated IssueType object If it was not retrieved before, the object is retrieved from the database using the passed connection
java.lang.Integer	getIssueTypeId() Get the IssueTypeId
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
java.lang.Integer	getModuleId() Get the ModuleId
java.lang.String	getName() Get the Name
ReportPeer	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	getQueryString() Get the QueryString
java.lang.Integer	getReportId() Get the ReportId
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
Scope	getScope() Returns the associated Scope object.
Scope	getScope(java.sql.Connection connection) Return the associated Scope object If it was not retrieved before, the object is retrieved from the database using the passed connection
java.lang.Integer	getScopeId() Get the ScopeId
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	setCreatedDate(java.util.Date v) Set the value of CreatedDate
void	setDeleted(boolean v) Set the value of Deleted
void	setDescription(java.lang.String v) Set the value of Description
void	setIssueType(IssueType v) Declares an association between this object and a IssueType object
void	setIssueTypeId(java.lang.Integer v) Set the value of IssueTypeId
void	setIssueTypeKey(org.apache.torque.om.ObjectKey key) Provides convenient way to set a relationship based on a ObjectKey, for example bar.setFooKey(foo.getPrimaryKey())
void	setModule(Module v) Declares an association between this object and a Module object
void	setModuleId(java.lang.Integer v) Set the value of ModuleId
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	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	setQueryString(java.lang.String v) Set the value of QueryString
void	setReportId(java.lang.Integer v) Set the value of ReportId
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	setScope(Scope v) Declares an association between this object and a Scope object
void	setScopeId(java.lang.Integer v) Set the value of ScopeId
void	setScopeKey(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

BaseReport

public BaseReport()

Method Detail

getReportId

public java.lang.Integer getReportId()

Get the ReportId

Returns:

Integer

setReportId

public void setReportId(java.lang.Integer v)

Set the value of ReportId

Parameters:

v - new value

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

getModuleId

public java.lang.Integer getModuleId()

Get the ModuleId

Returns:

Integer

setModuleId

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

Set the value of ModuleId

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

getIssueTypeId

public java.lang.Integer getIssueTypeId()

Get the IssueTypeId

Returns:

Integer

setIssueTypeId

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

Set the value of IssueTypeId

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

getDescription

public java.lang.String getDescription()

Get the Description

Returns:

String

setDescription

public void setDescription(java.lang.String v)

Set the value of Description

Parameters:

v - new value

getQueryString

public java.lang.String getQueryString()

Get the QueryString

Returns:

String

setQueryString

public void setQueryString(java.lang.String v)

Set the value of QueryString

Parameters:

v - new value

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

getDeleted

public boolean getDeleted()

Get the Deleted

Returns:

boolean

setDeleted

public void setDeleted(boolean v)

Set the value of Deleted

Parameters:

v - new value

getCreatedDate

public java.util.Date getCreatedDate()

Get the CreatedDate

Returns:

Date

setCreatedDate

public void setCreatedDate(java.util.Date v)

Set the value of CreatedDate

Parameters:

v - new value

setIssueType

public void setIssueType(IssueType v)
                  throws org.apache.torque.TorqueException

Declares an association between this object and a IssueType object

Parameters:

v - IssueType

Throws:

org.apache.torque.TorqueException

getIssueType

public IssueType getIssueType()
                       throws org.apache.torque.TorqueException

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

Returns:

the associated IssueType object

Throws:

org.apache.torque.TorqueException

getIssueType

public IssueType getIssueType(java.sql.Connection connection)
                       throws org.apache.torque.TorqueException

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

Throws:

org.apache.torque.TorqueException

setIssueTypeKey

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

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

setScope

public void setScope(Scope v)
              throws org.apache.torque.TorqueException

Declares an association between this object and a Scope object

Parameters:

v - Scope

Throws:

org.apache.torque.TorqueException

getScope

public Scope getScope()
               throws org.apache.torque.TorqueException

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

Returns:

the associated Scope object

Throws:

org.apache.torque.TorqueException

getScope

public Scope getScope(java.sql.Connection connection)
               throws org.apache.torque.TorqueException

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

Throws:

org.apache.torque.TorqueException

setScopeKey

public void setScopeKey(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)

Set the PrimaryKey using ObjectKey.

Specified by:

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

Parameters:

key - reportId ObjectKey

setPrimaryKey

public void setPrimaryKey(java.lang.String key)

Set the PrimaryKey using a String.

Specified by:

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

Parameters:

key -

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

Throws:

org.apache.torque.TorqueException

getPeer

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