FINERACT-2287: New command processing for search

fineract-core/src/main/java/org/apache/fineract/portfolio/search/data/SearchConditions.java

@@ -31,11 +31,13 @@ public class SearchConditions {
     private final Boolean shareSeach;
     private final Boolean clientIdentifierSearch;
     private Boolean exactMatch;
+    private final String hierarchy;
 
-    public SearchConditions(final String searchQueryParam, final String searchResource, Boolean exactMatch) {
+    public SearchConditions(final String searchQueryParam, final String searchResource, Boolean exactMatch, final String hierarchy) {
         this.searchQuery = searchQueryParam;
         this.searchResource = searchResource;
         this.exactMatch = exactMatch;
+        this.hierarchy = hierarchy;
         this.clientSearch = null == searchResource
                 || searchResource.toLowerCase().contains(SearchSupportedResources.CLIENTS.name().toLowerCase());
         this.groupSearch = null == searchResource
@@ -52,7 +54,7 @@ public SearchConditions(final String searchQueryParam, final String searchResour
 
     public SearchConditions(final String searchQueryParam, final String searchResource, final Boolean clientSearch,
             final Boolean groupSearch, final Boolean loanSeach, final Boolean savingSeach, final Boolean shareSeach,
-            final Boolean clientIdentifierSearch, Boolean exactMatch) {
+            final Boolean clientIdentifierSearch, Boolean exactMatch, final String hierarchy) {
         this.searchQuery = searchQueryParam;
         this.searchResource = searchResource;
         this.clientSearch = clientSearch;
@@ -62,6 +64,7 @@ public SearchConditions(final String searchQueryParam, final String searchResour
         this.shareSeach = shareSeach;
         this.clientIdentifierSearch = clientIdentifierSearch;
         this.exactMatch = exactMatch;
+        this.hierarchy = hierarchy;
     }
 
     public String getSearchQuery() {
@@ -100,4 +103,8 @@ public Boolean isClientIdentifierSearch() {
         return this.clientIdentifierSearch;
     }
 
+    public String getHierarchy() {
+        return this.hierarchy;
+    }
+
 }

fineract-provider/src/main/java/org/apache/fineract/portfolio/search/api/SearchApiResource.java

@@ -35,69 +35,79 @@
 import jakarta.ws.rs.QueryParam;
 import jakarta.ws.rs.core.MediaType;
 import java.util.List;
-import java.util.Set;
 import lombok.RequiredArgsConstructor;
-import org.apache.fineract.portfolio.search.SearchConstants.SearchResponseParameters;
-import org.apache.fineract.portfolio.search.data.AdHocQueryDataValidator;
-import org.apache.fineract.portfolio.search.data.AdHocQuerySearchConditions;
+import org.apache.fineract.portfolio.search.data.AdHocQuerySearchRequest;
 import org.apache.fineract.portfolio.search.data.AdHocSearchQueryData;
 import org.apache.fineract.portfolio.search.data.SearchConditions;
 import org.apache.fineract.portfolio.search.data.SearchData;
-import org.apache.fineract.portfolio.search.service.SearchReadPlatformService;
+import org.apache.fineract.portfolio.search.service.SearchReadService;
+import org.apache.fineract.useradministration.domain.AppUser;
+import org.springframework.security.core.context.SecurityContextHolder;
 import org.springframework.stereotype.Component;
 
 @Path("/v1/search")
 @Component
 @Tag(name = "Search API", description = "Search API allows to search scoped resources clients, loans and groups on specified fields.")
 @RequiredArgsConstructor
+@Consumes({ MediaType.APPLICATION_JSON })
+@Produces({ MediaType.APPLICATION_JSON })
 public class SearchApiResource {
 
-    private static final Set<String> SEARCH_RESPONSE_PARAMETERS = SearchResponseParameters.getAllValues();
-
-    private final SearchReadPlatformService searchReadPlatformService;
-    private final AdHocQueryDataValidator fromApiJsonDeserializer;
+    private final SearchReadService searchReadService;
 
     @GET
     @Path("/template")
-    @Consumes({ MediaType.APPLICATION_JSON })
-    @Produces({ MediaType.APPLICATION_JSON })
-    @Operation(summary = "Retrive Adhoc Search query template", description = "Mandatory Fields\n" + "\n" + "search?query=000000001\n")
+    @Operation(summary = "Retrive Adhoc Search query template", description = """
+            Mandatory Fields
+
+            search?query=000000001
+            """)
     public AdHocSearchQueryData retrieveAdHocSearchQueryTemplate() {
 
-        return this.searchReadPlatformService.retrieveAdHocQueryTemplate();
+        return searchReadService.retrieveAdHocQueryTemplate();
     }
 
     @GET
-    @Consumes({ MediaType.APPLICATION_JSON })
-    @Produces({ MediaType.APPLICATION_JSON })
-    @Operation(summary = "Search Resources", description = "Example Requests:\n" + "\n" + "search?query=000000001\n" + "\n" + "\n"
-            + "search?query=Petra&resource=clients,groups\n" + "\n" + "\n" + "search?query=Petra&resource=clients,groups&exactMatch=true")
+    @Operation(summary = "Search Resources", description = """
+            Example Requests:
+
+            search?query=000000001
+
+
+            search?query=Petra&resource=clients,groups
+
+
+            search?query=Petra&resource=clients,groups&exactMatch=true""")
     @ApiResponse(responseCode = "200", description = "OK", content = @Content(array = @ArraySchema(schema = @Schema(implementation = SearchApiResourceSwagger.GetSearchResponse.class))))
     public List<SearchData> searchData(@QueryParam("query") @Parameter(description = "query") final String query,
             @QueryParam("resource") @Parameter(description = "resource") final String resource,
             @DefaultValue("false") @QueryParam("exactMatch") @Parameter(description = "exactMatch") Boolean exactMatch) {
 
-        final SearchConditions searchConditions = new SearchConditions(query, resource, exactMatch);
+        final AppUser currentUser = (AppUser) SecurityContextHolder.getContext().getAuthentication().getPrincipal();
+        final String hierarchy = currentUser.getOffice().getHierarchy();
+        final SearchConditions searchConditions = new SearchConditions(query, resource, exactMatch, hierarchy);
 
-        return this.searchReadPlatformService.retriveMatchingData(searchConditions);
+        return searchReadService.retriveMatchingData(searchConditions);
     }
 
     @POST
     @Path("/advance")
-    @Consumes({ MediaType.APPLICATION_JSON })
-    @Produces({ MediaType.APPLICATION_JSON })
-    @Operation(summary = "Adhoc query search", description = "AdHocQuery search has more search options, it is a POST request, it uses request body to send search parameters\n"
-            + "\n" + "\n" + "Mandatory fields:" + "entities" + "\n" + "\n" + "Optional fields:"
-            + "loanStatus, loanProducts, offices, loanDateOption, loanFromDate, loanToDate, \n"
-            + "includeOutStandingAmountPercentage, outStandingAmountPercentageCondition, \n"
-            + "minOutStandingAmountPercentage and maxOutStandingAmountPercentage OR outStandingAmountPercentage, \n"
-            + "includeOutstandingAmount, outstandingAmountCondition, \n"
-            + "minOutstandingAmount and maxOutstandingAmount OR outstandingAmount")
-    @RequestBody(required = true, content = @Content(schema = @Schema(implementation = SearchApiResourceSwagger.PostAdhocQuerySearchRequest.class)))
-    public List<AdHocSearchQueryData> advancedSearch(final String json) {
+    @Operation(summary = "Adhoc query search", description = """
+            AdHocQuery search has more search options, it is a POST request, \
+            it uses request body to send search parameters
+
 
-        final AdHocQuerySearchConditions searchConditions = this.fromApiJsonDeserializer.retrieveSearchConditions(json);
+            Mandatory fields: entities
+
+            Optional fields: \
+            loanStatus, loanProducts, offices, loanDateOption, loanFromDate, loanToDate,
+            includeOutStandingAmountPercentage, outStandingAmountPercentageCondition,
+            minOutStandingAmountPercentage and maxOutStandingAmountPercentage OR outStandingAmountPercentage,
+            includeOutstandingAmount, outstandingAmountCondition,
+            minOutstandingAmount and maxOutstandingAmount OR outstandingAmount""")
+    @RequestBody(required = true, content = @Content(schema = @Schema(implementation = SearchApiResourceSwagger.PostAdhocQuerySearchRequest.class)))
+    public List<AdHocSearchQueryData> advancedSearch(final AdHocQuerySearchRequest request) {
 
-        return this.searchReadPlatformService.retrieveAdHocQueryMatchingData(searchConditions);
+        return searchReadService.retrieveAdHocQueryMatchingData(request);
     }
 }

fineract-provider/src/main/java/org/apache/fineract/portfolio/search/data/AdHocQuerySearchRequest.java

@@ -0,0 +1,55 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you 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.
+ */
+package org.apache.fineract.portfolio.search.data;
+
+import java.io.Serializable;
+import java.math.BigDecimal;
+import java.time.LocalDate;
+import java.util.List;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+@Data
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+public class AdHocQuerySearchRequest implements Serializable {
+
+    private String locale;
+    private String dateFormat;
+    private List<String> entities;
+    private List<String> loanStatus;
+    private List<Long> loanProducts;
+    private List<Long> offices;
+    private String loanDateOption;
+    private LocalDate loanFromDate;
+    private LocalDate loanToDate;
+    private Boolean includeOutStandingAmountPercentage;
+    private String outStandingAmountPercentageCondition;
+    private BigDecimal minOutStandingAmountPercentage;
+    private BigDecimal maxOutStandingAmountPercentage;
+    private BigDecimal outStandingAmountPercentage;
+    private Boolean includeOutstandingAmount;
+    private String outstandingAmountCondition;
+    private BigDecimal minOutstandingAmount;
+    private BigDecimal maxOutstandingAmount;
+    private BigDecimal outstandingAmount;
+}

fineract-provider/src/main/java/org/apache/fineract/portfolio/search/service/SearchReadPlatformService.java → fineract-provider/src/main/java/org/apache/fineract/portfolio/search/service/SearchReadService.java

@@ -19,16 +19,16 @@
 package org.apache.fineract.portfolio.search.service;
 
 import java.util.List;
-import org.apache.fineract.portfolio.search.data.AdHocQuerySearchConditions;
+import org.apache.fineract.portfolio.search.data.AdHocQuerySearchRequest;
 import org.apache.fineract.portfolio.search.data.AdHocSearchQueryData;
 import org.apache.fineract.portfolio.search.data.SearchConditions;
 import org.apache.fineract.portfolio.search.data.SearchData;
 
-public interface SearchReadPlatformService {
+public interface SearchReadService {
 
     List<SearchData> retriveMatchingData(SearchConditions searchConditions);
 
     AdHocSearchQueryData retrieveAdHocQueryTemplate();
 
-    List<AdHocSearchQueryData> retrieveAdHocQueryMatchingData(AdHocQuerySearchConditions searchConditions);
+    List<AdHocSearchQueryData> retrieveAdHocQueryMatchingData(AdHocQuerySearchRequest request);
 }