2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved.
6 * Copyright © 2017-2018 European Software Marketing Ltd.
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
12 * http://www.apache.org/licenses/LICENSE-2.0
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=========================================================
21 package org.onap.aai.modelloader.entity.model;
24 * Defines methods for Model Id
26 public interface IModelId {
29 * This method is responsible for using the values in the supplied Pair to set the id of the model.
31 * The definition of what the relationship will be is defined by the implementation. Some model ids would have
32 * single key/value pairs, others would have a composite key.
34 * Where the id of the model is a composite key multiple calls to this method will be required to successfully set
35 * the relationship in order to meet the rules of {@link #defined}
37 * @param pair object representing a key and its value.
39 void setRelationship(Pair<String, String> pair);
42 * This method indicates whether the id of the model has been defined according to the rules of the specific model
45 * Usually defined means that all properties that make up the key have been set.
47 * @return boolean <code>true</code> if the id of the model has been defined otherwise <code>false</code>