Package com.dzidzi.api

Interface HistoryApi

public interface HistoryApi
HistoryApi contains all the api operations for handling Address of DzidziApp.

  • Method Details

    • findHistoryById

      History findHistoryById(UUID id)
      It finds history by the given id.
      Parameters:
      id - the id of the history
      Returns:
      the history found
      Throws:
      com.dzidzi.exception.EntityNotFoundException - when entity is not found

    • createHistory

      History createHistory(HistoryRequest historyRequest)
      It adds a new history.
      Parameters:
      historyRequest - the HistoryRequest to create a new history
      Returns:
      the history created/added

    • deleteHistory

      void deleteHistory(UUID id)
      It deletes a history.
      Parameters:
      id - the id of the history to delete

    • findHistories

      DzidziPaginationDTO<History> findHistories(FindHistoryRequest findHistoryRequest)
      Gets a paginated history.
      Parameters:
      findHistoryRequest - the FindHistoryRequest
      Returns:
      the paginated history