[MODAUD-174] - Added java docs

folio-org · Nov 15, 2023 · 49b39b2 · 49b39b2
1 parent 6438c25
commit 49b39b2
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/mod-audit-server/src/main/java/org/folio/dao/acquisition/PieceEventsDao.java b/mod-audit-server/src/main/java/org/folio/dao/acquisition/PieceEventsDao.java
@@ -31,6 +31,16 @@ public interface PieceEventsDao {
   Future<PieceAuditEventCollection> getAuditEventsByPieceId(String pieceId, String sortBy, String sortOrder,
                                                             int limit, int offset, String tenantId);
 
+  /**
+   * Searches for piece audit events with status changes by piece id
+   * @param pieceId   piece id
+   * @param sortBy    sort by
+   * @param sortOrder sort order
+   * @param limit     limit
+   * @param offset    offset
+   * @param tenantId  tenant id
+   * @return future with PieceAuditEventCollection
+   */
   Future<PieceAuditEventCollection> getAuditEventsWithStatusChangesByPieceId(String pieceId, String sortBy, String sortOrder,
                                                                             int limit, int offset, String tenantId);
 }