From 539e084f9bf73a1e4ef08ecfee8bf5c808a433b2 Mon Sep 17 00:00:00 2001 From: Harkamal Randhawa Date: Mon, 20 Apr 2026 12:38:42 -0600 Subject: [PATCH] add service file headers --- .../com/petshop/backend/service/ActivityLogService.java | 7 +++++++ .../java/com/petshop/backend/service/AnalyticsService.java | 7 +++++++ .../com/petshop/backend/service/AvatarStorageService.java | 7 +++++++ .../java/com/petshop/backend/service/AzureBlobService.java | 7 +++++++ .../backend/service/CatalogImageStorageService.java | 7 +++++++ .../java/com/petshop/backend/service/CategoryService.java | 6 ++++++ .../backend/service/ChatAttachmentStorageService.java | 7 +++++++ .../java/com/petshop/backend/service/CouponService.java | 7 +++++++ .../java/com/petshop/backend/service/InventoryService.java | 7 +++++++ .../com/petshop/backend/service/PasswordResetService.java | 7 +++++++ .../java/com/petshop/backend/service/ProductService.java | 7 +++++++ .../petshop/backend/service/ProductSupplierService.java | 7 +++++++ .../com/petshop/backend/service/PurchaseOrderService.java | 7 +++++++ .../java/com/petshop/backend/service/RefundService.java | 7 +++++++ .../java/com/petshop/backend/service/ServiceService.java | 7 +++++++ .../java/com/petshop/backend/service/StoreService.java | 6 ++++++ .../java/com/petshop/backend/service/SupplierService.java | 6 ++++++ .../main/java/com/petshop/backend/service/UserService.java | 7 +++++++ 18 files changed, 123 insertions(+) diff --git a/backend/src/main/java/com/petshop/backend/service/ActivityLogService.java b/backend/src/main/java/com/petshop/backend/service/ActivityLogService.java index 598d9f95..fd1efdda 100644 --- a/backend/src/main/java/com/petshop/backend/service/ActivityLogService.java +++ b/backend/src/main/java/com/petshop/backend/service/ActivityLogService.java @@ -1,3 +1,10 @@ +/* + * Records and retrieves user activity logs so admins can + * see who did what and when. + * + * Author: Harkamal + * Date: April 2026 + */ package com.petshop.backend.service; import com.petshop.backend.dto.activity.ActivityLogResponse; diff --git a/backend/src/main/java/com/petshop/backend/service/AnalyticsService.java b/backend/src/main/java/com/petshop/backend/service/AnalyticsService.java index eae169d0..c8772274 100644 --- a/backend/src/main/java/com/petshop/backend/service/AnalyticsService.java +++ b/backend/src/main/java/com/petshop/backend/service/AnalyticsService.java @@ -1,3 +1,10 @@ +/* + * Builds the dashboard data by pulling together sales totals, + * inventory levels, and top-selling products. + * + * Author: Harkamal + * Date: April 2026 + */ package com.petshop.backend.service; import com.petshop.backend.dto.analytics.DashboardResponse; diff --git a/backend/src/main/java/com/petshop/backend/service/AvatarStorageService.java b/backend/src/main/java/com/petshop/backend/service/AvatarStorageService.java index 5ff61021..e700e562 100644 --- a/backend/src/main/java/com/petshop/backend/service/AvatarStorageService.java +++ b/backend/src/main/java/com/petshop/backend/service/AvatarStorageService.java @@ -1,3 +1,10 @@ +/* + * Stores and retrieves user profile avatar images, using + * either local disk or Azure Blob Storage. + * + * Author: Harkamal + * Date: April 2026 + */ package com.petshop.backend.service; import com.petshop.backend.entity.User; diff --git a/backend/src/main/java/com/petshop/backend/service/AzureBlobService.java b/backend/src/main/java/com/petshop/backend/service/AzureBlobService.java index cbdfc62d..a8a7d6dd 100644 --- a/backend/src/main/java/com/petshop/backend/service/AzureBlobService.java +++ b/backend/src/main/java/com/petshop/backend/service/AzureBlobService.java @@ -1,3 +1,10 @@ +/* + * Low-level wrapper around the Azure Blob Storage SDK for + * uploading, downloading, and deleting files. + * + * Author: Harkamal + * Date: April 2026 + */ package com.petshop.backend.service; import com.azure.storage.blob.BlobContainerClient; diff --git a/backend/src/main/java/com/petshop/backend/service/CatalogImageStorageService.java b/backend/src/main/java/com/petshop/backend/service/CatalogImageStorageService.java index 229ac5ba..69e28837 100644 --- a/backend/src/main/java/com/petshop/backend/service/CatalogImageStorageService.java +++ b/backend/src/main/java/com/petshop/backend/service/CatalogImageStorageService.java @@ -1,3 +1,10 @@ +/* + * Stores and retrieves images for pets and products, using + * either local disk or Azure Blob Storage. + * + * Author: Harkamal + * Date: April 2026 + */ package com.petshop.backend.service; import org.slf4j.Logger; diff --git a/backend/src/main/java/com/petshop/backend/service/CategoryService.java b/backend/src/main/java/com/petshop/backend/service/CategoryService.java index ea08dc3d..327d7ba7 100644 --- a/backend/src/main/java/com/petshop/backend/service/CategoryService.java +++ b/backend/src/main/java/com/petshop/backend/service/CategoryService.java @@ -1,3 +1,9 @@ +/* + * Handles creating, updating, and deleting product categories. + * + * Author: Harkamal + * Date: April 2026 + */ package com.petshop.backend.service; import com.petshop.backend.dto.category.CategoryRequest; diff --git a/backend/src/main/java/com/petshop/backend/service/ChatAttachmentStorageService.java b/backend/src/main/java/com/petshop/backend/service/ChatAttachmentStorageService.java index 55932b92..20d94e88 100644 --- a/backend/src/main/java/com/petshop/backend/service/ChatAttachmentStorageService.java +++ b/backend/src/main/java/com/petshop/backend/service/ChatAttachmentStorageService.java @@ -1,3 +1,10 @@ +/* + * Stores and retrieves file attachments sent in chat messages, + * using either local disk or Azure Blob Storage. + * + * Author: Harkamal + * Date: April 2026 + */ package com.petshop.backend.service; import org.springframework.beans.factory.annotation.Autowired; diff --git a/backend/src/main/java/com/petshop/backend/service/CouponService.java b/backend/src/main/java/com/petshop/backend/service/CouponService.java index cf56188f..87d28c6c 100644 --- a/backend/src/main/java/com/petshop/backend/service/CouponService.java +++ b/backend/src/main/java/com/petshop/backend/service/CouponService.java @@ -1,3 +1,10 @@ +/* + * Handles creating, updating, and validating discount coupons + * that can be applied to sales. + * + * Author: Harkamal + * Date: April 2026 + */ package com.petshop.backend.service; import com.petshop.backend.dto.common.BulkDeleteRequest; diff --git a/backend/src/main/java/com/petshop/backend/service/InventoryService.java b/backend/src/main/java/com/petshop/backend/service/InventoryService.java index af133e68..c71dcc15 100644 --- a/backend/src/main/java/com/petshop/backend/service/InventoryService.java +++ b/backend/src/main/java/com/petshop/backend/service/InventoryService.java @@ -1,3 +1,10 @@ +/* + * Manages inventory records that track how much of each + * product is available at each store location. + * + * Author: Harkamal + * Date: April 2026 + */ package com.petshop.backend.service; import com.petshop.backend.dto.common.BulkDeleteRequest; diff --git a/backend/src/main/java/com/petshop/backend/service/PasswordResetService.java b/backend/src/main/java/com/petshop/backend/service/PasswordResetService.java index 6c5c78f5..1080bc35 100644 --- a/backend/src/main/java/com/petshop/backend/service/PasswordResetService.java +++ b/backend/src/main/java/com/petshop/backend/service/PasswordResetService.java @@ -1,3 +1,10 @@ +/* + * Handles the forgot-password flow by generating a reset token, + * emailing it to the user, and verifying it when they reset. + * + * Author: Harkamal + * Date: April 2026 + */ package com.petshop.backend.service; import com.petshop.backend.dto.auth.ForgotPasswordResponse; diff --git a/backend/src/main/java/com/petshop/backend/service/ProductService.java b/backend/src/main/java/com/petshop/backend/service/ProductService.java index ad4524fe..b9061d0c 100644 --- a/backend/src/main/java/com/petshop/backend/service/ProductService.java +++ b/backend/src/main/java/com/petshop/backend/service/ProductService.java @@ -1,3 +1,10 @@ +/* + * Manages products in the catalog, including searching, + * creating, updating, and handling product images. + * + * Author: Harkamal + * Date: April 2026 + */ package com.petshop.backend.service; import com.petshop.backend.dto.common.BulkDeleteRequest; diff --git a/backend/src/main/java/com/petshop/backend/service/ProductSupplierService.java b/backend/src/main/java/com/petshop/backend/service/ProductSupplierService.java index 5adc79fb..25545918 100644 --- a/backend/src/main/java/com/petshop/backend/service/ProductSupplierService.java +++ b/backend/src/main/java/com/petshop/backend/service/ProductSupplierService.java @@ -1,3 +1,10 @@ +/* + * Manages the links between products and their suppliers, + * including the cost each supplier charges for a product. + * + * Author: Harkamal + * Date: April 2026 + */ package com.petshop.backend.service; import com.petshop.backend.dto.productsupplier.BulkDeleteProductSupplierRequest; diff --git a/backend/src/main/java/com/petshop/backend/service/PurchaseOrderService.java b/backend/src/main/java/com/petshop/backend/service/PurchaseOrderService.java index a6803d37..eaa712c2 100644 --- a/backend/src/main/java/com/petshop/backend/service/PurchaseOrderService.java +++ b/backend/src/main/java/com/petshop/backend/service/PurchaseOrderService.java @@ -1,3 +1,10 @@ +/* + * Provides read-only access to purchase orders, which track + * orders placed with suppliers for restocking stores. + * + * Author: Harkamal + * Date: April 2026 + */ package com.petshop.backend.service; import com.petshop.backend.dto.purchaseorder.PurchaseOrderResponse; diff --git a/backend/src/main/java/com/petshop/backend/service/RefundService.java b/backend/src/main/java/com/petshop/backend/service/RefundService.java index 6cfff23d..0716bd90 100644 --- a/backend/src/main/java/com/petshop/backend/service/RefundService.java +++ b/backend/src/main/java/com/petshop/backend/service/RefundService.java @@ -1,3 +1,10 @@ +/* + * Processes refunds for sales, calculating the refund amount + * and updating the original sale record. + * + * Author: Harkamal + * Date: April 2026 + */ package com.petshop.backend.service; import com.petshop.backend.dto.refund.RefundItemResponse; diff --git a/backend/src/main/java/com/petshop/backend/service/ServiceService.java b/backend/src/main/java/com/petshop/backend/service/ServiceService.java index ecf644c2..f05b694f 100644 --- a/backend/src/main/java/com/petshop/backend/service/ServiceService.java +++ b/backend/src/main/java/com/petshop/backend/service/ServiceService.java @@ -1,3 +1,10 @@ +/* + * Manages pet services like grooming and veterinary care, + * including searching and filtering by species. + * + * Author: Harkamal + * Date: April 2026 + */ package com.petshop.backend.service; import com.petshop.backend.dto.common.BulkDeleteRequest; diff --git a/backend/src/main/java/com/petshop/backend/service/StoreService.java b/backend/src/main/java/com/petshop/backend/service/StoreService.java index d9c1bcd3..2dfb763e 100644 --- a/backend/src/main/java/com/petshop/backend/service/StoreService.java +++ b/backend/src/main/java/com/petshop/backend/service/StoreService.java @@ -1,3 +1,9 @@ +/* + * Handles creating, updating, and deleting store locations. + * + * Author: Harkamal + * Date: April 2026 + */ package com.petshop.backend.service; import com.petshop.backend.dto.common.BulkDeleteRequest; diff --git a/backend/src/main/java/com/petshop/backend/service/SupplierService.java b/backend/src/main/java/com/petshop/backend/service/SupplierService.java index 4bb79b5a..a1bb3955 100644 --- a/backend/src/main/java/com/petshop/backend/service/SupplierService.java +++ b/backend/src/main/java/com/petshop/backend/service/SupplierService.java @@ -1,3 +1,9 @@ +/* + * Handles creating, updating, and deleting suppliers. + * + * Author: Harkamal + * Date: April 2026 + */ package com.petshop.backend.service; import com.petshop.backend.dto.common.BulkDeleteRequest; diff --git a/backend/src/main/java/com/petshop/backend/service/UserService.java b/backend/src/main/java/com/petshop/backend/service/UserService.java index 99e25747..587ce9d6 100644 --- a/backend/src/main/java/com/petshop/backend/service/UserService.java +++ b/backend/src/main/java/com/petshop/backend/service/UserService.java @@ -1,3 +1,10 @@ +/* + * Handles creating, updating, and deleting user accounts + * and managing their roles and store assignments. + * + * Author: Harkamal + * Date: April 2026 + */ package com.petshop.backend.service; import com.petshop.backend.dto.common.BulkDeleteRequest;