2 * Copyright IBM Corporation, 2013. All rights reserved.
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
9 package org.opendaylight.controller.networkconfig.neutron;
11 import java.util.List;
14 * This interface defines the methods for CRUD of NB Router objects
18 public interface INeutronRouterCRUD {
20 * Applications call this interface method to determine if a particular
21 * Router object exists
24 * UUID of the Router object
28 public boolean routerExists(String uuid);
31 * Applications call this interface method to return if a particular
32 * Router object exists
35 * UUID of the Router object
36 * @return {@link org.opendaylight.controller.networkconfig.neutron.NeutronRouter.OpenStackRouters}
37 * OpenStack Router class
40 public NeutronRouter getRouter(String uuid);
43 * Applications call this interface method to return all Router objects
45 * @return List of OpenStackRouters objects
48 public List<NeutronRouter> getAllRouters();
51 * Applications call this interface method to add a Router object to the
55 * OpenStackRouter object
56 * @return boolean on whether the object was added or not
59 public boolean addRouter(NeutronRouter input);
62 * Applications call this interface method to remove a Router object to the
66 * identifier for the Router object
67 * @return boolean on whether the object was removed or not
70 public boolean removeRouter(String uuid);
73 * Applications call this interface method to edit a Router object
76 * identifier of the Router object
78 * OpenStackRouter object containing changes to apply
79 * @return boolean on whether the object was updated or not
82 public boolean updateRouter(String uuid, NeutronRouter delta);
85 * Applications call this interface method to check if a router is in use
88 * identifier of the Router object
89 * @return boolean on whether the router is in use or not
92 public boolean routerInUse(String routerUUID);