org.tigris.scarab.reports
Class ReportBridge

java.lang.Object
  org.tigris.scarab.reports.ReportBridge

All Implemented Interfaces:

org.apache.fulcrum.intake.Retrievable, java.io.Serializable

public class ReportBridge

extends java.lang.Object

implements java.io.Serializable, org.apache.fulcrum.intake.Retrievable

This class is a bridge between the xml related classes for defining a report and the business objects that are used within the screens to configure the report.

See Also:

Serialized Form

Constructor Summary

ReportBridge()

ReportBridge(Report report)

Method Summary

java.util.Date	getDefaultDate() Date used for a single date report.
boolean	getDeleted()
java.lang.String	getDescription()
java.lang.String	getFormat()
ScarabUser	getGeneratedBy() Get the value of generatedBy.
java.util.Date	getGeneratedDate() This is the date that was used in the queries for reports on a single date.
MITList	getMITList()
ReportTableModel	getModel(ScarabUser searcher)
Module	getModule() Get the value of module.
java.lang.String	getName()
ReportHeading	getNewHeading()
java.lang.String	getQueryKey()
(package private) java.lang.String	getQueryString()
ReportDefinition	getReportDefinition()
java.lang.Integer	getReportId()
Scope	getScope()
java.lang.Integer	getScopeId()
java.lang.Integer	getUserId()
boolean	isDeletable(ScarabUser user)
boolean	isEditable(ScarabUser user)
boolean	isNew() State of persistence of the report.
boolean	isReadyForCalculation()
boolean	isSavable(ScarabUser user)
void	populate(java.lang.String v)
void	populateSearch(IssueSearch search, ReportHeading heading)
boolean	removeStaleDefinitions()
void	save()
void	setDefaultDate(java.util.Date date) Date used for a single date report.
void	setDeleted(boolean b)
void	setDescription(java.lang.String name)
void	setFormat(java.lang.String format)
void	setGeneratedBy(ScarabUser v) Set the value of generatedBy.
void	setIssueType(IssueType v) Set the value of module.
void	setMITList(MITList mitList)
void	setModule(Module v) Set the value of module.
void	setName(java.lang.String name)
void	setQueryKey(java.lang.String key)
void	setReportId(java.lang.Integer id)
void	setScopeId(java.lang.Integer id)
void	setUserId(java.lang.Integer id)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReportBridge

public ReportBridge()

ReportBridge

public ReportBridge(Report report)
             throws java.lang.Exception

Method Detail

getReportDefinition

public ReportDefinition getReportDefinition()

getNewHeading

public ReportHeading getNewHeading()

getQueryKey

public java.lang.String getQueryKey()

Specified by:

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

setQueryKey

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

Specified by:

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

Throws:

org.apache.torque.TorqueException

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String name)

getFormat

public java.lang.String getFormat()

setFormat

public void setFormat(java.lang.String format)

getDeleted

public boolean getDeleted()

setDeleted

public void setDeleted(boolean b)

getScopeId

public java.lang.Integer getScopeId()

setScopeId

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

Throws:

org.apache.torque.TorqueException

getUserId

public java.lang.Integer getUserId()

setUserId

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

Throws:

org.apache.torque.TorqueException

getReportId

public java.lang.Integer getReportId()

setReportId

public void setReportId(java.lang.Integer id)

getScope

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

Throws:

org.apache.torque.TorqueException

getModule

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

Get the value of module.

Returns:

value of module.

Throws:

org.apache.torque.TorqueException

setModule

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

Set the value of module.

Parameters:

v - Value to assign to module.

Throws:

org.apache.torque.TorqueException

setIssueType

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

Set the value of module.

Parameters:

v - Value to assign to module.

Throws:

org.apache.torque.TorqueException

isEditable

public boolean isEditable(ScarabUser user)

isDeletable

public boolean isDeletable(ScarabUser user)

isSavable

public boolean isSavable(ScarabUser user)

getGeneratedBy

public ScarabUser getGeneratedBy()
                          throws java.lang.Exception

Get the value of generatedBy.

Returns:

value of generatedBy.

Throws:

java.lang.Exception

setGeneratedBy

public void setGeneratedBy(ScarabUser v)
                    throws java.lang.Exception

Set the value of generatedBy.

Parameters:

v - Value to assign to generatedBy.

Throws:

java.lang.Exception

getGeneratedDate

public java.util.Date getGeneratedDate()

This is the date that was used in the queries for reports on a single date. It is not necessarily the same as the date on which the queries were run.

Returns:

value of generatedDate.

getDefaultDate

public java.util.Date getDefaultDate()

Date used for a single date report.

setDefaultDate

public void setDefaultDate(java.util.Date date)

Date used for a single date report.

getMITList

public MITList getMITList()
                   throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

setMITList

public void setMITList(MITList mitList)
                throws java.lang.Exception

Throws:

java.lang.Exception

isReadyForCalculation

public boolean isReadyForCalculation()

removeStaleDefinitions

public boolean removeStaleDefinitions()
                               throws java.lang.Exception

Throws:

java.lang.Exception

getModel

public ReportTableModel getModel(ScarabUser searcher)
                          throws java.lang.Exception

Throws:

java.lang.Exception

save

public void save()
          throws java.lang.Exception

Throws:

java.lang.Exception

isNew

public boolean isNew()

State of persistence of the report.

Returns:

true if the report has NOT been saved.

populate

public void populate(java.lang.String v)
              throws java.lang.Exception

Throws:

java.lang.Exception

getQueryString

java.lang.String getQueryString()
                          throws java.lang.Exception

Throws:

java.lang.Exception

populateSearch

public void populateSearch(IssueSearch search,
                           ReportHeading heading)
                    throws java.lang.Exception

Throws:

java.lang.Exception