fr.gouv.vitam.batch.report.client

Interface BatchReportClient

All Superinterfaces:

AutoCloseable, BasicClient, MockOrRestClient, VitamAutoCloseable

All Known Implementing Classes:

BatchReportClientRest

public interface BatchReportClient
extends BasicClient

BatchReportClient

Field Summary

Fields inherited from interface fr.gouv.vitam.common.external.client.BasicClient

STATUS_URL

Method Summary

Modifier and Type	Method and Description
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	appendReportEntries(ReportBody reportBody) Append report entries
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	cleanupReport(String processId, ReportType reportType) Clean all entries with the given process Id tenant and reportType
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	generateEliminationActionAccessionRegisterReport(String processId, ReportExportRequest reportExportRequest) Generate elimination action accession register for deleted units by status and process Id.
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	generateEliminationActionDistinctObjectGroupInUnitReport(String processId, ReportExportRequest reportExportRequest) Generate elimination action district object groups for units by status and process Id.
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	generateEliminationActionObjectGroupReport(String processId, ReportExportRequest reportExportRequest) Generate elimination action object group report for the specified process Id Report is stored in JSONL format in workspace.
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	generateEliminationActionUnitReport(String processId, ReportExportRequest reportExportRequest) Generate elimination action unit report for the specified process Id Report is stored in JSONL format in workspace.

Methods inherited from interface fr.gouv.vitam.common.client.MockOrRestClient

checkStatus, checkStatus, close, consumeAnyEntityAndClose, getResourcePath, getServiceUrl

Method Detail

generateEliminationActionUnitReport

RequestResponse<com.fasterxml.jackson.databind.JsonNode> generateEliminationActionUnitReport(String processId,
                                                                                             ReportExportRequest reportExportRequest)
                                                                                      throws VitamClientInternalException

Generate elimination action unit report for the specified process Id Report is stored in JSONL format in workspace.

Parameters:

processId - the given process Id to aggregate

reportExportRequest - report export request

Returns:

RequestResponse

Throws:

VitamClientInternalException - VitamClientInternalException

generateEliminationActionObjectGroupReport

RequestResponse<com.fasterxml.jackson.databind.JsonNode> generateEliminationActionObjectGroupReport(String processId,
                                                                                                    ReportExportRequest reportExportRequest)
                                                                                             throws VitamClientInternalException

Generate elimination action object group report for the specified process Id Report is stored in JSONL format in workspace.

Parameters:

processId - processId

reportExportRequest - report export request

Returns:

RequestResponse

Throws:

VitamClientInternalException - VitamClientInternalException

generateEliminationActionDistinctObjectGroupInUnitReport

RequestResponse<com.fasterxml.jackson.databind.JsonNode> generateEliminationActionDistinctObjectGroupInUnitReport(String processId,
                                                                                                                  ReportExportRequest reportExportRequest)
                                                                                                           throws VitamClientInternalException

Generate elimination action district object groups for units by status and process Id. Report is stored in JSONL format in workspace.

Parameters:

processId -

reportExportRequest - report export request

Returns:

Throws:

VitamClientInternalException

appendReportEntries

RequestResponse<com.fasterxml.jackson.databind.JsonNode> appendReportEntries(ReportBody reportBody)
                                                                      throws VitamClientInternalException

Append report entries

Parameters:

reportBody - the given entry document.

Returns:

RequestResponse

Throws:

VitamClientInternalException

generateEliminationActionAccessionRegisterReport

RequestResponse<com.fasterxml.jackson.databind.JsonNode> generateEliminationActionAccessionRegisterReport(String processId,
                                                                                                          ReportExportRequest reportExportRequest)
                                                                                                   throws VitamClientInternalException

Generate elimination action accession register for deleted units by status and process Id. Report is stored in JSONL format in workspace ORDERED BY opi.

Parameters:

processId -

reportExportRequest - report export request

Returns:

Throws:

VitamClientInternalException

cleanupReport

RequestResponse<com.fasterxml.jackson.databind.JsonNode> cleanupReport(String processId,
                                                                       ReportType reportType)
                                                                throws VitamClientInternalException

Clean all entries with the given process Id tenant and reportType

Parameters:

processId - the given process Id

reportType - report type

Returns:

RequestResponse

Throws:

VitamClientInternalException