4b71836fea
- Neue DTO-Extension-Methoden hinzugefügt, um die Verarbeitung und Zuweisung von Nachrichten und Benachrichtigungen in Ergebnisobjekten zu vereinfachen. - Lokalisierungsunterstützung in der API-Schicht implementiert, einschließlich Cookie-basierter Lokalisierung und Konfiguration unterstützter Kulturen. - Die Integration von StringLocalizer in die API-Schicht wurde durchgeführt, um eine nahtlose Mehrsprachigkeit zu ermöglichen. - Fehlerbehandlung für fehlende Konfigurationseinstellungen verbessert. Die Änderungen verbessern die Flexibilität und Wartbarkeit des Codes und unterstützen eine effizientere Internationalisierung der Anwendung.
60 lines
3.6 KiB
C#
60 lines
3.6 KiB
C#
using DigitalData.Core.Contracts.Infrastructure;
|
|
using DigitalData.Core.DTO;
|
|
|
|
namespace DigitalData.Core.Contracts.Application
|
|
{
|
|
public interface ICRUDService<TCRUDRepository, TCreateDto, TReadDto, TUpdateDto, TEntity, TId>
|
|
where TCRUDRepository : ICRUDRepository<TEntity, TId> where TCreateDto : class where TReadDto : class where TUpdateDto : class where TEntity : class
|
|
{
|
|
Task<DataResult<TId>> CreateAsync(TCreateDto createDto);
|
|
|
|
/// <summary>
|
|
/// Retrieves an entity by its identifier and returns its readDTO representation wrapped in an IServiceResult,
|
|
/// including the readDTO on success or null and an error message on failure.
|
|
/// </summary>
|
|
/// <param name="id">The identifier of the entity to retrieve.</param>
|
|
/// <returns>An DataResult containing the readDTO representing the found entity or null, with an appropriate message.</returns>
|
|
Task<DataResult<TReadDto>> ReadByIdAsync(TId id);
|
|
|
|
/// <summary>
|
|
/// Retrieves all entities and returns their readDTO representations wrapped in an IServiceResult,
|
|
/// including a collection of readDTOs on success or an error message on failure.
|
|
/// </summary>
|
|
/// <returns>An DataResult containing a collection of readDTOs representing all entities or an error message.</returns>
|
|
Task<DataResult<IEnumerable<TReadDto>>> ReadAllAsync();
|
|
|
|
/// <summary>
|
|
/// Updates an existing entity based on the provided updateDTO and returns the result wrapped in an IServiceMessage,
|
|
/// indicating the success or failure of the operation, including the error messages on failure.
|
|
/// </summary>
|
|
/// <param name="updateDto">The updateDTO with updated values for the entity.</param>
|
|
/// <returns>An Result indicating the outcome of the update operation, with an appropriate message.</returns>
|
|
Task<Result> UpdateAsync(TUpdateDto updateDto);
|
|
|
|
/// <summary>
|
|
/// Deletes an entity by its identifier and returns the result wrapped in an IServiceMessage,
|
|
/// indicating the success or failure of the operation, including the error messages on failure.
|
|
/// </summary>
|
|
/// <param name="id">The identifier of the entity to delete.</param>
|
|
/// <returns>An Result indicating the outcome of the delete operation, with an appropriate message.</returns>
|
|
Task<Result> DeleteAsyncById(TId id);
|
|
|
|
/// <summary>
|
|
/// Asynchronously checks if an entity with the specified identifier exists within the data store.
|
|
/// </summary>
|
|
/// <param name="id">The identifier of the entity to check.</param>
|
|
/// <returns>A task that represents the asynchronous operation. The task result contains a boolean value indicating whether the entity exists.</returns>
|
|
Task<bool> HasEntity(TId id);
|
|
|
|
/// <summary>
|
|
/// Handles exceptions that occur within service actions. This method should log the exception
|
|
/// and return an String that contains information about the error, which can then be sent to the client.
|
|
/// The implementation should determine the appropriate level of detail to include in the error message
|
|
/// based on security and usability considerations.
|
|
/// </summary>
|
|
/// <param name="ex">The exception that occurred during the controller action.</param>
|
|
/// <returns>An string instance representing the outcome of the error handling process.
|
|
/// This includes a flag indicating the operation was unsuccessful and any relevant error messages.</returns>
|
|
string HandleException(Exception ex);
|
|
}
|
|
} |