Package step.repository.alm.v16.otaclient

Interface IBusinessViewsExcelReportManager2

All Superinterfaces:

com4j.Com4jObject, IBusinessViewsExcelReportManager

public interface IBusinessViewsExcelReportManager2
extends IBusinessViewsExcelReportManager

For HP use. IBusinessViewsExcelReportManager2 Interface.

Method Summary

Modifier and Type	Method	Description
void	abortExcelReportGenerationTask(int taskID)	Aborts excel report generation task.
void	abortRemoteExcelReportGenerationTask(int taskID, java.lang.String projectId)	Aborts remote excel report generation task.
void	declineDownloadExcelReportResultFile(java.lang.String fileNameToDownload)	Decline excel report result file download.
void	declineDownloadRemoteExcelReportResultFile(java.lang.String fileNameToDownload, java.lang.String projectId)	Decline remote excel report result file download.
java.lang.String	downloadRemoteExcelReportResultFile(java.lang.String fileNameToDownload, java.lang.String projectId)	Downloads remote excel report result file.
java.lang.String	getConfigurationExecutionMetadata(java.lang.String configurationXML, java.lang.String worksheetID, java.lang.String projectId)	Extracts metadata of a Configuration to be executed.
java.lang.String	getDqlExecutionMetadata(java.lang.String dql, java.lang.String projectId)	Extracts metadata of a DQL to be executed.
java.lang.String	getExecutionTaskDetails(int taskID)	Returns excel report generation task detail.
java.lang.String	getRemoteExecutionTaskDetails(int taskID, java.lang.String projectId)	Returns remote excel report generation task details.

Methods inherited from interface com4j.Com4jObject

advise, dispose, equals, getComThread, getIUnknownPointer, getPointer, getPtr, hashCode, is, queryInterface, setName, toString

Methods inherited from interface step.repository.alm.v16.otaclient.IBusinessViewsExcelReportManager

autoPreviewMaxRows, downloadExcelReportResultFile, executeConfiguration, executeConfigurationOnRemoteProject, executeDql, executeDqlOnRemoteProject, startConfigurationExecution, startConfigurationExecutionOnRemoteProject, startDqlExecution, startDqlExecutionOnRemoteProject, translateConfigurationToDql, validateDql, validateDqlOnRemoteProject

Method Detail

downloadRemoteExcelReportResultFile

java.lang.String downloadRemoteExcelReportResultFile(java.lang.String fileNameToDownload,
                                                     java.lang.String projectId)

Downloads remote excel report result file.

Parameters:

fileNameToDownload - Mandatory java.lang.String parameter.

projectId - Mandatory java.lang.String parameter.

Returns:

Returns a value of type java.lang.String

abortRemoteExcelReportGenerationTask

void abortRemoteExcelReportGenerationTask(int taskID,
                                          java.lang.String projectId)

Aborts remote excel report generation task.

Parameters:

taskID - Mandatory int parameter.

projectId - Mandatory java.lang.String parameter.

abortExcelReportGenerationTask

void abortExcelReportGenerationTask(int taskID)

Aborts excel report generation task.

Parameters:

taskID - Mandatory int parameter.

getExecutionTaskDetails

java.lang.String getExecutionTaskDetails(int taskID)

Returns excel report generation task detail.

Parameters:

taskID - Mandatory int parameter.

Returns:

Returns a value of type java.lang.String

getRemoteExecutionTaskDetails

java.lang.String getRemoteExecutionTaskDetails(int taskID,
                                               java.lang.String projectId)

Returns remote excel report generation task details.

Parameters:

taskID - Mandatory int parameter.

projectId - Mandatory java.lang.String parameter.

Returns:

Returns a value of type java.lang.String

declineDownloadExcelReportResultFile

void declineDownloadExcelReportResultFile(java.lang.String fileNameToDownload)

Decline excel report result file download.

Parameters:

fileNameToDownload - Mandatory java.lang.String parameter.

declineDownloadRemoteExcelReportResultFile

void declineDownloadRemoteExcelReportResultFile(java.lang.String fileNameToDownload,
                                                java.lang.String projectId)

Decline remote excel report result file download.

Parameters:

fileNameToDownload - Mandatory java.lang.String parameter.

projectId - Mandatory java.lang.String parameter.

getDqlExecutionMetadata

java.lang.String getDqlExecutionMetadata(java.lang.String dql,
                                         java.lang.String projectId)

Extracts metadata of a DQL to be executed.

Parameters:

dql - Mandatory java.lang.String parameter.

projectId - Mandatory java.lang.String parameter.

Returns:

Returns a value of type java.lang.String

getConfigurationExecutionMetadata

java.lang.String getConfigurationExecutionMetadata(java.lang.String configurationXML,
                                                   java.lang.String worksheetID,
                                                   java.lang.String projectId)

Extracts metadata of a Configuration to be executed.

Parameters:

configurationXML - Mandatory java.lang.String parameter.

worksheetID - Mandatory java.lang.String parameter.

projectId - Mandatory java.lang.String parameter.

Returns:

Returns a value of type java.lang.String