Package org.openiam.srvc.report

Class ReportWebServiceImpl

java.lang.Object

org.openiam.srvc.AbstractApiService

org.openiam.srvc.report.ReportWebServiceImpl

All Implemented Interfaces:

ReportWebService

@Service("reportWS")
public class ReportWebServiceImpl
extends AbstractApiService
implements ReportWebService

WS for report system

Author:

vitaly.yakunin

Field Summary

Fields inherited from class org.openiam.srvc.AbstractApiService

applicationContext, log, rabbitMQSender

Constructor Summary

Constructors

Constructor	Description
ReportWebServiceImpl(ReportQueue queue)

Method Summary

Modifier and Type	Method	Description
Response	createOrUpdateReportInfo(ReportInfoDto report)	Creates or updates report info.
Response	createOrUpdateReportInfoParam(ReportCriteriaParamDto reportParam)	Creates or updates report info. parameter.
Response	createOrUpdateSubCriteriaParam(ReportSubCriteriaParamDto subCriteriaParamReport)	Creates or updates sub criteria report param.
Response	deleteReport(String reportId)	Deletes report with given report Id.
Response	deleteReportParam(String reportParamId)	Deletes report parameter.
Response	deleteSubCriteriaParamReport(String reportId)	Deletes sub criteria report.
GetReportDataResponse	executeQuery(ReportQueryDto reportQuery)	Executes query and returns data.
List<ReportCriteriaParamDto>	getAllReportCriteriaParam()	Retrieves all report criteria params list.
GetAllSubCriteriaParamReportsResponse	getAllSubCriteriaParamReport(String reportId)	Retrieves all parameters that are sub criteria reports for given report Id.
GetReportInfoResponse	getReport(String reportId)	Retrieves report info for given report Id.
GetReportInfoResponse	getReportByName(String reportName)	Retrieve report info.
Integer	getReportCount()	Counts number of reports.
GetReportParameterMetaTypesResponse	getReportParameterMetaTypes()	Retrieves report parameter meta types.
GetReportParametersResponse	getReportParametersByReportId(String reportId)	Retrieves report parameter for given report Id.
GetReportParametersResponse	getReportParametersByReportName(String reportName)	Retrieves report parameters for given report name.
GetReportParameterTypesResponse	getReportParameterTypes()	Retrieves report parameter types.
GetAllReportsResponse	getReports(int from, int size)	Retrieves all reports in given range.
GetAllReportsResponse	getReportsByUserId(String requestorId)	Retrieves all reports for given user ID.
String	getReportUrl(ReportQueryDto reportQuery, String taskName, String reportBaseUrl, String locale)	Retrieves report URL.
Integer	getSubCriteriaParamReportCount()	Retrieves number of sub criteria report parameters.
GetAllSubCriteriaParamReportsResponse	getSubCriteriaParamReports()	Retrieves all sub criteria parameter reports.
Response	validateUpdateReportInfo(ReportInfoDto report)	Validates update report info.

Methods inherited from class org.openiam.srvc.AbstractApiService

broadcast, crudRequest, getBooleanValue, getIntValue, getIntValue, getRabbitMqQueue, getResponse, getResponse, getValue, getValue, getValueList, getValueList, idRequest, manageApiRequest, manageApiRequest, manageCrudApiRequest, manageCrudApiRequest, manageCrudApiRequest, manageCrudApiRequest, membershipRequestProcessing, membershipRequestProcessing, publish, publish, sendAsync, sendAsync

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportWebServiceImpl

@Autowired
public ReportWebServiceImpl(ReportQueue queue)

Method Detail

executeQuery

public GetReportDataResponse executeQuery(ReportQueryDto reportQuery)

Description copied from interface: ReportWebService

Executes query and returns data.

Specified by:

executeQuery in interface ReportWebService

Parameters:

reportQuery - Query to use for data retrieval.

Returns:

Returns data for report.

getReportUrl

public String getReportUrl(ReportQueryDto reportQuery,
                           String taskName,
                           String reportBaseUrl,
                           String locale)

Description copied from interface: ReportWebService

Retrieves report URL.

Specified by:

getReportUrl in interface ReportWebService

Parameters:

reportQuery - Query to use for report URL retrieval.

taskName - Task name.

reportBaseUrl - Report base URL.

locale - - Locale.

Returns:

Report URL.

getReports

public GetAllReportsResponse getReports(int from,
                                        int size)

Description copied from interface: ReportWebService

Retrieves all reports in given range.

Specified by:

getReports in interface ReportWebService

Parameters:

from - From range option.

size - Size range option.

Returns:

Reports for given range.

getReportCount

public Integer getReportCount()

Description copied from interface: ReportWebService

Counts number of reports.

Specified by:

getReportCount in interface ReportWebService

Returns:

Number of reports.

getReportsByUserId

public GetAllReportsResponse getReportsByUserId(String requestorId)

Description copied from interface: ReportWebService

Retrieves all reports for given user ID.

Specified by:

getReportsByUserId in interface ReportWebService

Parameters:

requestorId - User ID.

Returns:

All reports for given requestorId (User ID).

createOrUpdateReportInfo

public Response createOrUpdateReportInfo(ReportInfoDto report)

Description copied from interface: ReportWebService

Creates or updates report info.

Specified by:

createOrUpdateReportInfo in interface ReportWebService

Parameters:

report - Report info to create or update.

Returns:

Response.

validateUpdateReportInfo

public Response validateUpdateReportInfo(ReportInfoDto report)

Description copied from interface: ReportWebService

Validates update report info.

Specified by:

validateUpdateReportInfo in interface ReportWebService

Parameters:

report - Report info that will be validated.

Returns:

Response.

createOrUpdateReportInfoParam

public Response createOrUpdateReportInfoParam(ReportCriteriaParamDto reportParam)

Description copied from interface: ReportWebService

Creates or updates report info. parameter.

Specified by:

createOrUpdateReportInfoParam in interface ReportWebService

Parameters:

reportParam - Report info. parameter that will be created or updated.

Returns:

Response.

getReportParametersByReportId

public GetReportParametersResponse getReportParametersByReportId(String reportId)

Description copied from interface: ReportWebService

Retrieves report parameter for given report Id.

Specified by:

getReportParametersByReportId in interface ReportWebService

Parameters:

reportId - Report Id.

Returns:

Report parameters.

getReportParametersByReportName

public GetReportParametersResponse getReportParametersByReportName(String reportName)

Description copied from interface: ReportWebService

Retrieves report parameters for given report name.

Specified by:

getReportParametersByReportName in interface ReportWebService

Parameters:

reportName - Report name.

Returns:

Report parameters.

getReportByName

public GetReportInfoResponse getReportByName(String reportName)

Description copied from interface: ReportWebService

Retrieve report info.

Specified by:

getReportByName in interface ReportWebService

Parameters:

reportName - Report name.

Returns:

Report info.

getReport

public GetReportInfoResponse getReport(String reportId)

Description copied from interface: ReportWebService

Retrieves report info for given report Id.

Specified by:

getReport in interface ReportWebService

Parameters:

reportId - Report Id.

Returns:

Report info.

deleteReportParam

public Response deleteReportParam(String reportParamId)

Description copied from interface: ReportWebService

Deletes report parameter.

Specified by:

deleteReportParam in interface ReportWebService

Parameters:

reportParamId - Report parameter Id.

Returns:

Response.

deleteReport

public Response deleteReport(String reportId)

Description copied from interface: ReportWebService

Deletes report with given report Id.

Specified by:

deleteReport in interface ReportWebService

Parameters:

reportId - Report Id.

Returns:

Response.

getReportParameterTypes

public GetReportParameterTypesResponse getReportParameterTypes()

Description copied from interface: ReportWebService

Retrieves report parameter types.

Specified by:

getReportParameterTypes in interface ReportWebService

Returns:

Report parameter types.

getReportParameterMetaTypes

public GetReportParameterMetaTypesResponse getReportParameterMetaTypes()

Description copied from interface: ReportWebService

Retrieves report parameter meta types.

Specified by:

getReportParameterMetaTypes in interface ReportWebService

Returns:

Report parameter meta types.

getAllReportCriteriaParam

public List<ReportCriteriaParamDto> getAllReportCriteriaParam()

Description copied from interface: ReportWebService

Retrieves all report criteria params list.

Specified by:

getAllReportCriteriaParam in interface ReportWebService

Returns:

List of report criteria params.

getSubCriteriaParamReports

public GetAllSubCriteriaParamReportsResponse getSubCriteriaParamReports()

Description copied from interface: ReportWebService

Retrieves all sub criteria parameter reports.

Specified by:

getSubCriteriaParamReports in interface ReportWebService

Returns:

All reports sub criteria params.

getAllSubCriteriaParamReport

public GetAllSubCriteriaParamReportsResponse getAllSubCriteriaParamReport(String reportId)

Description copied from interface: ReportWebService

Retrieves all parameters that are sub criteria reports for given report Id.

Specified by:

getAllSubCriteriaParamReport in interface ReportWebService

Parameters:

reportId - Report Id.

Returns:

Parameters that are sub criteria reports for given report Id

getSubCriteriaParamReportCount

public Integer getSubCriteriaParamReportCount()

Description copied from interface: ReportWebService

Retrieves number of sub criteria report parameters.

Specified by:

getSubCriteriaParamReportCount in interface ReportWebService

Returns:

Number of parameters.

deleteSubCriteriaParamReport

public Response deleteSubCriteriaParamReport(String reportId)

Description copied from interface: ReportWebService

Deletes sub criteria report.

Specified by:

deleteSubCriteriaParamReport in interface ReportWebService

Parameters:

reportId - sub criteria report id.

Returns:

Response.

createOrUpdateSubCriteriaParam

public Response createOrUpdateSubCriteriaParam(ReportSubCriteriaParamDto subCriteriaParamReport)

Description copied from interface: ReportWebService

Creates or updates sub criteria report param.

Specified by:

createOrUpdateSubCriteriaParam in interface ReportWebService

Parameters:

subCriteriaParamReport - Report sub criteria param that will be created or updated.

Returns:

Response.