Add standardized documentation headers
This commit is contained in:
+22
@@ -1,13 +1,35 @@
|
||||
/*
|
||||
File: AuthenticationManagementService.cpp
|
||||
Description: Implementation file containing the method definitions of the
|
||||
AuthenticationManagementService class, including logout and
|
||||
password change logic.
|
||||
Author: Trenser
|
||||
Date:19-May-2026
|
||||
*/
|
||||
#include "AuthenticationManagementService.h"
|
||||
#include "User.h"
|
||||
|
||||
User* AuthenticationManagementService::m_authenticatedUser = nullptr;
|
||||
|
||||
/*
|
||||
Function: logout
|
||||
Description: Logs out the currently authenticated user by clearing the
|
||||
static authenticated user pointer.
|
||||
Parameter: None
|
||||
Return type: void
|
||||
*/
|
||||
void AuthenticationManagementService::logout()
|
||||
{
|
||||
m_authenticatedUser = nullptr;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: changePassword
|
||||
Description: Changes the password of the currently authenticated user.
|
||||
Throws an exception if no user is logged in.
|
||||
Parameter: const std::string& newPassword - new password to set
|
||||
Return type: void
|
||||
*/
|
||||
void AuthenticationManagementService::changePassword(const std::string& newPassword)
|
||||
{
|
||||
if (m_authenticatedUser == nullptr)
|
||||
|
||||
+8
@@ -1,3 +1,11 @@
|
||||
/*
|
||||
File: AuthenticationManagementService.h
|
||||
Description: Header file declaring the AuthenticationManagementService class, which manages
|
||||
user authentication, login, logout, password changes, and retrieval of the
|
||||
authenticated user.
|
||||
Author: Trenser
|
||||
Date:19-May-2026
|
||||
*/
|
||||
#pragma once
|
||||
#include <string>
|
||||
#include "DataStore.h"
|
||||
|
||||
+44
-1
@@ -1,3 +1,11 @@
|
||||
/*
|
||||
File: ServiceManagementService.cpp
|
||||
Description: Implementation file containing the method definitions of the
|
||||
ServiceManagementService class, including service booking cancellation,
|
||||
job card management, combo package creation, and removal logic.
|
||||
Author: Trenser
|
||||
Date:19-May-2026
|
||||
*/
|
||||
#include "ServiceManagementService.h"
|
||||
#include "DataStore.h"
|
||||
#include "ServiceBooking.h"
|
||||
@@ -7,6 +15,14 @@
|
||||
#include "Factory.h"
|
||||
#include "ComboPackage.h"
|
||||
|
||||
/*
|
||||
Function: cancelCustomerServiceBookings
|
||||
Description: Cancels all service bookings associated with a given customer or technician.
|
||||
Updates booking status, resets customer/technician assignments, sends notifications,
|
||||
and restocks inventory items.
|
||||
Parameter: const std::string& userID - ID of the customer or technician
|
||||
Return type: void
|
||||
*/
|
||||
void ServiceManagementService::cancelCustomerServiceBookings(const std::string& userID)
|
||||
{
|
||||
const int INCREMENT_VALUE = 1;
|
||||
@@ -69,7 +85,13 @@ void ServiceManagementService::cancelCustomerServiceBookings(const std::string&
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/*
|
||||
Function: cancelTechnicianJobs
|
||||
Description: Cancels all jobs assigned to a technician. Updates job status, sends notifications,
|
||||
and restocks inventory items used in the service.
|
||||
Parameter: const std::string& technicianID - ID of the technician
|
||||
Return type: void
|
||||
*/
|
||||
void ServiceManagementService::cancelTechnicianJobs(const std::string& technicianID)
|
||||
{
|
||||
const int INCREMENT_VALUE = 1;
|
||||
@@ -101,6 +123,15 @@ void ServiceManagementService::cancelTechnicianJobs(const std::string& technicia
|
||||
}
|
||||
}
|
||||
|
||||
/*
|
||||
Function: createComboPackage
|
||||
Description: Creates a new combo package with two services and a discount percentage.
|
||||
Validates service IDs, ensures uniqueness, and inserts the new package into the DataStore.
|
||||
Parameter: const std::string& packageName - name of the combo package
|
||||
const util::Vector<std::string>& serviceIDsInNewCombo - list of service IDs
|
||||
double discountPercentage - discount percentage for the package
|
||||
Return type: void
|
||||
*/
|
||||
void ServiceManagementService::createComboPackage(const std::string& packageName, const util::Vector<std::string>& serviceIDsInNewCombo, double discountPercentage)
|
||||
{
|
||||
if (packageName.empty())
|
||||
@@ -162,11 +193,23 @@ void ServiceManagementService::createComboPackage(const std::string& packageName
|
||||
comboPackageMap.insert(newComboPackage->getId(), newComboPackage);
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getComboPackages
|
||||
Description: Retrieves all combo packages stored in the DataStore.
|
||||
Parameter: None
|
||||
Return type: util::Map<std::string, ComboPackage*>
|
||||
*/
|
||||
util::Map<std::string, ComboPackage*> ServiceManagementService::getComboPackages()
|
||||
{
|
||||
return m_dataStore.getComboPackages();
|
||||
}
|
||||
|
||||
/*
|
||||
Function: removeComboPackage
|
||||
Description: Removes a combo package by marking it inactive. Throws an exception if the package ID is not found.
|
||||
Parameter: const std::string& comboPackageID - ID of the combo package
|
||||
Return type: void
|
||||
*/
|
||||
void ServiceManagementService::removeComboPackage(const std::string& comboPackageID)
|
||||
{
|
||||
bool removed = false;
|
||||
|
||||
+8
@@ -1,3 +1,11 @@
|
||||
/*
|
||||
File: ServiceManagementService.h
|
||||
Description: Header file declaring the ServiceManagementService class, which manages
|
||||
services, combo packages, job cards, and service bookings. Inherits from
|
||||
NotificationManagementService to handle notifications.
|
||||
Author: Trenser
|
||||
Date:19-May-2026
|
||||
*/
|
||||
#pragma once
|
||||
#include <string>
|
||||
#include "Map.h"
|
||||
|
||||
+25
@@ -1,11 +1,30 @@
|
||||
/*
|
||||
File: UserManagementService.cpp
|
||||
Description: Implementation file containing the method definitions of the
|
||||
UserManagementService class, including user retrieval and removal logic.
|
||||
Author: Trenser
|
||||
Date:19-May-2026
|
||||
*/
|
||||
#include "UserManagementService.h"
|
||||
#include "User.h"
|
||||
|
||||
/*
|
||||
Function: getUsers
|
||||
Description: Retrieves all users stored in the DataStore.
|
||||
Parameter: None
|
||||
Return type: util::Map<std::string, User*>
|
||||
*/
|
||||
util::Map<std::string, User*> UserManagementService::getUsers()
|
||||
{
|
||||
return m_dataStore.getUsers();
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getUser
|
||||
Description: Retrieves a specific user by ID from the DataStore.
|
||||
Parameter: const std::string& userID - ID of the user
|
||||
Return type: User*
|
||||
*/
|
||||
User* UserManagementService::getUser(const std::string& userID)
|
||||
{
|
||||
int index = m_dataStore.getUsers().find(userID);
|
||||
@@ -16,6 +35,12 @@ User* UserManagementService::getUser(const std::string& userID)
|
||||
return nullptr;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: removeUser
|
||||
Description: Marks a user as inactive in the DataStore instead of deleting them.
|
||||
Parameter: const std::string& userID - ID of the user to remove
|
||||
Return type: void
|
||||
*/
|
||||
void UserManagementService::removeUser(const std::string& userID)
|
||||
{
|
||||
int index = m_dataStore.getUsers().find(userID);
|
||||
|
||||
+8
-1
@@ -1,3 +1,10 @@
|
||||
/*
|
||||
File: UserManagementService.h
|
||||
Description: Header file declaring the UserManagementService class, which manages
|
||||
user creation, updates, retrieval, removal, and notification handling.
|
||||
Author: Trenser
|
||||
Date:19-May-2026
|
||||
*/
|
||||
#pragma once
|
||||
#include <string>
|
||||
#include "Map.h"
|
||||
@@ -13,7 +20,7 @@ private:
|
||||
DataStore& m_dataStore;
|
||||
public:
|
||||
UserManagementService() : m_dataStore(DataStore::getInstance()) {}
|
||||
void createUser(const std::string& username, const std::string& password, const std::string& email, const std::string& phone, util::UserType type);
|
||||
void createUser(const std::string& username, const std::string& name, const std::string& password, const std::string& email, const std::string& phone, util::UserType type);
|
||||
void updateUserDetails(const std::string& userID, const std::string& email, const std::string& phone);
|
||||
util::Map<std::string, User*> getUsers();
|
||||
util::Map<std::string, User*> getUsers(util::UserType type);
|
||||
|
||||
Reference in New Issue
Block a user