Initial commit for AAI-UI(sparky-backend)

[aai/sparky-be.git] / src / main / java / org / openecomp / sparky / viewandinspect / entity / SearchResponse.java

diff --git a/src/main/java/org/openecomp/sparky/viewandinspect/entity/SearchResponse.java b/src/main/java/org/openecomp/sparky/viewandinspect/entity/SearchResponse.java
new file mode 100644 (file)
index 0000000..8cc8d9b
--- /dev/null
+++ b/src/main/java/org/openecomp/sparky/viewandinspect/entity/SearchResponse.java
@@ -0,0 +1,93 @@
+/**
+ * ============LICENSE_START===================================================
+ * SPARKY (AAI UI service)
+ * ============================================================================
+ * Copyright © 2017 AT&T Intellectual Property.
+ * Copyright © 2017 Amdocs
+ * All rights reserved.
+ * ============================================================================
+ * 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.
+ * ============LICENSE_END=====================================================
+ *
+ * ECOMP and OpenECOMP are trademarks
+ * and service marks of AT&T Intellectual Property.
+ */
+
+package org.openecomp.sparky.viewandinspect.entity;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.openecomp.sparky.suggestivesearch.SuggestionEntity;
+
+/**
+ * The Class SearchResponse.
+ */
+public class SearchResponse {
+  
+  private long processingTimeInMs;
+  private int totalFound;
+
+  private List<SuggestionEntity> suggestions;
+
+  /**
+   * Instantiates a new search response.
+   */
+  public SearchResponse() {
+    this.suggestions = new ArrayList<SuggestionEntity>();
+    this.processingTimeInMs = 0;
+    this.totalFound = 0;
+  }
+
+  public long getProcessingTimeInMs() {
+    return processingTimeInMs;
+  }
+
+  public void setProcessingTimeInMs(long processingTimeInMs) {
+    this.processingTimeInMs = processingTimeInMs;
+  }
+  
+  public int getTotalFound() {
+    return totalFound;
+  }
+  
+  public void setTotalFound(int totalFound) {
+    this.totalFound = totalFound;
+  }
+
+  public List<SuggestionEntity> getSuggestions() {
+    return suggestions;
+  }
+
+  public void setSuggestions(List<SuggestionEntity> suggestions) {
+    this.suggestions = suggestions;
+  }
+  /**
+   * Adds the entity entry.
+   *
+   * @param suggestionEntry that will be converted to JSON
+   */
+  public void addSuggestion(SuggestionEntity suggestionEntity){
+    suggestions.add(suggestionEntity);
+  }
+  
+  /**
+   * Increments the total number of hits for this SearchResponse by
+   *  the value passed in.
+   * 
+   * @param additionalCount - Count to increment the total found
+   */
+  public void addToTotalFound(int additionalCount) {
+    totalFound += additionalCount;
+  }
+}