Package com.evolveum.midpoint.report.api

Interface ReportManager

public interface ReportManager

Author:

lazyman, katkav

Method Summary

Modifier and Type	Method	Description
void	cleanupReports(CleanupPolicyType cleanupPolicy, RunningTask task, OperationResult parentResult)	todo comments [lazyman] todo how to return progress
CompiledObjectCollectionView	createCompiledView(ObjectCollectionReportEngineConfigurationType collectionConfig, boolean useDefaultView, Task task, OperationResult result)
void	deleteReportData(ReportDataType reportData, Task task, OperationResult parentResult)
Object	evaluateScript(PrismObject<ReportType> report, ExpressionType expression, VariablesMap variables, String shortDesc, Task task, OperationResult result)
VariablesMap	evaluateSubreportParameters(PrismObject<ReportType> report, VariablesMap variables, Task task, OperationResult result)
InputStream	getReportDataStream(String reportDataOid, OperationResult parentResult)	todo comments [lazyman]
void	importReport(PrismObject<ReportType> report, PrismObject<ReportDataType> reportData, Task task, OperationResult result)	Creates and submits a task that will execute the "import" report.
void	runReport(PrismObject<ReportType> report, PrismContainer<ReportParameterType> params, Task task, OperationResult result)	Creates and submits a simple (classic export) task that will execute the "export" report.

Method Details

runReport

void runReport(PrismObject<ReportType> report,
 PrismContainer<ReportParameterType> params,
 Task task,
 OperationResult result)
        throws CommonException

Creates and submits a simple (classic export) task that will execute the "export" report. Requires ModelAuthorizationAction.RUN_REPORT authorization related to given report.

Parameters:

report - The report object; it must reside in repository. Actually, only its OID is used from the parameter.

Throws:

CommonException

importReport

void importReport(PrismObject<ReportType> report,
 PrismObject<ReportDataType> reportData,
 Task task,
 OperationResult result)
           throws CommonException

Creates and submits a task that will execute the "import" report. Requires ModelAuthorizationAction.IMPORT_REPORT authorization related to given report.

Parameters:

report - The report object; it must reside in repository. Actually, only its OID is used from the parameter.

reportData - Data to be imported. It must reside in repository. Actually, only its OID is used from the parameter.

Throws:

CommonException

cleanupReports

void cleanupReports(CleanupPolicyType cleanupPolicy,
 RunningTask task,
 OperationResult parentResult)

todo comments [lazyman] todo how to return progress

getReportDataStream

InputStream getReportDataStream(String reportDataOid,
 OperationResult parentResult)
                         throws ObjectNotFoundException,
SchemaException,
SecurityViolationException,
CommunicationException,
ConfigurationException,
ExpressionEvaluationException,
IOException,
CommonException

todo comments [lazyman]

Parameters:

reportDataOid -

parentResult -

Returns:

Throws:

ObjectNotFoundException

SchemaException

SecurityViolationException

CommunicationException

ConfigurationException

ExpressionEvaluationException

IOException

CommonException

deleteReportData

void deleteReportData(ReportDataType reportData,
 Task task,
 OperationResult parentResult)
               throws Exception

Throws:

Exception

createCompiledView

CompiledObjectCollectionView createCompiledView(ObjectCollectionReportEngineConfigurationType collectionConfig,
 boolean useDefaultView,
 Task task,
 OperationResult result)
                                         throws CommunicationException,
ObjectNotFoundException,
SchemaException,
SecurityViolationException,
ConfigurationException,
ExpressionEvaluationException

Throws:

CommunicationException

ObjectNotFoundException

SchemaException

SecurityViolationException

ConfigurationException

ExpressionEvaluationException

evaluateScript

Object evaluateScript(PrismObject<ReportType> report,
 ExpressionType expression,
 VariablesMap variables,
 String shortDesc,
 Task task,
 OperationResult result)
               throws SchemaException,
ExpressionEvaluationException,
ObjectNotFoundException,
CommunicationException,
ConfigurationException,
SecurityViolationException

Throws:

SchemaException

ExpressionEvaluationException

ObjectNotFoundException

CommunicationException

ConfigurationException

SecurityViolationException

evaluateSubreportParameters

VariablesMap evaluateSubreportParameters(PrismObject<ReportType> report,
 VariablesMap variables,
 Task task,
 OperationResult result)