Package com.apgar.common.lib.service.declaration

Class DatasetValidationReportExportServiceDeclaration

java.lang.Object
com.apgar.common.lib.service.declaration.DatasetValidationReportExportServiceDeclaration
All Implemented Interfaces:
com.orchestranetworks.userservice.declaration.UserServiceDeclaration<com.orchestranetworks.ui.selection.DatasetEntitySelection,com.orchestranetworks.userservice.declaration.ActivationContextOnDataset>, com.orchestranetworks.userservice.declaration.UserServiceDeclaration.OnDataset
public class DatasetValidationReportExportServiceDeclaration extends Object implements com.orchestranetworks.userservice.declaration.UserServiceDeclaration.OnDataset
Service Declaration for the Dataset Validation Report Export Service.

To activate this service, you must register it within your module's context, specifically in the RegisterServlet class, which extends ModuleRegistrationServlet. Below is a sample implementation of the registration: 

 import com.orchestranetworks.module.ModuleRegistrationServlet;
 import com.orchestranetworks.module.ModuleServiceRegistrationContext;
 import com.apgar.common.lib.service.declaration.DatasetValidationReportExportServiceDeclaration
 public class RegisterServlet extends ModuleRegistrationServlet {
     @Override
     public void handleServiceRegistration(ModuleServiceRegistrationContext context) {
         context.registerUserService(new DatasetValidationReportExportServiceDeclaration(context.getModuleName()));
     }
 }
Author:
APGAR Consulting

  • Nested Class Summary

    Nested classes/interfaces inherited from interface com.orchestranetworks.userservice.declaration.UserServiceDeclaration

    com.orchestranetworks.userservice.declaration.UserServiceDeclaration.OnAssociation, com.orchestranetworks.userservice.declaration.UserServiceDeclaration.OnAssociationRecord, com.orchestranetworks.userservice.declaration.UserServiceDeclaration.OnDataset, com.orchestranetworks.userservice.declaration.UserServiceDeclaration.OnDataspace, com.orchestranetworks.userservice.declaration.UserServiceDeclaration.OnHierarchy, com.orchestranetworks.userservice.declaration.UserServiceDeclaration.OnHierarchyNode, com.orchestranetworks.userservice.declaration.UserServiceDeclaration.OnRecord, com.orchestranetworks.userservice.declaration.UserServiceDeclaration.OnTableView

  • Constructor Summary

    Constructors
    Constructor
    Description
    DatasetValidationReportExportServiceDeclaration(String moduleName)
    Constructor to be used to register this user service for a specific module.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.orchestranetworks.userservice.UserService<com.orchestranetworks.ui.selection.DatasetEntitySelection>
    createUserService()
    Creates a new user service implementation of the dataset validation report export.
    void
    declareWebComponent(com.orchestranetworks.userservice.declaration.WebComponentDeclarationContext context)
    Defines the web component properties of the user service.
    void
    defineActivation(com.orchestranetworks.userservice.declaration.ActivationContextOnDataset context)
    Defines the activation scope of this service.
    void
    defineProperties(com.orchestranetworks.userservice.declaration.UserServicePropertiesDefinitionContext context)
    Defines the properties of the user service.
    com.orchestranetworks.service.ServiceKey
    getServiceKey()
    Returns the identifier of the user service.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • DatasetValidationReportExportServiceDeclaration

      public DatasetValidationReportExportServiceDeclaration(String moduleName)
      Constructor to be used to register this user service for a specific module.
      Parameters:
      moduleName - the module for which the user service is declared

  • Method Details

    • createUserService

      public com.orchestranetworks.userservice.UserService<com.orchestranetworks.ui.selection.DatasetEntitySelection> createUserService()
      Creates a new user service implementation of the dataset validation report export.

      This method is invoked whenever the declared user service is launched.

      Specified by:
      createUserService in interface com.orchestranetworks.userservice.declaration.UserServiceDeclaration<com.orchestranetworks.ui.selection.DatasetEntitySelection,com.orchestranetworks.userservice.declaration.ActivationContextOnDataset>
      Returns:
      the user service that is launched

    • declareWebComponent

      public void declareWebComponent(com.orchestranetworks.userservice.declaration.WebComponentDeclarationContext context)
      Defines the web component properties of the user service. By default, this method is empty.
      Specified by:
      declareWebComponent in interface com.orchestranetworks.userservice.declaration.UserServiceDeclaration<com.orchestranetworks.ui.selection.DatasetEntitySelection,com.orchestranetworks.userservice.declaration.ActivationContextOnDataset>
      Parameters:
      context - the declaration context of the web component

    • defineProperties

      public void defineProperties(com.orchestranetworks.userservice.declaration.UserServicePropertiesDefinitionContext context)
      Defines the properties of the user service.

      It sets the service label to Dataset Validation Report Export and sets the following confirmation message before launching: Dataset Validation Report Export?

      Specified by:
      defineProperties in interface com.orchestranetworks.userservice.declaration.UserServiceDeclaration<com.orchestranetworks.ui.selection.DatasetEntitySelection,com.orchestranetworks.userservice.declaration.ActivationContextOnDataset>
      Parameters:
      context - the properties definition context of the user service

    • getServiceKey

      public com.orchestranetworks.service.ServiceKey getServiceKey()
      Returns the identifier of the user service.
      Specified by:
      getServiceKey in interface com.orchestranetworks.userservice.declaration.UserServiceDeclaration<com.orchestranetworks.ui.selection.DatasetEntitySelection,com.orchestranetworks.userservice.declaration.ActivationContextOnDataset>
      Returns:
      the ID of the user service as a ServiceKey

    • defineActivation

      public void defineActivation(com.orchestranetworks.userservice.declaration.ActivationContextOnDataset context)
      Defines the activation scope of this service. By default, it is activated for all datasets. *

      To customize the activation, you can either extend this class or customize it through dataset permissions in the user interface.

      Specified by:
      defineActivation in interface com.orchestranetworks.userservice.declaration.UserServiceDeclaration<com.orchestranetworks.ui.selection.DatasetEntitySelection,com.orchestranetworks.userservice.declaration.ActivationContextOnDataset>
      Parameters:
      context - the activation context on the dataset