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 parentResult)	todo comments [lazyman]
void	runReport(PrismObject<ReportType> report, PrismContainer<ReportParameterType> params, Task task, OperationResult parentResult)	todo comments [lazyman]

Method Detail

runReport

void runReport(PrismObject<ReportType> report,
               PrismContainer<ReportParameterType> params,
               Task task,
               OperationResult parentResult)
        throws SchemaException,
               ObjectNotFoundException,
               ExpressionEvaluationException,
               CommunicationException,
               ConfigurationException,
               SecurityViolationException

todo comments [lazyman]

Parameters:

report -

parentResult - describes report which has to be created

Throws:

SchemaException

ObjectNotFoundException

ExpressionEvaluationException

CommunicationException

ConfigurationException

SecurityViolationException

importReport

void importReport(PrismObject<ReportType> report,
                  PrismObject<ReportDataType> reportData,
                  Task task,
                  OperationResult parentResult)
           throws SchemaException,
                  ObjectNotFoundException,
                  ExpressionEvaluationException,
                  CommunicationException,
                  ConfigurationException,
                  SecurityViolationException

todo comments [lazyman]

Parameters:

report -

parentResult - describes report which has to be created

Throws:

SchemaException

ObjectNotFoundException

ExpressionEvaluationException

CommunicationException

ConfigurationException

SecurityViolationException

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)