com.ibm.itim.adhocreport
Class AdhocReportTemplate

java.lang.Object
  |
  +--com.ibm.itim.adhocreport.AdhocReportTemplate
All Implemented Interfaces:
java.io.Serializable

public class AdhocReportTemplate
extends java.lang.Object
implements java.io.Serializable

This is a wrapper class for the ad-hoc report templates. This includes metadata information of the report, and the repor titself, which is an ReportXML object. 8

See Also:
ReportXML, Serialized Form

Field Summary
static java.lang.String DEFAULT_PARSER_NAME
           
 
Constructor Summary
AdhocReportTemplate()
          This is a constructor method.
AdhocReportTemplate(int id, java.lang.String title, java.lang.String type, java.lang.String xml, java.lang.String author, java.lang.String stylesheetName)
           
 
Method Summary
 java.lang.String getAuthor()
          This method returns the report template author.
 int getId()
          This method returns the report ID.
 ReportColumn getReportColumnObject(int selectedField)
          Returns the report column object from the Report XML
 ReportXML getReportXML()
          This method returns the ReportXML object.
 java.lang.String getStylesheetName()
          This method returns the location of the style sheet associated with this report template.
 java.lang.String getTitle()
          This method returns the report title.
 java.lang.String getType()
          This method returns the type of report (RI/Crystal/Actuate).
 java.lang.String getXML()
          Returns the XML representation of this report template.
 boolean removeReportColumnObject(int selectedField)
          Removes the report column object from the Report XML
 void setAuthor(java.lang.String author)
          This method sets the report template author.
 void setId(int id)
          This method sets the report ID.
 void setReportXML(ReportXML reportXML)
          Set the ReportXML object.
 void setStylesheetName(java.lang.String stylesheetName)
          This method sets the location of the style sheet associated with the report template.
 void setTitle(java.lang.String title)
          This method sets the report title.
 void setType(java.lang.String type)
          This method sets the report type (RI/Actuate/Crystal).
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_PARSER_NAME

public static final java.lang.String DEFAULT_PARSER_NAME
Constructor Detail

AdhocReportTemplate

public AdhocReportTemplate(int id,
                           java.lang.String title,
                           java.lang.String type,
                           java.lang.String xml,
                           java.lang.String author,
                           java.lang.String stylesheetName)
                    throws InvalidReportColumnException,
                           java.io.IOException,
                           java.lang.Exception

AdhocReportTemplate

public AdhocReportTemplate()
This is a constructor method.
Method Detail

getId

public int getId()
This method returns the report ID.
Returns:
java.lang.String

setId

public void setId(int id)
This method sets the report ID.
Parameters:
id - - This is the report ID to ba set.

getTitle

public java.lang.String getTitle()
This method returns the report title.
Returns:
java.lang.String

setTitle

public void setTitle(java.lang.String title)
This method sets the report title.
Parameters:
title - - This is the report title.

getType

public java.lang.String getType()
This method returns the type of report (RI/Crystal/Actuate).
Returns:
java.lang.String

setType

public void setType(java.lang.String type)
This method sets the report type (RI/Actuate/Crystal).
Parameters:
type - - This indicates the type of report.

getAuthor

public java.lang.String getAuthor()
This method returns the report template author.
Returns:
java.lang.String

setAuthor

public void setAuthor(java.lang.String author)
This method sets the report template author.
Parameters:
author - - This is the report template author.

getStylesheetName

public java.lang.String getStylesheetName()
This method returns the location of the style sheet associated with this report template.
Returns:
java.lang.String

setStylesheetName

public void setStylesheetName(java.lang.String stylesheetName)
This method sets the location of the style sheet associated with the report template.
Parameters:
location - This is the location of the style sheet associated with the report template.

getReportXML

public ReportXML getReportXML()
This method returns the ReportXML object.
Returns:
com.ibm.itim.adhocreport.ReportXML

setReportXML

public void setReportXML(ReportXML reportXML)
Set the ReportXML object.
Parameters:
reportXML - Set the report XML object.

getXML

public java.lang.String getXML()
                        throws javax.xml.parsers.ParserConfigurationException
Returns the XML representation of this report template.
Returns:
String Returns the report temaplte in XML format.

getReportColumnObject

public ReportColumn getReportColumnObject(int selectedField)
Returns the report column object from the Report XML
Parameters:
selectedField -  
Returns:
Report column object specified by the selectedField parameter

removeReportColumnObject

public boolean removeReportColumnObject(int selectedField)
                                 throws InvalidQueryException
Removes the report column object from the Report XML
Parameters:
selectedField -  
Returns:
Removes the report column object specified by the selectedField parameter