DDCE-7698 Update declare the employee to exclude

Author: gastonracui

app/controllers/ExclusionListController.scala

@@ -19,16 +19,16 @@ package controllers
 import config.PbikAppConfig
 import connectors.PbikConnector
 import controllers.actions.{AuthAction, NoSessionCheckAction}
-import models._
+import models.*
 import models.auth.AuthenticatedRequest
 import models.form.MandatoryRadioButton
 import models.v1.IabdType.IabdType
-import models.v1.exclusion._
+import models.v1.exclusion.*
 import models.v1.trace.{TracePeopleByNinoRequest, TracePeopleByPersonalDetailsRequest, TracePersonResponse}
 import play.api.Logging
 import play.api.data.Form
 import play.api.i18n.{I18nSupport, Messages, MessagesApi}
-import play.api.mvc._
+import play.api.mvc.*
 import services.{BikListService, ExclusionService, SessionService}
 import uk.gov.hmrc.domain.EmpRef
 import uk.gov.hmrc.http.HeaderCarrier
@@ -37,10 +37,11 @@ import uk.gov.hmrc.play.bootstrap.controller.WithUnsafeDefaultFormBinding
 import uk.gov.hmrc.play.bootstrap.frontend.controller.FrontendController
 import uk.gov.hmrc.play.http.HeaderCarrierConverter
 import utils.Exceptions.InvalidBikTypeException
-import utils._
+import utils.*
 import views.html.ErrorPage
-import views.html.exclusion._
+import views.html.exclusion.*
 
+import java.lang.ProcessBuilder
 import javax.inject.{Inject, Singleton}
 import scala.concurrent.{ExecutionContext, Future}
 
@@ -65,6 +66,8 @@ class ExclusionListController @Inject() (
   ninoExclusionSearchFormView: NinoExclusionSearchForm,
   noNinoExclusionSearchFormView: NoNinoExclusionSearchForm,
   searchResultsView: SearchResults,
+  searchResultsMPBIKView: SearchResultsMPBIK,
+  declareEmployeeMPBIKView: DeclareEmployeeMPBIK,
   whatNextExclusionView: WhatNextExclusion,
   removalConfirmationView: RemovalConfirmation,
   whatNextRescindView: WhatNextRescind
@@ -433,7 +436,8 @@ class ExclusionListController @Inject() (
     (authenticate andThen noSessionCheck).async { implicit request =>
       if (exclusionsAllowed) {
         val futureResult = formType match {
-          case ControllersReferenceDataCodes.FORM_TYPE_NINO   => searchResultsByNino(isCurrentTaxYear, iabdType, formType)
+          case ControllersReferenceDataCodes.FORM_TYPE_NINO   =>
+            searchResultsByNino(isCurrentTaxYear, iabdType, formType)
           case ControllersReferenceDataCodes.FORM_TYPE_NONINO =>
             searchResultsByPersonalDetails(isCurrentTaxYear, iabdType, formType)
         }
@@ -478,10 +482,11 @@ class ExclusionListController @Inject() (
     iabdType: IabdType,
     currentExclusions: List[TracePersonResponse]
   )(implicit request: AuthenticatedRequest[?]): Result = {
+    val uniqueMatch: Int                               = 1
     val uniqueListOfMatches: List[TracePersonResponse] =
       exclusionService.searchResultsRemoveAlreadyExcluded(currentExclusions, listOfMatches)
     uniqueListOfMatches.size match {
-      case 0 =>
+      case 0       =>
         logger.warn("[ExclusionListController][searchResultsHandleValidResult] List of un-excluded matches is empty")
         val message = Messages("ExclusionSearch.Fail.Exists.P")
         if (listOfMatches.nonEmpty) {
@@ -511,17 +516,37 @@ class ExclusionListController @Inject() (
             )
           )
         }
-      case _ =>
-        Ok(
-          searchResultsView(
-            controllersReferenceData.yearRange,
-            isCurrentTaxYear,
-            iabdType,
-            uniqueListOfMatches,
-            formMappings.individualSelectionForm,
-            formType
+      case matches =>
+        if (mpbikToggle) {
+          if (matches == uniqueMatch) { // testing with n < 1
+            Redirect(
+              routes.ExclusionListController
+                .declareEmployeeToExclude(isCurrentTaxYear, iabdType)
+            )
+          } else {
+            Ok(
+              searchResultsMPBIKView(
+                controllersReferenceData.yearRange,
+                isCurrentTaxYear,
+                iabdType,
+                uniqueListOfMatches,
+                formMappings.individualSelectionForm,
+                formType
+              )
+            )
+          }
+        } else {
+          Ok(
+            searchResultsView(
+              controllersReferenceData.yearRange,
+              isCurrentTaxYear,
+              iabdType,
+              uniqueListOfMatches,
+              formMappings.individualSelectionForm,
+              formType
+            )
           )
-        )
+        }
     }
   }
 
@@ -533,29 +558,53 @@ class ExclusionListController @Inject() (
             .bindFromRequest()
             .fold(
               formWithErrors =>
-                Future.successful(
-                  BadRequest(
-                    searchResultsView(
-                      controllersReferenceData.yearRange,
-                      year,
-                      iabdType,
-                      session.get.listOfMatches.get.pbikExclusionList,
-                      formWithErrors,
-                      formType
+                if (mpbikToggle) {
+                  Future.successful(
+                    BadRequest(
+                      searchResultsMPBIKView(
+                        controllersReferenceData.yearRange,
+                        year,
+                        iabdType,
+                        session.get.listOfMatches.get.pbikExclusionList,
+                        formWithErrors,
+                        formType
+                      )
                     )
                   )
-                ),
+                } else {
+                  Future.successful(
+                    BadRequest(
+                      searchResultsView(
+                        controllersReferenceData.yearRange,
+                        year,
+                        iabdType,
+                        session.get.listOfMatches.get.pbikExclusionList,
+                        formWithErrors,
+                        formType
+                      )
+                    )
+                  )
+                },
               values => {
                 val individualsDetails: Option[TracePersonResponse] =
                   session.get.listOfMatches.get.pbikExclusionList
                     .find(person => person.nationalInsuranceNumber == values.nino)
-                validateRequest(year, iabdType).flatMap { _ =>
-                  commitExclusion(
-                    year,
-                    iabdType,
-                    session.get.listOfMatches.get.updatedEmployerOptimisticLock,
-                    individualsDetails
+                if (mpbikToggle && individualsDetails.isDefined) {
+                  Future.successful(
+                    Redirect(
+                      routes.ExclusionListController
+                        .declareEmployeeToExclude(year, iabdType)
+                    )
                   )
+                } else {
+                  validateRequest(year, iabdType).flatMap { _ =>
+                    commitExclusion(
+                      year,
+                      iabdType,
+                      session.get.listOfMatches.get.updatedEmployerOptimisticLock,
+                      individualsDetails
+                    )
+                  }
                 }
               }
             )
@@ -575,6 +624,22 @@ class ExclusionListController @Inject() (
       }
     }
 
+  def declareEmployeeToExclude(year: String, iabdType: IabdType): Action[AnyContent] =
+    (authenticate andThen noSessionCheck).async { implicit request =>
+      val resultFuture = for {
+        _       <- validateRequest(year, iabdType)
+        session <- sessionService.fetchPbikSession()
+      } yield Ok(
+        declareEmployeeMPBIKView(
+          controllersReferenceData.yearRange,
+          year,
+          iabdType,
+          session.get.listOfMatches.get.pbikExclusionList.head
+        )
+      )
+      controllersReferenceData.responseErrorHandler(resultFuture)
+    }
+
   def commitExclusion(
     year: String,
     iabdType: IabdType,

app/utils/FormMappings.scala

@@ -170,7 +170,7 @@ class FormMappings @Inject() (pbikAppConfig: PbikAppConfig, val messagesApi: Mes
         .verifying(
           Messages("error.incorrect.nino"),
           nino => cleanupNino(nino).isEmpty || cleanupNino(nino).matches(validNinoFormat)
-       )
+        )
     )((firstname, surname, nino) =>
       NinoForm(
         firstname.trim,

app/views/exclusion/DeclareEmployeeMPBIK.scala.html

@@ -0,0 +1,89 @@
+@*
+ * Copyright 2026 HM Revenue & Customs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *@
+
+@import utils.TaxDateUtils
+@import views.templatemodels.PageTitle
+
+@this(
+        govukLayoutWrapper: GovukLayoutWrapper,
+        govukWarningText: GovukWarningText,
+        formWithCSRF: FormWithCSRF,
+        taxDateUtils: TaxDateUtils
+)
+
+@(
+        taxYearRange: TaxYearRange,
+        year: String,
+        iabdType: IabdType,
+        employee: TracePersonResponse
+)(implicit request: AuthenticatedRequest[?], messages: Messages)
+
+@expenseOrBenefit = @{messages(s"BenefitInKind.label.${iabdType.id}")}
+@govukLayoutWrapper(PageTitle(messages("ExclusionSearchMPBIK.title.single"))) {
+
+    <h1 id="title" class="govuk-heading-xl">
+        <span class="govuk-caption-l">@messages("ExclusionSearchMPBIK.title.span.taxYear.cy0", s"${taxYearRange.cy}", s"${taxYearRange.cyplus1}")</span>
+        @messages("ExclusionSearchMPBIK.title.single")
+    </h1>
+
+    <h2 class="govuk-heading-m">@expenseOrBenefit</h2>
+
+    <p class="govuk-body">@messages("ExclusionImportantMPBIK.Reminder", expenseOrBenefit, taxDateUtils.getDisplayTodayDate())</p>
+
+    <div class="govuk-inset-text">
+        @messages("ExclusionSearchMPBIK.inset.text")
+    </div>
+
+    <dl class="govuk-summary-list">
+        <div class="govuk-summary-list__row">
+            <dt class="govuk-summary-list__key">@messages("ExclusionSearchMPBIK.field.employee.name")</dt>
+            <dd class="govuk-summary-list__value">@employee.fullName</dd>
+        </div>
+        <div class="govuk-summary-list__row">
+            <dt class="govuk-summary-list__key">@messages("ExclusionSearchMPBIK.field.employee.ni")</dt>
+            <dd class="govuk-summary-list__value">@employee.nationalInsuranceNumber</dd>
+        </div>
+        <div class="govuk-summary-list__row">
+            <dt class="govuk-summary-list__key">@messages("ExclusionSearchMPBIK.field.employee.payrollId")</dt>
+            <dd class="govuk-summary-list__value">@employee.getWorksPayrollNumber</dd>
+        </div>
+    </dl>
+
+    @govukWarningText(WarningText(
+        iconFallbackText = Some(messages("site.warning")),
+        content = Text(messages("ExclusionSearchMPBIK.warning"))
+    ))
+
+    <p id="i-confirm-that" class="govuk-body">
+        @messages("ExclusionSearchMPBIK.confirmation." + request.userType + ".p")
+    </p>
+    <ul class="govuk-list govuk-list--bullet">
+        <li>@messages("ExclusionSearchMPBIK.confirmation." + request.userType + ".bullet1")</li>
+        <li>@messages("ExclusionSearchMPBIK.confirmation." + request.userType + ".bullet2")</li>
+    </ul>
+
+    <p id="i-understand-that" class="govuk-body">
+        @messages("ExclusionSearchMPBIK.understanding." + request.userType + ".p")
+    </p>
+    <ul class="govuk-list govuk-list--bullet">
+        <li>@messages("ExclusionSearchMPBIK.understanding." + request.userType + ".bullet1")</li>
+    </ul>
+
+    <div class="govuk-form-group">
+        <a href="@routes.ExclusionListController.updateExclusions(year, iabdType)" class="govuk-button" role="button" id="button-confirm">@messages("Service.confirmAndContinue")</a>
+    </div>
+
+}

app/views/exclusion/SearchResultsMPBIK.scala.html

@@ -0,0 +1,87 @@
+@*
+ * Copyright 2026 HM Revenue & Customs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *@
+
+@import utils.TaxDateUtils
+@import views.templatemodels.PageTitle
+
+@this(
+        govukLayoutWrapper: GovukLayoutWrapper,
+        govukWarningText: GovukWarningText,
+        formWithCSRF: FormWithCSRF,
+        taxDateUtils: TaxDateUtils
+)
+
+@(
+        taxYearRange: TaxYearRange,
+        year: String,
+        iabdType: IabdType,
+        listOfMatches: List[TracePersonResponse],
+        listOfMatchesForm: Form[ExclusionNino],
+        formType: String
+)(implicit request: Request[?], messages: Messages)
+
+@govukLayoutWrapper(PageTitle(messages("ExclusionSearchMPBIK.title.multiple"), listOfMatchesForm.hasErrors)) {
+
+    @if(listOfMatchesForm("individualNino").hasErrors) {
+        <div class="govuk-error-summary" role="group" aria-labelledby="error-summary-heading-1" tabindex="-1">
+
+            <h2 class="govuk-error-summary__title" id="error-summary-heading-1">
+                @messages("Service.errorSummary.heading")
+            </h2>
+            <div class="govuk-error-summary__body">
+                <ul class="govuk-list govuk-error-summary__list">
+                    @if(listOfMatchesForm.error("individualNino").get.message.equals("error.required")){
+                    <li><a href="#employee-radio-0">@messages("error.exclusion.multi.selection")</a></li>
+                    }
+                </ul>
+            </div>
+        </div>
+    }
+
+    <h1 id="title" class="govuk-heading-xl">
+        <span class="govuk-caption-l">@messages("ExclusionSearchMPBIK.form.tax.year", s"${taxYearRange.cy}", s"${taxYearRange.cyplus1}")</span>
+        @messages("ExclusionSearchMPBIK.title.multiple")
+    </h1>
+
+    @formWithCSRF(action = routes.ExclusionListController.updateMultipleExclusions(year, iabdType, formType)) {
+        <div class="govuk-form-group @if(listOfMatchesForm("individualNino").hasErrors){govuk-form-group--error}">
+            <fieldset class="govuk-fieldset" @if(listOfMatchesForm("individualNino").hasErrors){aria-describedby="selection-error"}>
+                @if(listOfMatchesForm("individualNino").hasErrors) {
+                    <span id="selection-error" class="govuk-error-message">
+                        <span class="govuk-visually-hidden">@messages("Service.error"):</span>
+                        @messages("error.exclusion.multi.selection")
+                    </span>
+                }
+                <div class="govuk-radios">
+                @for(index <- 0 until listOfMatches.length) {
+                    <div class="govuk-radios__item">
+                        <input class="govuk-radios__input" id="employee-radio-@index" type="radio" aria-describedby="employee-hint-@index" name="individualNino" value='@listOfMatches(index).nationalInsuranceNumber'>
+                        <label class="govuk-label govuk-radios__label govuk-label--s" for="employee-radio-@index">
+                            @listOfMatches(index).fullName
+                        </label>
+                        <span id="employee-hint-@index" class="govuk-hint govuk-radios__hint">
+                            @messages("Service.field.nino"): @listOfMatches(index).nationalInsuranceNumber <br>
+                            @messages("Service.field.worksnumber"): @listOfMatches(index).getWorksPayrollNumber
+                        </span>
+                    </div>
+                }
+                </div>
+            </fieldset>
+        </div>
+
+        <input type="submit" class="govuk-button" role="button" id="button-continue" value="@messages("Service.continueMPBIK")">
+    }
+}