oracle.epm.fm.domainobject.common

Class SystemReportsHelper

java.lang.Object

oracle.epm.fm.domainobject.common.SystemReportsHelper

public class SystemReportsHelper
extends Object

This class contains methods for report generation

Constructor Summary

Constructors

Constructor and Description
SystemReportsHelper()
SystemReportsHelper(SessionInfo sessionInfo)

Method Summary

Modifier and Type	Method and Description
int	generateReport(String sPath, String docName, REPORT_TYPES reportType, REPORT_FORMATS reportFormat, String appName, ReportOverrideOptions reportOverrideOptions) This method starts the reports generation process
void	generateReportSync(String sPath, String docName, String appName, ReportOverrideOptions reportOverrideOptions) This method starts the reports generation process
static REPORT_FORMATS	getBiFormatTagFromString(String type) This method returns the REPORT_FORMAT enum based on the report type string passed
static String	getContentType(String extn) This method returns the content type based on the extension
static String	getExtensionBasedOnReportFormat(REPORT_FORMATS reportFormat) This method returns the extension based on the report format
String	getReport(String sPath, String docName, REPORT_TYPES reportType, REPORT_FORMATS reportFormat, String appName, ReportOverrideOptions reportOverrideOptions) This method starts the reports generation process
List<String>	getTemplates(SessionInfo sessionInfo, REPORT_TYPES reportType, REPORT_FORMATS reportFormat) This method enumerates all the templates for a given report format.
int	launchSystemReport(String reportDef, REPORT_TYPES reportType, REPORT_FORMATS reportFormat, ReportOverrideOptions reportOverrideOptions, String appName, String httpProtocol, String httpHost) This method starts the reports generation process
int	startReport(SessionInfo sessionInfo, SystemReport report) This method starts the report generation process

Methods inherited from class java.lang.Object

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

Constructor Detail

SystemReportsHelper

public SystemReportsHelper()
                    throws HFMException

Throws:

HFMException

SystemReportsHelper

public SystemReportsHelper(SessionInfo sessionInfo)
                    throws HFMException

Throws:

HFMException

Method Detail

getTemplates

public List<String> getTemplates(SessionInfo sessionInfo,
                                 REPORT_TYPES reportType,
                                 REPORT_FORMATS reportFormat)
                          throws HFMException

This method enumerates all the templates for a given report format. HFM-Format does not use templates so will return an empty list.

Parameters:

sessionInfo - SessionInfo object

reportType - Type of system report. IC, Journals, EPU...

reportFormat - Report format

Returns:

The list of template names for the given format. HFM-Format does not use templates so will return an empty list.

Throws:

HFMException

getExtensionBasedOnReportFormat

public static String getExtensionBasedOnReportFormat(REPORT_FORMATS reportFormat)

This method returns the extension based on the report format

Parameters:

reportFormat - Report format

Returns:

Returns the extension

getBiFormatTagFromString

public static REPORT_FORMATS getBiFormatTagFromString(String type)

This method returns the REPORT_FORMAT enum based on the report type string passed

Parameters:

type - Report type string

Returns:

REPORT_FORMAT enum

getContentType

public static String getContentType(String extn)

This method returns the content type based on the extension

Parameters:

extn - Extension as a string

Returns:

Content type

startReport

public int startReport(SessionInfo sessionInfo,
                       SystemReport report)
                throws HFMException

This method starts the report generation process

Parameters:

sessionInfo - SessionInfo Object

report - Report object. Contains reportDefinition, reportTemplate, outputFormat, reportType

Returns:

Taskid of async task created for report generation

Throws:

HFMException

generateReport

public int generateReport(String sPath,
                          String docName,
                          REPORT_TYPES reportType,
                          REPORT_FORMATS reportFormat,
                          String appName,
                          ReportOverrideOptions reportOverrideOptions)
                   throws HFMException,
                          Exception

This method starts the reports generation process

Parameters:

sPath - Path of the document in document manager

docName - Name of the document

reportType - Report type

reportFormat - Report Format

appName - Application Name

reportOverrideOptions - Report Override Options Object

Returns:

Taskid of async task created for report generation

Throws:

HFMException

Exception

generateReportSync

public void generateReportSync(String sPath,
                               String docName,
                               String appName,
                               ReportOverrideOptions reportOverrideOptions)
                        throws HFMException,
                               Exception

This method starts the reports generation process

Parameters:

sPath - Path of the document in document manager

docName - Name of the document

appName - Application Name

reportOverrideOptions - Report Override Options Object

Throws:

HFMException

Exception

getReport

public String getReport(String sPath,
                        String docName,
                        REPORT_TYPES reportType,
                        REPORT_FORMATS reportFormat,
                        String appName,
                        ReportOverrideOptions reportOverrideOptions)
                 throws HFMException,
                        Exception

This method starts the reports generation process

Parameters:

sPath - Path of the document in document manager

docName - Name of the document

appName - Application Name

reportOverrideOptions - Report Override Options Object

Throws:

HFMException

Exception

launchSystemReport

public int launchSystemReport(String reportDef,
                              REPORT_TYPES reportType,
                              REPORT_FORMATS reportFormat,
                              ReportOverrideOptions reportOverrideOptions,
                              String appName,
                              String httpProtocol,
                              String httpHost)
                       throws HFMException

This method starts the reports generation process

Parameters:

reportDef - Report definition object

reportType - Report type enum

reportFormat - Report format enum

reportOverrideOptions - Report Override Options Object

appName - Application name

httpProtocol - HttpProtocol

httpHost - HttpHost

Throws:

HFMException