Simon Hunt | f679c4e | 2016-04-01 17:02:24 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | 5ab426f | 2016-04-09 01:19:45 -0700 | [diff] [blame] | 2 | * Copyright 2016-present Open Networking Laboratory |
Simon Hunt | f679c4e | 2016-04-01 17:02:24 -0700 | [diff] [blame] | 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | package org.onosproject.ui; |
| 17 | |
| 18 | import org.onosproject.ui.model.topo.UiTopoLayout; |
Thomas Vachuska | 4d66d0a | 2016-04-15 15:48:13 -0700 | [diff] [blame] | 19 | import org.onosproject.ui.model.topo.UiTopoLayoutId; |
Simon Hunt | f679c4e | 2016-04-01 17:02:24 -0700 | [diff] [blame] | 20 | |
Thomas Vachuska | 4d66d0a | 2016-04-15 15:48:13 -0700 | [diff] [blame] | 21 | import java.util.Set; |
Simon Hunt | f679c4e | 2016-04-01 17:02:24 -0700 | [diff] [blame] | 22 | |
| 23 | /** |
| 24 | * Service for managing {@link UiTopoLayout} instances. |
| 25 | */ |
| 26 | public interface UiTopoLayoutService { |
| 27 | |
| 28 | /** |
Thomas Vachuska | 92b016b | 2016-05-20 11:37:57 -0700 | [diff] [blame^] | 29 | * Returns the top-level root layout, which always exists and cannot |
| 30 | * be removed or associated directly with a region. |
| 31 | * |
| 32 | * @return root topology layout |
| 33 | */ |
| 34 | UiTopoLayout getRootLayout(); |
| 35 | |
| 36 | /** |
Thomas Vachuska | 4d66d0a | 2016-04-15 15:48:13 -0700 | [diff] [blame] | 37 | * Returns the set of available layouts. |
Simon Hunt | f679c4e | 2016-04-01 17:02:24 -0700 | [diff] [blame] | 38 | * |
Thomas Vachuska | 4d66d0a | 2016-04-15 15:48:13 -0700 | [diff] [blame] | 39 | * @return set of available layouts |
Simon Hunt | f679c4e | 2016-04-01 17:02:24 -0700 | [diff] [blame] | 40 | */ |
Thomas Vachuska | 4d66d0a | 2016-04-15 15:48:13 -0700 | [diff] [blame] | 41 | Set<UiTopoLayout> getLayouts(); |
Simon Hunt | f679c4e | 2016-04-01 17:02:24 -0700 | [diff] [blame] | 42 | |
| 43 | /** |
Thomas Vachuska | 4d66d0a | 2016-04-15 15:48:13 -0700 | [diff] [blame] | 44 | * Adds a layout to the system or updates an existing one. |
Simon Hunt | f679c4e | 2016-04-01 17:02:24 -0700 | [diff] [blame] | 45 | * |
Thomas Vachuska | 4d66d0a | 2016-04-15 15:48:13 -0700 | [diff] [blame] | 46 | * @param layout the layout to add or update |
Simon Hunt | f679c4e | 2016-04-01 17:02:24 -0700 | [diff] [blame] | 47 | * @return an indication of success |
| 48 | */ |
| 49 | boolean addLayout(UiTopoLayout layout); |
| 50 | |
Thomas Vachuska | 4d66d0a | 2016-04-15 15:48:13 -0700 | [diff] [blame] | 51 | /** |
| 52 | * Returns the layout with the specified identifier. |
Thomas Vachuska | 92b016b | 2016-05-20 11:37:57 -0700 | [diff] [blame^] | 53 | * |
Thomas Vachuska | 4d66d0a | 2016-04-15 15:48:13 -0700 | [diff] [blame] | 54 | * @param layoutId layout identifier |
| 55 | * @return layout or null if no such layout is found |
| 56 | */ |
| 57 | UiTopoLayout getLayout(UiTopoLayoutId layoutId); |
| 58 | |
Simon Hunt | f679c4e | 2016-04-01 17:02:24 -0700 | [diff] [blame] | 59 | /** |
Thomas Vachuska | 92b016b | 2016-05-20 11:37:57 -0700 | [diff] [blame^] | 60 | * Returns the set of the child layouts of the specified layout. |
| 61 | * |
| 62 | * @param layoutId layout identifier |
| 63 | * @return set of child layouts; empty set if layout has no children |
| 64 | */ |
| 65 | Set<UiTopoLayout> getChildren(UiTopoLayoutId layoutId); |
| 66 | |
| 67 | /** |
Simon Hunt | f679c4e | 2016-04-01 17:02:24 -0700 | [diff] [blame] | 68 | * Removes a layout from the system. |
| 69 | * |
| 70 | * @param layout the layout to remove |
| 71 | * @return an indication of success |
| 72 | */ |
| 73 | boolean removeLayout(UiTopoLayout layout); |
| 74 | |
| 75 | } |