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

Class DatasetValidationReportExportServiceDeclaration

java.lang.Object

com.apgar.common.lib.service.declaration.DatasetValidationReportExportServiceDeclaration

All Implemented Interfaces:

UserServiceDeclaration<DatasetEntitySelection,ActivationContextOnDataset>, UserServiceDeclaration.OnDataset

public class DatasetValidationReportExportServiceDeclaration
extends Object
implements 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

UserServiceDeclaration.OnAssociation, UserServiceDeclaration.OnAssociationRecord, UserServiceDeclaration.OnDataset, UserServiceDeclaration.OnDataspace, UserServiceDeclaration.OnHierarchy, UserServiceDeclaration.OnHierarchyNode, UserServiceDeclaration.OnRecord, 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
UserService<DatasetEntitySelection>	createUserService()	Creates a new user service implementation of the dataset validation report export.
void	declareWebComponent(WebComponentDeclarationContext context)	Defines the web component properties of the user service.
void	defineActivation(ActivationContextOnDataset context)	Defines the activation scope of this service.
void	defineProperties(UserServicePropertiesDefinitionContext context)	Defines the properties of the user 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 UserService<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 UserServiceDeclaration<DatasetEntitySelection,ActivationContextOnDataset>

Returns:

the user service that is launched

declareWebComponent

public void declareWebComponent(WebComponentDeclarationContext context)

Defines the web component properties of the user service. By default, this method is empty.

Specified by:

declareWebComponent in interface UserServiceDeclaration<DatasetEntitySelection,ActivationContextOnDataset>

Parameters:

context - the declaration context of the web component

defineProperties

public void defineProperties(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 UserServiceDeclaration<DatasetEntitySelection,ActivationContextOnDataset>

Parameters:

context - the properties definition context of the user service

getServiceKey

public ServiceKey getServiceKey()

Returns the identifier of the user service.

Specified by:

getServiceKey in interface UserServiceDeclaration<DatasetEntitySelection,ActivationContextOnDataset>

Returns:

the ID of the user service as a ServiceKey

defineActivation

public void defineActivation(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 UserServiceDeclaration<DatasetEntitySelection,ActivationContextOnDataset>

Parameters:

context - the activation context on the dataset