neutron-spi/src/main/java/org/opendaylight/neutron/spi/INeutronCRUD.java

   1 /*
   2  * Copyright (c) 2015 Intel Corporation.  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.neutron.spi;
  10
  11 import java.util.List;
  12
  13 /**
  14  * This interface defines the methods for CRUD of NB neutron objects
  15  *
  16  */
  17
  18 public interface INeutronCRUD<T extends INeutronObject> {
  19     /**
  20      * Applications call this interface method to determine if a particular
  21      * Neutron object exists
  22      *
  23      * @param uuid
  24      *            UUID of the Neutron object
  25      * @return boolean
  26      */
  27
  28     boolean exists(String uuid);
  29
  30     /**
  31      * Applications call this interface method to return if a particular
  32      * Neutron object exists
  33      *
  34      * @param uuid
  35      *            UUID of the Neutron object
  36      * @return {@link org.opendaylight.neutron.spi.INeutronObject}
  37      *          OpenStack Neutron class
  38      */
  39
  40     T get(String uuid);
  41
  42     /**
  43      * Applications call this interface method to return all Neutron objects
  44      *
  45      * @return List of OpenStackNeutrons objects
  46      */
  47
  48     List<T> getAll();
  49
  50     /**
  51      * Applications call this interface method to add a Neutron object to the
  52      * concurrent map
  53      *
  54      * @param input
  55      *            OpenStackNeutron object
  56      * @return boolean on whether the object was added or not
  57      */
  58
  59     boolean add(T input);
  60
  61     /**
  62      * Applications call this interface method to remove a Neutron object to the
  63      * concurrent map
  64      *
  65      * @param uuid
  66      *            identifier for the neutron object
  67      * @return boolean on whether the object was removed or not
  68      */
  69
  70     boolean remove(String uuid);
  71
  72     /**
  73      * Applications call this interface method to edit a Neutron object
  74      *
  75      * @param uuid
  76      *            identifier of the neutron object
  77      * @param delta
  78      *            OpenStackNeutron object containing changes to apply
  79      * @return boolean on whether the object was updated or not
  80      */
  81
  82     boolean update(String uuid, T delta);
  83
  84     /**
  85      * Applications call this interface method to determine if a Neutron object
  86      * is use
  87      *
  88      * @param uuid
  89      *            identifier of the neutron object
  90      *
  91      * @return boolean on whether the neutron is in use or not
  92      */
  93
  94     boolean inUse(String uuid);
  95 }