src/main/java/org/openecomp/sparky/viewandinspect/entity/SearchResponse.java

   1 /**
   2  * ============LICENSE_START===================================================
   3  * SPARKY (AAI UI service)
   4  * ============================================================================
   5  * Copyright © 2017 AT&T Intellectual Property.
   6  * Copyright © 2017 Amdocs
   7  * All rights reserved.
   8  * ============================================================================
   9  * Licensed under the Apache License, Version 2.0 (the "License");
  10  * you may not use this file except in compliance with the License.
  11  * You may obtain a copy of the License at
  12  *
  13  *      http://www.apache.org/licenses/LICENSE-2.0
  14  *
  15  * Unless required by applicable law or agreed to in writing, software
  16  * distributed under the License is distributed on an "AS IS" BASIS,
  17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  * See the License for the specific language governing permissions and
  19  * limitations under the License.
  20  * ============LICENSE_END=====================================================
  21  *
  22  * ECOMP and OpenECOMP are trademarks
  23  * and service marks of AT&T Intellectual Property.
  24  */
  25
  26 package org.openecomp.sparky.viewandinspect.entity;
  27
  28 import java.util.ArrayList;
  29 import java.util.List;
  30
  31 import org.openecomp.sparky.suggestivesearch.SuggestionEntity;
  32
  33 /**
  34  * The Class SearchResponse.
  35  */
  36 public class SearchResponse {
  37
  38   private long processingTimeInMs;
  39   private int totalFound;
  40
  41   private List<SuggestionEntity> suggestions;
  42
  43   /**
  44    * Instantiates a new search response.
  45    */
  46   public SearchResponse() {
  47     this.suggestions = new ArrayList<SuggestionEntity>();
  48     this.processingTimeInMs = 0;
  49     this.totalFound = 0;
  50   }
  51
  52   public long getProcessingTimeInMs() {
  53     return processingTimeInMs;
  54   }
  55
  56   public void setProcessingTimeInMs(long processingTimeInMs) {
  57     this.processingTimeInMs = processingTimeInMs;
  58   }
  59
  60   public int getTotalFound() {
  61     return totalFound;
  62   }
  63
  64   public void setTotalFound(int totalFound) {
  65     this.totalFound = totalFound;
  66   }
  67
  68   public List<SuggestionEntity> getSuggestions() {
  69     return suggestions;
  70   }
  71
  72   public void setSuggestions(List<SuggestionEntity> suggestions) {
  73     this.suggestions = suggestions;
  74   }
  75   /**
  76    * Adds the entity entry.
  77    *
  78    * @param suggestionEntry that will be converted to JSON
  79    */
  80   public void addSuggestion(SuggestionEntity suggestionEntity){
  81     suggestions.add(suggestionEntity);
  82   }
  83
  84   /**
  85    * Increments the total number of hits for this SearchResponse by
  86    *  the value passed in.
  87    *
  88    * @param additionalCount - Count to increment the total found
  89    */
  90   public void addToTotalFound(int additionalCount) {
  91     totalFound += additionalCount;
  92   }
  93 }