Revisions made to the Model Loader to use Babel

[aai/model-loader.git] / src / main / java / org / onap / aai / modelloader / entity / model / IModelArtifact.java

diff --git a/src/main/java/org/onap/aai/modelloader/entity/model/IModelArtifact.java b/src/main/java/org/onap/aai/modelloader/entity/model/IModelArtifact.java
new file mode 100644 (file)
index 0000000..5978b99
--- /dev/null
+++ b/src/main/java/org/onap/aai/modelloader/entity/model/IModelArtifact.java
@@ -0,0 +1,51 @@
+/**
+ * ============LICENSE_START==========================================
+ * org.onap.aai
+ * ===================================================================
+ * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved.
+ * Copyright © 2017-2018 Amdocs
+ * ===================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END============================================
+ */
+
+package org.onap.aai.modelloader.entity.model;
+
+/**
+ * Defines methods for implementations of a Model Artifact.
+ */
+public interface IModelArtifact {
+
+    /**
+     * This method is responsible for adding the id of a dependent node to the model.
+     *
+     * The model will have a collection of dependent nodes that may or may not have contents.
+     *
+     * @param value id of a dependent node to be added to the model.
+     */
+    void addDependentModelId(String value);
+
+    /**
+     * This method sets the payload for the model.
+     *
+     * @param payload the actual payload for the model
+     */
+    void setPayload(String payload);
+
+    /**
+     * This methods sets the value of the namespace for the model.
+     *
+     * @param xmlns the namespace for the model
+     */
+    void setModelNamespace(String xmlns);
+}