Design a Digital Apartment Maintenance Request Tracker Using OOD Concepts

Overview:

A Digital Apartment Maintenance Request Tracker is a platform designed to streamline the process of submitting, tracking, and managing maintenance requests in an apartment complex. By utilizing Object-Oriented Design (OOD) principles, we can ensure that the system is modular, scalable, and maintainable. The key functionality of this platform is to allow tenants to easily request maintenance services, track the status of their requests, and allow property managers or maintenance personnel to assign, update, and resolve issues efficiently.

Key Entities and their Relationships:

1. Tenant

2. Maintenance Request

3. Maintenance Staff

4. Apartment

5. Maintenance History

Classes and Their Attributes

1. Tenant Class:

The Tenant class represents an individual tenant living in an apartment within a building. Tenants can submit maintenance requests and track their status.

Attributes:

• tenantID: Unique identifier for each tenant.

• name: Name of the tenant.

• apartment: Apartment assigned to the tenant.

• contactInfo: Contact details like phone number or email.

• requests: List of maintenance requests made by the tenant.

Methods:

• submitRequest(issue: str, description: str): Allows tenants to create a maintenance request.

• viewRequests(): Views the status of all the requests submitted by the tenant.

• cancelRequest(requestID: int): Allows the tenant to cancel a request if not yet processed.

2. Apartment Class:

An Apartment is a residential unit in a building where tenants reside. It is associated with maintenance issues.

Attributes:

• apartmentID: Unique identifier for the apartment.

• address: Apartment address or unit number.

• tenant: The current tenant occupying the apartment.

Methods:

• assignTenant(tenant: Tenant): Assign a tenant to the apartment.

• getApartmentDetails(): Fetches the details of the apartment.

3. MaintenanceRequest Class:

The MaintenanceRequest class represents an individual request made by a tenant for maintenance work.

Attributes:

• requestID: Unique identifier for the maintenance request.

• tenantID: ID of the tenant who submitted the request.

• issueType: Type of issue (plumbing, electrical, etc.).

• description: Detailed description of the issue.

• status: Current status of the request (e.g., “Pending”, “In Progress”, “Resolved”).

• assignedStaff: Maintenance staff assigned to the request.

• priority: Priority level of the issue (low, medium, high).

Methods:

• updateStatus(status: str): Updates the status of the maintenance request.

• assignStaff(staff: MaintenanceStaff): Assigns maintenance staff to the request.

• setPriority(priority: str): Sets the priority of the request.

4. MaintenanceStaff Class:

The MaintenanceStaff class represents an employee who handles maintenance requests.

Attributes:

• staffID: Unique identifier for the maintenance staff.

• name: Name of the staff member.

• specialization: Area of expertise (plumbing, electrical, HVAC, etc.).

• assignedRequests: List of maintenance requests assigned to the staff member.

Methods:

• viewAssignedRequests(): Views all the requests assigned to the maintenance staff.

• updateRequest(requestID: int, status: str): Updates the status of the request after work completion.

5. MaintenanceHistory Class:

The MaintenanceHistory class stores the past maintenance records for an apartment.

Attributes:

• historyID: Unique identifier for each maintenance record.

• apartmentID: ID of the apartment associated with the record.

• requestDetails: List of details of past requests.

• maintenanceDate: Date when the maintenance work was completed.

• resolvedBy: Maintenance staff who resolved the issue.

Methods:

• getHistory(apartmentID: int): Retrieves all past maintenance records for a given apartment.

• addHistoryRecord(request: MaintenanceRequest): Adds a completed maintenance request to the history.

System Operations:

1. Submit Maintenance Request:

A tenant submits a request for maintenance, specifying the issue, a detailed description, and the apartment ID.

• The system creates a new MaintenanceRequest object.

• The request is added to the tenant’s list of requests.

• The request is automatically set to “Pending” status.

2. Assign Maintenance Staff:

When a maintenance request is made, the system allows the property manager or admin to assign a maintenance staff member based on specialization and availability.

• The MaintenanceRequest object will be updated to reflect the staff member assigned to it.

• The staff member will then be added to the request’s assignedStaff attribute.

3. Track Maintenance Request:

Tenants can check the status of their requests at any time through the platform. They can view if the request is still pending, in progress, or resolved.

• The status is updated in the MaintenanceRequest class whenever it changes.

4. Resolve Maintenance Issue:

Once the staff has completed the work, they update the request status to “Resolved,” and the work is logged in the MaintenanceHistory of the respective apartment.

• The MaintenanceStaff class updates the status of the request.

• The MaintenanceHistory class adds a new record for the resolved issue.

• The tenant can now view the maintenance history in their apartment profile.

5. View Maintenance History:

Tenants or property managers can view a history of all maintenance requests that have been resolved for a given apartment.

• The MaintenanceHistory object pulls up all records related to a particular apartment.

UML Diagram Representation:

To visualize the system structure, a UML diagram would include:

• Classes: Tenant, MaintenanceRequest, MaintenanceStaff, Apartment, MaintenanceHistory.

• Relationships:

  • Tenant has many MaintenanceRequests.

  • MaintenanceRequest is linked to one Tenant and one MaintenanceStaff.

  • MaintenanceStaff can handle many MaintenanceRequests.

  • Apartment can have multiple MaintenanceRequests and MaintenanceHistory entries.

Conclusion:

Using Object-Oriented Design principles, the Digital Apartment Maintenance Request Tracker is built to provide efficient tracking of maintenance requests. Through modular classes like Tenant, MaintenanceRequest, MaintenanceStaff, and Apartment, the system ensures each part of the process is well-defined and easy to maintain. The system also provides valuable historical records for both tenants and property managers to ensure that maintenance issues are addressed in a timely and professional manner.