Adding interfaces in documentation
[aai/sparky-be.git] / src / main / java / org / onap / aai / sparky / viewandinspect / entity / RelationshipDirectionality.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 package org.onap.aai.sparky.viewandinspect.entity;
22
23 /**
24  * This enumeration is intended to be used to help us discriminate neighbor relationships for the
25  * purpose of visualization and conceptualization to model in/out relationships between
26  * ActiveInventoryNodes.
27  * Possible visualization behaviors could be the following: - IN ( draw a line with 1 arrow ) - OUT
28  * ( draw a line with 1 arrow ) - BOTH ( draw a line with 2 arrows, or 2 lines with 1 arrow each ) -
29  * UNKNOWN ( draw a line with no arrows )
30  * The UNKNOWN case is what we have at the moment where we have a collection neighbors with no
31  * knowledge of relationship directionality.
32  * 
33  * @author davea
34  *
35  */
36 public enum RelationshipDirectionality {
37   IN, OUT, BOTH, UNKNOWN
38 }