src/main/java/org/onap/aai/modelloader/entity/model/IModelArtifact.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 implementations of a Model Artifact.
  26  */
  27 public interface IModelArtifact {
  28
  29     /**
  30      * This method is responsible for adding the id of a dependent node to the model.
  31      *
  32      * The model will have a collection of dependent nodes that may or may not have contents.
  33      *
  34      * @param value id of a dependent node to be added to the model.
  35      */
  36     void addDependentModelId(String value);
  37
  38     /**
  39      * This method sets the payload for the model.
  40      *
  41      * @param payload the actual payload for the model
  42      */
  43     void setPayload(String payload);
  44
  45     /**
  46      * This methods sets the value of the namespace for the model.
  47      *
  48      * @param xmlns the namespace for the model
  49      */
  50     void setModelNamespace(String xmlns);
  51 }