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
void	appendReportEntries(ReportBody reportBody) Append report entries
void	cleanupReport(String processId, ReportType reportType) Clean all entries with the given process Id tenant and reportType
void	exportUnitsToInvalidate(String processId, ReportExportRequest reportExportRequest) Generate units to invalidate by process Id.
void	generatePurgeAccessionRegisterReport(String processId, ReportExportRequest reportExportRequest) Generate elimination action accession register for deleted units by status and process Id.
void	generatePurgeDistinctObjectGroupInUnitReport(String processId, ReportExportRequest reportExportRequest) Generate purge district object groups for units by status and process Id.
void	storeReport(Report reportInfo)

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

checkStatus, checkStatus, close, consumeAnyEntityAndClose, getResourcePath, getServiceUrl

Method Detail

generatePurgeDistinctObjectGroupInUnitReport

void generatePurgeDistinctObjectGroupInUnitReport(String processId,
                                                  ReportExportRequest reportExportRequest)
                                           throws VitamClientInternalException

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

Parameters:

processId -

reportExportRequest - report export request

Throws:

VitamClientInternalException

appendReportEntries

void appendReportEntries(ReportBody reportBody)
                  throws VitamClientInternalException

Append report entries

Parameters:

reportBody - the given entry document.

Throws:

VitamClientInternalException

storeReport

void storeReport(Report reportInfo)
          throws VitamClientInternalException

Throws:

VitamClientInternalException

exportUnitsToInvalidate

void exportUnitsToInvalidate(String processId,
                             ReportExportRequest reportExportRequest)
                      throws VitamClientInternalException

Generate units to invalidate by process Id. Report is stored in JSONL format without duplicates.

Throws:

VitamClientInternalException

generatePurgeAccessionRegisterReport

void generatePurgeAccessionRegisterReport(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

Throws:

VitamClientInternalException

cleanupReport

void 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

Throws:

VitamClientInternalException