Skip to content

Commit 0f552f4

Browse files
gpascucciclaude
gpascucci
and
claude
authored
refactor(dto): standardize CheckStatusResponse naming (Story 29.12) (#336)
Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 64a0a38 commit 0f552f4

19 files changed

Lines changed: 69 additions & 69 deletions

‎backend/src/main/java/ca/bc/gov/nrs/ilcr/schedule1/Schedule1Controller.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
import ca.bc.gov.nrs.ilcr.millcontext.MillContextService;
44
import ca.bc.gov.nrs.ilcr.schedule1.api.Schedule1Api;
5-
import ca.bc.gov.nrs.ilcr.schedule1.dto.CheckStatusResponse;
5+
import ca.bc.gov.nrs.ilcr.schedule1.dto.Schedule1CheckStatusResponse;
66
import ca.bc.gov.nrs.ilcr.schedule1.dto.MessageInfo;
77
import ca.bc.gov.nrs.ilcr.schedule1.dto.MessageResponse;
88
import ca.bc.gov.nrs.ilcr.schedule1.dto.Schedule1Request;
@@ -81,7 +81,7 @@ public ResponseEntity<MessageResponse> deleteSchedule1(
8181

8282
@Override
8383
@PreAuthorize("@permissions.hasPermission(authentication, 'VIEW_SCHEDULE')")
84-
public ResponseEntity<CheckStatusResponse> checkStatus(
84+
public ResponseEntity<Schedule1CheckStatusResponse> checkStatus(
8585
long millId, int year, Authentication authentication) {
8686
millContextService.validateScheduleViewable(millId, year, SCHEDULE_1_CATEGORY);
8787
return ResponseEntity.ok(schedule1Service.checkSchedule1Status(millId, year));

‎backend/src/main/java/ca/bc/gov/nrs/ilcr/schedule1/Schedule1Service.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
import ca.bc.gov.nrs.ilcr.schedule1.Schedule1Repository.DetailRow;
55
import ca.bc.gov.nrs.ilcr.schedule1.Schedule1Repository.OtherCostDetailRow;
66
import ca.bc.gov.nrs.ilcr.schedule1.Schedule1Repository.SummaryRow;
7-
import ca.bc.gov.nrs.ilcr.schedule1.dto.CheckStatusResponse;
7+
import ca.bc.gov.nrs.ilcr.schedule1.dto.Schedule1CheckStatusResponse;
88
import ca.bc.gov.nrs.ilcr.schedule1.dto.LineItem;
99
import ca.bc.gov.nrs.ilcr.schedule1.dto.MessageInfo;
1010
import ca.bc.gov.nrs.ilcr.schedule1.dto.OtherCostRequest;
@@ -619,7 +619,7 @@ private record CheckField(int code, String label, boolean checkVolume, boolean c
619619
* (missing mandatory fields + Other-Costs volume/cost consistency) block; the empty-cost row check is
620620
* a non-blocking warning. Verbatim messages composed server-side (AD-8), in legacy field order.
621621
*/
622-
public CheckStatusResponse checkSchedule1Status(long millId, int year) {
622+
public Schedule1CheckStatusResponse checkSchedule1Status(long millId, int year) {
623623
SummaryRow summary = repository.findSummary(millId, year, SCHEDULE_1_CATEGORY)
624624
.orElseThrow(ScheduleNotFoundException::new);
625625
List<DetailRow> details = repository.findDetails(summary.summaryId());
@@ -653,7 +653,7 @@ public CheckStatusResponse checkSchedule1Status(long millId, int year) {
653653
MessageInfo message = requirementsMet
654654
? new MessageInfo(MSG_REQUIREMENTS_MET, resolveText(MSG_REQUIREMENTS_MET))
655655
: null;
656-
return new CheckStatusResponse(requirementsMet, errors, warnings, message);
656+
return new Schedule1CheckStatusResponse(requirementsMet, errors, warnings, message);
657657
}
658658

659659
/** First stored detail row per (non-Other) cost-item code; later duplicates are ignored. */

‎backend/src/main/java/ca/bc/gov/nrs/ilcr/schedule1/api/Schedule1Api.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
package ca.bc.gov.nrs.ilcr.schedule1.api;
22

3-
import ca.bc.gov.nrs.ilcr.schedule1.dto.CheckStatusResponse;
3+
import ca.bc.gov.nrs.ilcr.schedule1.dto.Schedule1CheckStatusResponse;
44
import ca.bc.gov.nrs.ilcr.schedule1.dto.MessageResponse;
55
import ca.bc.gov.nrs.ilcr.schedule1.dto.Schedule1Request;
66
import ca.bc.gov.nrs.ilcr.schedule1.dto.Schedule1Response;
@@ -78,6 +78,6 @@ ResponseEntity<MessageResponse> deleteSchedule1(
7878
* @return 200 with the check-status result (errors, warnings, requirements-met + success message)
7979
*/
8080
@PostMapping("/check-status")
81-
ResponseEntity<CheckStatusResponse> checkStatus(
81+
ResponseEntity<Schedule1CheckStatusResponse> checkStatus(
8282
@RequestParam long millId, @RequestParam int year, Authentication authentication);
8383
}

backend/src/main/java/ca/bc/gov/nrs/ilcr/schedule1/dto/CheckStatusResponse.java renamed to backend/src/main/java/ca/bc/gov/nrs/ilcr/schedule1/dto/Schedule1CheckStatusResponse.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
* @param warnings the non-blocking advisories (e.g. WRN-002 empty-cost row)
1515
* @param message the "all requirements met" success message when {@code requirementsMet}, else null
1616
*/
17-
public record CheckStatusResponse(
17+
public record Schedule1CheckStatusResponse(
1818
boolean requirementsMet,
1919
List<MessageInfo> errors,
2020
List<MessageInfo> warnings,

‎backend/src/main/java/ca/bc/gov/nrs/ilcr/schedule2/Schedule2Controller.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
import ca.bc.gov.nrs.ilcr.schedule1.dto.MessageInfo;
55
import ca.bc.gov.nrs.ilcr.schedule1.dto.MessageResponse;
66
import ca.bc.gov.nrs.ilcr.schedule2.api.Schedule2Api;
7-
import ca.bc.gov.nrs.ilcr.schedule2.dto.CheckStatusResponse;
7+
import ca.bc.gov.nrs.ilcr.schedule2.dto.Schedule2CheckStatusResponse;
88
import ca.bc.gov.nrs.ilcr.schedule2.dto.Schedule2Request;
99
import ca.bc.gov.nrs.ilcr.schedule2.dto.Schedule2Response;
1010
import ca.bc.gov.nrs.ilcr.security.SchedulePermissions;
@@ -77,11 +77,11 @@ public ResponseEntity<MessageResponse> deleteSchedule2(
7777

7878
@Override
7979
@PreAuthorize("@permissions.hasPermission(authentication, 'VIEW_SCHEDULE')")
80-
public ResponseEntity<CheckStatusResponse> checkStatus(
80+
public ResponseEntity<Schedule2CheckStatusResponse> checkStatus(
8181
long millId, int year, Authentication authentication) {
8282
// Read-only (AD-5): context guard first (no summary-required), then evaluate — mutates nothing.
8383
millContextService.validateMillYearActive(millId, year);
84-
CheckStatusResponse status = schedule2Service.checkStatus(millId, year);
84+
Schedule2CheckStatusResponse status = schedule2Service.checkStatus(millId, year);
8585
// Resolve each message's verbatim bundle text (AD-8), same as the save/delete success message. The
8686
// service carries an optional field label in MessageInfo.text; when present it is prefixed as
8787
// "<label>: <resolvedText>" (legacy Schedule2MB:168 + Schedule 1 valueRequired parity).
@@ -93,6 +93,6 @@ public ResponseEntity<CheckStatusResponse> checkStatus(
9393
: new MessageInfo(base.key(), m.text() + ": " + base.text());
9494
})
9595
.toList();
96-
return ResponseEntity.ok(new CheckStatusResponse(status.outcome(), resolved));
96+
return ResponseEntity.ok(new Schedule2CheckStatusResponse(status.outcome(), resolved));
9797
}
9898
}

‎backend/src/main/java/ca/bc/gov/nrs/ilcr/schedule2/Schedule2Service.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
import ca.bc.gov.nrs.ilcr.schedule1.dto.Schedule1Response;
1010
import ca.bc.gov.nrs.ilcr.schedule2.Schedule2Repository.DetailRow;
1111
import ca.bc.gov.nrs.ilcr.schedule2.Schedule2Repository.SummaryRow;
12-
import ca.bc.gov.nrs.ilcr.schedule2.dto.CheckStatusResponse;
12+
import ca.bc.gov.nrs.ilcr.schedule2.dto.Schedule2CheckStatusResponse;
1313
import ca.bc.gov.nrs.ilcr.schedule2.dto.CostBlock;
1414
import ca.bc.gov.nrs.ilcr.schedule2.dto.Schedule2Request;
1515
import ca.bc.gov.nrs.ilcr.schedule2.dto.Schedule2Response;
@@ -386,7 +386,7 @@ public Schedule2Response getSchedule2(long millId, int year, boolean callerMayEd
386386
* @return the outcome + one message key (text resolved by the controller)
387387
*/
388388
@Transactional(readOnly = true)
389-
public CheckStatusResponse checkStatus(long millId, int year) {
389+
public Schedule2CheckStatusResponse checkStatus(long millId, int year) {
390390
// callerMayEdit is irrelevant to BR-07 (only the item-25 cost matters); pass false.
391391
Schedule2Response document = getSchedule2(millId, year, false);
392392
boolean met = document.purchasedLogCost().cost() != null;
@@ -396,7 +396,7 @@ public CheckStatusResponse checkStatus(long millId, int year) {
396396
// resolved bundle text ("<label>: Value Required"), mirroring legacy Schedule2MB:168 + Schedule 1
397397
// (Schedule1Service.valueRequired). The MET message needs no label prefix.
398398
String labelPrefix = met ? null : LABEL_PURCHASED_LOG_COST;
399-
return new CheckStatusResponse(outcome, List.of(new MessageInfo(key, labelPrefix)));
399+
return new Schedule2CheckStatusResponse(outcome, List.of(new MessageInfo(key, labelPrefix)));
400400
}
401401

402402
// -------------------------------------------------------------------------------------------------

‎backend/src/main/java/ca/bc/gov/nrs/ilcr/schedule2/api/Schedule2Api.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
package ca.bc.gov.nrs.ilcr.schedule2.api;
22

33
import ca.bc.gov.nrs.ilcr.schedule1.dto.MessageResponse;
4-
import ca.bc.gov.nrs.ilcr.schedule2.dto.CheckStatusResponse;
4+
import ca.bc.gov.nrs.ilcr.schedule2.dto.Schedule2CheckStatusResponse;
55
import ca.bc.gov.nrs.ilcr.schedule2.dto.Schedule2Request;
66
import ca.bc.gov.nrs.ilcr.schedule2.dto.Schedule2Response;
77
import jakarta.validation.Valid;
@@ -83,9 +83,9 @@ ResponseEntity<MessageResponse> deleteSchedule2(
8383
* @param millId the mill id (required)
8484
* @param year the reporting year (required)
8585
* @param authentication the caller (authorized for VIEW_SCHEDULE)
86-
* @return 200 with the {@link CheckStatusResponse} (outcome + resolved message)
86+
* @return 200 with the {@link Schedule2CheckStatusResponse} (outcome + resolved message)
8787
*/
8888
@PostMapping("/check-status")
89-
ResponseEntity<CheckStatusResponse> checkStatus(
89+
ResponseEntity<Schedule2CheckStatusResponse> checkStatus(
9090
@RequestParam long millId, @RequestParam int year, Authentication authentication);
9191
}

backend/src/main/java/ca/bc/gov/nrs/ilcr/schedule2/dto/CheckStatusResponse.java renamed to backend/src/main/java/ca/bc/gov/nrs/ilcr/schedule2/dto/Schedule2CheckStatusResponse.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
* @param outcome {@code "MET"} or {@code "ISSUES"}
1515
* @param messages the user-facing message(s) for the outcome (key + resolved text)
1616
*/
17-
public record CheckStatusResponse(
17+
public record Schedule2CheckStatusResponse(
1818
String outcome,
1919
List<MessageInfo> messages) {
2020
}

‎backend/src/main/java/ca/bc/gov/nrs/ilcr/schedule3/Schedule3Controller.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
import ca.bc.gov.nrs.ilcr.millcontext.MillContextService;
44
import ca.bc.gov.nrs.ilcr.schedule3.api.Schedule3Api;
5-
import ca.bc.gov.nrs.ilcr.schedule3.dto.CheckStatusResponse;
5+
import ca.bc.gov.nrs.ilcr.schedule3.dto.Schedule3CheckStatusResponse;
66
import ca.bc.gov.nrs.ilcr.schedule3.dto.MessageInfo;
77
import ca.bc.gov.nrs.ilcr.schedule3.dto.MessageResponse;
88
import ca.bc.gov.nrs.ilcr.schedule3.dto.Schedule3Request;
@@ -83,7 +83,7 @@ public ResponseEntity<MessageResponse> deleteSchedule3(
8383

8484
@Override
8585
@PreAuthorize("@permissions.hasPermission(authentication, 'VIEW_SCHEDULE')")
86-
public ResponseEntity<CheckStatusResponse> checkStatus(
86+
public ResponseEntity<Schedule3CheckStatusResponse> checkStatus(
8787
long millId, int year, Authentication authentication) {
8888
millContextService.validateScheduleViewable(millId, year, SCHEDULE_3_CATEGORY);
8989
return ResponseEntity.ok(schedule3Service.checkSchedule3Status(millId, year));

‎backend/src/main/java/ca/bc/gov/nrs/ilcr/schedule3/Schedule3Service.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
import ca.bc.gov.nrs.ilcr.schedule3.Schedule3Repository.DetailRow;
1111
import ca.bc.gov.nrs.ilcr.schedule3.Schedule3Repository.SubPageRow;
1212
import ca.bc.gov.nrs.ilcr.schedule3.Schedule3Repository.SummaryRow;
13-
import ca.bc.gov.nrs.ilcr.schedule3.dto.CheckStatusResponse;
13+
import ca.bc.gov.nrs.ilcr.schedule3.dto.Schedule3CheckStatusResponse;
1414
import ca.bc.gov.nrs.ilcr.schedule3.dto.CostLine;
1515
import ca.bc.gov.nrs.ilcr.schedule3.dto.MessageInfo;
1616
import ca.bc.gov.nrs.ilcr.schedule3.dto.OtherAcceptableDocument;
@@ -742,7 +742,7 @@ private Integer firstCost(int summaryId, int costItemCode) {
742742
* {@code Schedule3CheckStatus.isHarvestCostGreaterThanPopCost}). Verbatim labels/messages, legacy
743743
* field order (AD-8).
744744
*/
745-
public CheckStatusResponse checkSchedule3Status(long millId, int year) {
745+
public Schedule3CheckStatusResponse checkSchedule3Status(long millId, int year) {
746746
SummaryRow summary = repository.findSummary(millId, year)
747747
.orElseThrow(ScheduleNotFoundException::new);
748748
List<DetailRow> details = repository.findDetails(summary.summaryId());
@@ -771,7 +771,7 @@ public CheckStatusResponse checkSchedule3Status(long millId, int year) {
771771
MessageInfo message = requirementsMet
772772
? new MessageInfo(MSG_REQUIREMENTS_MET, resolveText(MSG_REQUIREMENTS_MET))
773773
: null;
774-
return new CheckStatusResponse(requirementsMet, errors, List.of(), message);
774+
return new Schedule3CheckStatusResponse(requirementsMet, errors, List.of(), message);
775775
}
776776

777777
/**

0 commit comments

Comments
 (0)