Adding interfaces in documentation
[aai/sparky-be.git] / src / main / java / org / onap / aai / sparky / config / oxm / SearchableOxmEntityDescriptor.java
1 /**
2  * ============LICENSE_START=======================================================
3  * org.onap.aai
4  * ================================================================================
5  * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved.
6  * Copyright © 2017-2018 Amdocs
7  * ================================================================================
8  * Licensed under the Apache License, Version 2.0 (the "License");
9  * you may not use this file except in compliance with the License.
10  * You may obtain a copy of the License at
11  *
12  *       http://www.apache.org/licenses/LICENSE-2.0
13  *
14  * Unless required by applicable law or agreed to in writing, software
15  * distributed under the License is distributed on an "AS IS" BASIS,
16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17  * See the License for the specific language governing permissions and
18  * limitations under the License.
19  * ============LICENSE_END=========================================================
20  */
21 package org.onap.aai.sparky.config.oxm;
22
23 import java.util.List;
24
25 public class SearchableOxmEntityDescriptor extends OxmEntityDescriptor {
26
27   protected List<String> searchableAttributes;
28
29   public List<String> getSearchableAttributes() {
30     return searchableAttributes;
31   }
32
33   public void setSearchableAttributes(List<String> searchableAttributes) {
34     this.searchableAttributes = searchableAttributes;
35   }
36
37   public void addSearchableAttribute(String attributeName) {
38     searchableAttributes.add(attributeName);
39   }
40
41   /**
42    * Checks for searchable attributes.
43    *
44    * @return true, if successful
45    */
46   public boolean hasSearchableAttributes() {
47
48     if (this.searchableAttributes == null) {
49       return false;
50     }
51
52     if (this.searchableAttributes.size() > 0) {
53       return true;
54     }
55
56     return false;
57
58   }
59
60   @Override
61   public String toString() {
62     return "SearchableOxmEntityDescriptor ["
63         + (searchableAttributes != null ? "searchableAttributes=" + searchableAttributes + ", "
64             : "")
65         + (entityName != null ? "entityName=" + entityName + ", " : "")
66         + (primaryKeyAttributeNames != null ? "primaryKeyAttributeNames=" + primaryKeyAttributeNames
67             : "")
68         + "]";
69   }
70
71 }