com.bmc.arsys.arreporting

Class ReportDelegator

java.lang.Object

com.bmc.arsys.arreporting.ReportDelegator

public class ReportDelegator
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENV_BIRT_TEMP

Constructor Summary

Constructors

Constructor and Description
ReportDelegator(Properties properties, ILogListener logListener)

Method Summary

Methods

Modifier and Type	Method and Description
String	createReport(com.bmc.arsys.api.ARServerUser context, ReportType type, ReportParameters parameters, String fileName, boolean persist)
void	deleteReport(com.bmc.arsys.api.ARServerUser context, String reportName) Deletes a report from the server based on a report form name
BIRTReportEngine	getBirtEngine()
Properties	getEngineProperties(ReportType type)
ReportParameters	getParameters(com.bmc.arsys.api.ARServerUser context, String reportName)
ReportParameters	getParameters(String fileName)
ReportParameters	getParametersByEntryID(com.bmc.arsys.api.ARServerUser context, String entryID)
Properties	getProperties()
byte[]	getReport(com.bmc.arsys.api.ARServerUser context, String reportName)
byte[]	getReportByEntryID(com.bmc.arsys.api.ARServerUser context, String entryID)
byte[]	getReportData(com.bmc.arsys.api.ARServerUser context, com.bmc.arsys.api.Entry entry)
com.bmc.arsys.api.Entry	getReportEntry(com.bmc.arsys.api.ARServerUser context, String reportName) Retrieves the entry for a named report
com.bmc.arsys.api.Entry	getReportEntryByEntryID(com.bmc.arsys.api.ARServerUser context, String entryID)
com.bmc.arsys.api.Entry	getReportEntryByGUID(com.bmc.arsys.api.ARServerUser context, String GUID)
String	getReportName(com.bmc.arsys.api.Entry entry)
String	getReportType(com.bmc.arsys.api.Entry entry)
String	getSubmitter(com.bmc.arsys.api.Entry entry)
void	initializeEngines()
boolean	isWebReport(com.bmc.arsys.api.Entry entry)
String	makeValidFileName(String fileName)
ByteArrayOutputStream	runEntryReport(com.bmc.arsys.api.ARServerUser context, ReportParameters parameters) Runs an existing report file from an AR System report entry.
ByteArrayOutputStream	runFileReport(com.bmc.arsys.api.ARServerUser context, ReportParameters parameters) Runs an existing report file on disk
ByteArrayOutputStream	runNewReport(com.bmc.arsys.api.ARServerUser context, ReportParameters parameters) Runs an existing report file on disk
void	setBirtEngine(BIRTReportEngine birtEngine)
void	setProperties(Properties properties)
void	shutDown()
void	updateReport(com.bmc.arsys.api.ARServerUser context, String reportName, ReportParameters parameters)

Methods inherited from class java.lang.Object

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

Field Detail

ENV_BIRT_TEMP

public static final String ENV_BIRT_TEMP

See Also:

Constant Field Values

Constructor Detail

ReportDelegator

public ReportDelegator(Properties properties,
               ILogListener logListener)

Method Detail

initializeEngines

public void initializeEngines()
                       throws com.bmc.arsys.api.ARException

Throws:

com.bmc.arsys.api.ARException

shutDown

public void shutDown()

getEngineProperties

public Properties getEngineProperties(ReportType type)

createReport

public String createReport(com.bmc.arsys.api.ARServerUser context,
                  ReportType type,
                  ReportParameters parameters,
                  String fileName,
                  boolean persist)
                    throws com.bmc.arsys.api.ARException

Throws:

com.bmc.arsys.api.ARException

deleteReport

public void deleteReport(com.bmc.arsys.api.ARServerUser context,
                String reportName)
                  throws com.bmc.arsys.api.ARException

Deletes a report from the server based on a report form name

Throws:

com.bmc.arsys.api.ARException

getReportEntry

public com.bmc.arsys.api.Entry getReportEntry(com.bmc.arsys.api.ARServerUser context,
                                     String reportName)
                                       throws com.bmc.arsys.api.ARException

Retrieves the entry for a named report

Parameters:

reportName -

Returns:

Throws:

com.bmc.arsys.api.ARException

getReportEntryByEntryID

public com.bmc.arsys.api.Entry getReportEntryByEntryID(com.bmc.arsys.api.ARServerUser context,
                                              String entryID)
                                                throws com.bmc.arsys.api.ARException

Throws:

com.bmc.arsys.api.ARException

getReportEntryByGUID

public com.bmc.arsys.api.Entry getReportEntryByGUID(com.bmc.arsys.api.ARServerUser context,
                                           String GUID)
                                             throws com.bmc.arsys.api.ARException

Throws:

com.bmc.arsys.api.ARException

getReportType

public String getReportType(com.bmc.arsys.api.Entry entry)

getReportName

public String getReportName(com.bmc.arsys.api.Entry entry)

getSubmitter

public String getSubmitter(com.bmc.arsys.api.Entry entry)

isWebReport

public boolean isWebReport(com.bmc.arsys.api.Entry entry)

getReportData

public byte[] getReportData(com.bmc.arsys.api.ARServerUser context,
                   com.bmc.arsys.api.Entry entry)
                     throws com.bmc.arsys.api.ARException

Throws:

com.bmc.arsys.api.ARException

getParametersByEntryID

public ReportParameters getParametersByEntryID(com.bmc.arsys.api.ARServerUser context,
                                      String entryID)
                                        throws com.bmc.arsys.api.ARException

Throws:

com.bmc.arsys.api.ARException

getParameters

public ReportParameters getParameters(String fileName)
                               throws com.bmc.arsys.api.ARException

Throws:

com.bmc.arsys.api.ARException

getParameters

public ReportParameters getParameters(com.bmc.arsys.api.ARServerUser context,
                             String reportName)
                               throws com.bmc.arsys.api.ARException

Throws:

com.bmc.arsys.api.ARException

getReport

public byte[] getReport(com.bmc.arsys.api.ARServerUser context,
               String reportName)
                 throws com.bmc.arsys.api.ARException

Throws:

com.bmc.arsys.api.ARException

getReportByEntryID

public byte[] getReportByEntryID(com.bmc.arsys.api.ARServerUser context,
                        String entryID)
                          throws com.bmc.arsys.api.ARException

Throws:

com.bmc.arsys.api.ARException

runFileReport

public ByteArrayOutputStream runFileReport(com.bmc.arsys.api.ARServerUser context,
                                  ReportParameters parameters)
                                    throws com.bmc.arsys.api.ARException

Runs an existing report file on disk

Parameters:

context - AR System server user context

parameters - Report parameters to use. The report file name must be provided

Returns:

Content of the report based on the parameters supplied

Throws:

com.bmc.arsys.api.ARException

runEntryReport

public ByteArrayOutputStream runEntryReport(com.bmc.arsys.api.ARServerUser context,
                                   ReportParameters parameters)
                                     throws com.bmc.arsys.api.ARException

Runs an existing report file from an AR System report entry. This method will retrieve the report definition from the report form using the entry id if provided, or will search for the entry using the report name if no entry id was provided

Parameters:

context - AR System server user context

parameters - Report parameters to use. The report entryid or report name must be provided

Returns:

Content of the report based on the parameters supplied

Throws:

com.bmc.arsys.api.ARException

runNewReport

public ByteArrayOutputStream runNewReport(com.bmc.arsys.api.ARServerUser context,
                                 ReportParameters parameters)
                                   throws com.bmc.arsys.api.ARException

Runs an existing report file on disk

Parameters:

context - AR System server user context

parameters - Report parameters to use. The report entryid or report name must be provided

Returns:

Content of the report based on the parameters supplied

Throws:

com.bmc.arsys.api.ARException

updateReport

public void updateReport(com.bmc.arsys.api.ARServerUser context,
                String reportName,
                ReportParameters parameters)
                  throws com.bmc.arsys.api.ARException

Throws:

com.bmc.arsys.api.ARException

setProperties

public void setProperties(Properties properties)

getProperties

public Properties getProperties()

makeValidFileName

public String makeValidFileName(String fileName)

getBirtEngine

public BIRTReportEngine getBirtEngine()

setBirtEngine

public void setBirtEngine(BIRTReportEngine birtEngine)