Convert neutron service base classes to unix line delimiters.
[controller.git] / opendaylight / networkconfiguration / neutron / src / main / java / org / opendaylight / controller / networkconfig / neutron / INeutronRouterCRUD.java
1 /*
2  * Copyright IBM Corporation, 2013.  All rights reserved.
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6  * and is available at http://www.eclipse.org/legal/epl-v10.html
7  */
8
9 package org.opendaylight.controller.networkconfig.neutron;
10
11 import java.util.List;
12
13 /**
14  * This interface defines the methods for CRUD of NB Router objects
15  *
16  */
17
18 public interface INeutronRouterCRUD {
19     /**
20      * Applications call this interface method to determine if a particular
21      * Router object exists
22      *
23      * @param uuid
24      *            UUID of the Router object
25      * @return boolean
26      */
27
28     public boolean routerExists(String uuid);
29
30     /**
31      * Applications call this interface method to return if a particular
32      * Router object exists
33      *
34      * @param uuid
35      *            UUID of the Router object
36      * @return {@link org.opendaylight.controller.networkconfig.neutron.NeutronRouter.OpenStackRouters}
37      *          OpenStack Router class
38      */
39
40     public NeutronRouter getRouter(String uuid);
41
42     /**
43      * Applications call this interface method to return all Router objects
44      *
45      * @return List of OpenStackRouters objects
46      */
47
48     public List<NeutronRouter> getAllRouters();
49
50     /**
51      * Applications call this interface method to add a Router object to the
52      * concurrent map
53      *
54      * @param input
55      *            OpenStackRouter object
56      * @return boolean on whether the object was added or not
57      */
58
59     public boolean addRouter(NeutronRouter input);
60
61     /**
62      * Applications call this interface method to remove a Router object to the
63      * concurrent map
64      *
65      * @param uuid
66      *            identifier for the Router object
67      * @return boolean on whether the object was removed or not
68      */
69
70     public boolean removeRouter(String uuid);
71
72     /**
73      * Applications call this interface method to edit a Router object
74      *
75      * @param uuid
76      *            identifier of the Router object
77      * @param delta
78      *            OpenStackRouter object containing changes to apply
79      * @return boolean on whether the object was updated or not
80      */
81
82     public boolean updateRouter(String uuid, NeutronRouter delta);
83
84     /**
85      * Applications call this interface method to check if a router is in use
86      *
87      * @param uuid
88      *            identifier of the Router object
89      * @return boolean on whether the router is in use or not
90      */
91
92     public boolean routerInUse(String routerUUID);
93 }