src/main/java/org/onap/aai/modelloader/entity/model/IModelId.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
  22 package org.onap.aai.modelloader.entity.model;
  23
  24 /**
  25  * Defines methods for c
  26  */
  27 public interface IModelId {
  28
  29     /**
  30      * This method is responsible for using the values in the supplied Pair to set the id of the model.
  31      *
  32      * The definition of what the relationship will be is defined by the implementation.  Some model ids would have
  33      * single key/value pairs, others would have a composite key.
  34      *
  35      * Where the id of the model is a composite key multiple calls to this method will be required to successfully set
  36      * the relationship in order to meet the rules of {@link #defined}
  37      *
  38      * @param pair object representing a key and its value.
  39      */
  40     void setRelationship(Pair<String, String> pair);
  41
  42     /**
  43      * This method indicates whether the id of the model has been defined according to the rules of the specific model
  44      * implemented.
  45      *
  46      * Usually defined means that all properties that make up the key have been set.
  47      *
  48      * @return boolean <code>true</code> if the id of the model has been defined otherwise <code>false</code>
  49      */
  50     boolean defined();
  51 }