2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright © 2017 AT&T Intellectual Property. All rights reserved.
6 * ================================================================================
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 * ============LICENSE_END=========================================================
20 * ECOMP is a trademark and service mark of AT&T Intellectual Property.
23 package org.onap.aai.validation.edges;
28 * Verifies that a given raw edge rule contains all required fields.
31 public interface EdgeFieldsValidationModule {
34 * Verifies the given rule has all required fields.
35 * Implement to check for what you determine to be required.
36 * You may also throw an error on unexpected fields if you wish,
37 * whatever makes sense for your system.
39 * @param rule - Map<String, String> that will look something like this:
43 * "label": "tosca.relationships.network.BindsTo",
45 * "multiplicity": "ONE2ONE",
46 * "contains-other-v": "NONE",
47 * "delete-other-v": "NONE",
48 * "prevent-delete": "NONE",
50 * "description":"An edge comment"
52 * @return empty String if no errors found, or String with
53 * the appropriate error message
55 public String verifyFields(Map<String, String> rule);