Introduction

Business

Development

Core

Entity Definitions

FaqEntryEntityDefinition

The FaqEntryEntityDefinition extends the AbstractEntityDefinition:

asciidoctor diagram FaqEntryEntityDefinition

Via the respective getter-setter pairs, the following information can be retrieved/stored in the database:

Property Description

question

stores the question, associated with the FAQ entry

answer

stores the answer, associated with the FAQ entry

FaqSectionEntityDefinition

The FaqSectionEntityDefinition extends the AbstractEntityDefinition and the AbstractNameableEntityDefinition:

asciidoctor diagram FaqSectionEntityDefinition

There is only the entries getter-setter pair defined in the FaqSectionEntityDefinition. It lets you store/retrieve a list of the entries which the section has.

asciidoctor diagram FaqWidgetEntityDefinition

There is only the sections getter-setter pair defined in the FaqWidgetEntityDefinition. It lets you store/retrieve a list of the sections the widget has.

Spring Data JPA Repositories

FaqEntryRepository

The FaqEntryRepository extends the link:../../. ./nemesis-platform-core/apidocs/com/nemesis/platform/core/repository/jpa/BaseEntityRepository.html[BaseEntityRepository] and is the corresponding Spring Data JPA repository for the FaqEntryEntityDefinition:

asciidoctor diagram FaqEntryRepository
FaqSectionRepository

The FaqSectionRepository extends the link:../../. ./nemesis-platform-core/apidocs/com/nemesis/platform/core/repository/jpa/BaseEntityRepository.html[BaseEntityRepository] and is the corresponding Spring Data JPA repository for the FaqSectionEntityDefinition:

asciidoctor diagram FaqSectionRepository
FaqWidgetEntityRepository

The FaqWidgetEntityRepository extends the link:../../. ./nemesis-platform-core/apidocs/com/nemesis/platform/core/repository/jpa/active/ActivatableRepository.html[ActivatableRepository] and the link:../../. ./nemesis-platform-core/apidocs/com/nemesis/platform/core/repository/jpa/BaseCatalogableEntityRepository.html[BaseCatalogableEntityRepository]:

asciidoctor diagram FaqWidgetEntityRepository

This is the corresponding Spring Data JPA repository for the FaqWidgetEntityDefinition

Facade

MapperFactoryConfigurers

The conversion is defined in the FaqWidgetAutoConfiguration class. As registered conversions here come:

  • from FaqWidgetEntityDefinition to FaqWidgetDtoDefinition,

  • from FaqSectionEntityDefinition to FaqSectionDtoDefinition and

  • from FaqEntryEntityDefinition to FaqEntryDtoDefinition

All of the conversions are done via the byDefault() method.

Dto definitions

FaqEntryDtoDefinition

The FaqEntryDtoDefinition is the corresponding Dto object for the FaqEntryEntityDefinition.

FaqSectionDtoDefinition

The FaqSectionDtoDefinition is the corresponding Dto object for the FaqSectionEntityDefinition.

FaqWidgetDtoDefinition

The FaqWidgetDtoDefinition extends the WidgetDtoDefinition, going further to the AbstractEntityDtoDefinition:

asciidoctor diagram FaqWidgetDtoDefinition

This is the corresponding Dto object for the FaqWidgetEntityDefinition.

Storefront

FaqWidgetController

The FaqWidgetController extends the AbstractWidgetController:

asciidoctor diagram FaqWidgetController

Integration

The integration with the Nemesis platform is pretty straight-forward - just need to add the widget in your classpath:

<dependency>
    <groupId>$project.groupId</groupId>
    <artifactId>$project.artifactId</artifactId>
</dependency>