Adding interfaces in documentation
[aai/sparky-be.git] / sparkybe-onap-service / src / main / java / org / onap / aai / sparky / search / filters / entity / UiFilterValueEntity.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 package org.onap.aai.sparky.search.filters.entity;
26
27 import com.fasterxml.jackson.annotation.JsonInclude;
28 import com.fasterxml.jackson.annotation.JsonInclude.Include;
29
30 /**
31  * This class represents a single item or value to populate the FE filter component with.
32  * A drop-down list, for example, may be populated with the values from several instances of this class.
33  */
34 @JsonInclude(Include.NON_NULL)
35 public class UiFilterValueEntity {
36   private String filterId;
37   private String filterValue;
38   private String displayName; // The string that will be rendered in the view
39
40   public UiFilterValueEntity() {}
41
42   public UiFilterValueEntity(String filterId, String filterValue, String displayName) {
43     this.filterId = filterId;
44     this.filterValue = filterValue;
45     this.displayName = displayName;
46   }
47
48   public String getFilterId() {
49     return filterId;
50   }
51
52   public String getFilterValue() {
53     return filterValue;
54   }
55
56   public String getDisplayName() {
57     return displayName;
58   }
59
60   public void setFilterId(String filterId) {
61     this.filterId = filterId;
62   }
63
64   public void setFilterValue(String filterValue) {
65     this.filterValue = filterValue;
66   }
67
68   public void setDisplayName(String displayName) {
69     this.displayName = displayName;
70   }
71
72   @Override
73   public String toString() {
74     return "UiFilterValueEntity [" + (filterId != null ? "filterId=" + filterId + ", " : "")
75         + (filterValue != null ? "filterValue=" + filterValue + ", " : "")
76         + (displayName != null ? "displayName=" + displayName : "") + "]";
77   }
78   
79   
80 }