Package com.apgar.common.lib.service.validation

Class DatasetValidationReportExportService

java.lang.Object
com.apgar.common.lib.service.validation.DatasetValidationReportExportService
All Implemented Interfaces:
com.orchestranetworks.userservice.UserService<com.orchestranetworks.ui.selection.DatasetEntitySelection>
public class DatasetValidationReportExportService extends Object implements com.orchestranetworks.userservice.UserService<com.orchestranetworks.ui.selection.DatasetEntitySelection>
Implementation of the Dataset Validation Report Export Service.

This service is activated from the actions tab of the dataset. It generates the validation report for the dataset in CSV format and automatically downloads it.
The report will include the following information: table label, field label, severity of the validation item, validation message, record ID, and record label.
During report generation, a loading indicator will be displayed, along with a back button to close the service. If the download does not start automatically, you can initiate it manually.

Author:
APGAR Consulting

  • Constructor Summary

    Constructors
    Constructor
    Description
    DatasetValidationReportExportService()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    com.orchestranetworks.userservice.UserServiceEventOutcome
    processEventOutcome(com.orchestranetworks.userservice.UserServiceProcessEventOutcomeContext<com.orchestranetworks.ui.selection.DatasetEntitySelection> context, com.orchestranetworks.userservice.UserServiceEventOutcome outcome)
    Returns standard outcomes (outcomes created by UserServiceNext).
    void
    setupDisplay(com.orchestranetworks.userservice.UserServiceSetupDisplayContext<com.orchestranetworks.ui.selection.DatasetEntitySelection> aContext, com.orchestranetworks.userservice.UserServiceDisplayConfigurator aConfigurator)
    Sets up the display and functionality of the validation report export user service.
    void
    setupObjectContext(com.orchestranetworks.userservice.UserServiceSetupObjectContext<com.orchestranetworks.ui.selection.DatasetEntitySelection> aContext, com.orchestranetworks.userservice.UserServiceObjectContextBuilder aBuilder)
    Defines/Removes objects managed by the user service.
    void
    validate(com.orchestranetworks.userservice.UserServiceValidateContext<com.orchestranetworks.ui.selection.DatasetEntitySelection> aContext)
    Performs custom validation on a form submit.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • DatasetValidationReportExportService

      public DatasetValidationReportExportService()

  • Method Details

    • processEventOutcome

      public com.orchestranetworks.userservice.UserServiceEventOutcome processEventOutcome(com.orchestranetworks.userservice.UserServiceProcessEventOutcomeContext<com.orchestranetworks.ui.selection.DatasetEntitySelection> context, com.orchestranetworks.userservice.UserServiceEventOutcome outcome)
      Returns standard outcomes (outcomes created by UserServiceNext).
      Specified by:
      processEventOutcome in interface com.orchestranetworks.userservice.UserService<com.orchestranetworks.ui.selection.DatasetEntitySelection>
      Parameters:
      context - the context for the event outcome of the user service process
      outcome - the outcome of the user service event
      Returns:
      event outcome of the user service

    • setupDisplay

      public void setupDisplay(com.orchestranetworks.userservice.UserServiceSetupDisplayContext<com.orchestranetworks.ui.selection.DatasetEntitySelection> aContext, com.orchestranetworks.userservice.UserServiceDisplayConfigurator aConfigurator)
      Sets up the display and functionality of the validation report export user service.

      The service includes a back button to close the service and displays a loading indicator while the report is being generated in Excel. Once the generation is complete, the report will be automatically downloaded. If the download does not occur automatically, a link will be provided for manual download.

      Specified by:
      setupDisplay in interface com.orchestranetworks.userservice.UserService<com.orchestranetworks.ui.selection.DatasetEntitySelection>
      Parameters:
      aContext - the setup display context of the user service
      aConfigurator - the display configurator of the user service

    • setupObjectContext

      public void setupObjectContext(com.orchestranetworks.userservice.UserServiceSetupObjectContext<com.orchestranetworks.ui.selection.DatasetEntitySelection> aContext, com.orchestranetworks.userservice.UserServiceObjectContextBuilder aBuilder)
      Defines/Removes objects managed by the user service. By default, it does nothing.
      Specified by:
      setupObjectContext in interface com.orchestranetworks.userservice.UserService<com.orchestranetworks.ui.selection.DatasetEntitySelection>
      Parameters:
      aContext - provides information about the current context
      aBuilder - provides methods to define or remove objects

    • validate

      public void validate(com.orchestranetworks.userservice.UserServiceValidateContext<com.orchestranetworks.ui.selection.DatasetEntitySelection> aContext)
      Performs custom validation on a form submit. By default, it does nothing.
      Specified by:
      validate in interface com.orchestranetworks.userservice.UserService<com.orchestranetworks.ui.selection.DatasetEntitySelection>
      Parameters:
      aContext - the context for user service validation