Bump upstreams for Silicon
[neutron.git] / neutron-spi / src / main / java / org / opendaylight / neutron / spi / INeutronLoadBalancerPoolCRUD.java
index bbaf8d33ea441298f645e94471cbdfe257448e6b..bc51540fa6c2457bed9df8dc010ea945cb2cc134 100644 (file)
  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
  * and is available at http://www.eclipse.org/legal/epl-v10.html
  */
-
 package org.opendaylight.neutron.spi;
 
 import java.util.List;
+import org.opendaylight.mdsal.common.api.ReadFailedException;
+import org.opendaylight.yangtools.yang.common.OperationFailedException;
 
 /**
- * This interface defines the methods for CRUD of NB OpenStack LoadBalancerPool objects
- *
+ * This interface defines the methods for CRUD of NB OpenStack LoadBalancerPool objects.
  */
-
-public interface INeutronLoadBalancerPoolCRUD
-    extends INeutronCRUD<NeutronLoadBalancerPool> {
-    /**
-     * Applications call this interface method to determine if a particular
-     *LoadBalancerPool object exists
-     *
-     * @param uuid
-     *            UUID of the LoadBalancerPool object
-     * @return boolean
-     */
-
-    boolean neutronLoadBalancerPoolExists(String uuid);
-
-    /**
-     * Applications call this interface method to return if a particular
-     * LoadBalancerPool object exists
-     *
-     * @param uuid
-     *            UUID of the LoadBalancerPool object
-     * @return {@link NeutronLoadBalancerPool}
-     *          OpenStackLoadBalancerPool class
-     */
-
-    NeutronLoadBalancerPool getNeutronLoadBalancerPool(String uuid);
-
-    /**
-     * Applications call this interface method to return all LoadBalancerPool objects
-     *
-     * @return List of OpenStackNetworks objects
-     */
-
-    List<NeutronLoadBalancerPool> getAllNeutronLoadBalancerPools();
-
-    /**
-     * Applications call this interface method to add a LoadBalancerPool object to the
-     * concurrent map
-     *
-     * @param input
-     *            OpenStackNetwork object
-     * @return boolean on whether the object was added or not
-     */
-
-    boolean addNeutronLoadBalancerPool(NeutronLoadBalancerPool input);
-
-    /**
-     * Applications call this interface method to remove a Neutron LoadBalancerPool object to the
-     * concurrent map
-     *
-     * @param uuid
-     *            identifier for the LoadBalancerPool object
-     * @return boolean on whether the object was removed or not
-     */
-
-    boolean removeNeutronLoadBalancerPool(String uuid);
-
-    /**
-     * Applications call this interface method to edit a LoadBalancerPool object
-     *
-     * @param uuid
-     *            identifier of the LoadBalancerPool object
-     * @param delta
-     *            OpenStackLoadBalancerPool object containing changes to apply
-     * @return boolean on whether the object was updated or not
-     */
-
-    boolean updateNeutronLoadBalancerPool(String uuid, NeutronLoadBalancerPool delta);
-
-    /**
-     * Applications call this interface method to see if a MAC address is in use
-     *
-     * @param uuid
-     *            identifier of the LoadBalancerPool object
-     * @return boolean on whether the macAddress is already associated with a
-     * port or not
-     */
-
-    boolean neutronLoadBalancerPoolInUse(String uuid);
+public interface INeutronLoadBalancerPoolCRUD extends INeutronCRUD<NeutronLoadBalancerPool> {
 
     /**
      * Applications call this interface method to determine if a particular
-     *NeutronLoadBalancerPoolMember object exists
+     * NeutronLoadBalancerPoolMember object exists.
      *
      * @param poolUuid
      *            UUID of the NeutronLoadBalancerPool object
      * @param uuid
      *            UUID of the NeutronLoadBalancerPoolMember object
      * @return boolean
+     * @throws ReadFailedException if the read failed
      */
-
-    boolean neutronLoadBalancerPoolMemberExists(String poolUuid, String uuid);
+    boolean neutronLoadBalancerPoolMemberExists(String poolUuid, String uuid) throws ReadFailedException;
 
     /**
      * Applications call this interface method to return if a particular
-     * NeutronLoadBalancerPoolMember object exists
+     * NeutronLoadBalancerPoolMember object exists.
      *
      * @param poolUuid
      *            UUID of the NeutronLoadBalancerPool object
@@ -116,48 +39,51 @@ public interface INeutronLoadBalancerPoolCRUD
      *            UUID of the NeutronLoadBalancerPoolMember object
      * @return {@link org.opendaylight.neutron.spi.NeutronLoadBalancerPoolMember}
      *          OpenStackNeutronLoadBalancerPoolMember class
+     * @throws ReadFailedException if the read failed
      */
-
-    NeutronLoadBalancerPoolMember getNeutronLoadBalancerPoolMember(String poolUuid, String uuid);
+    NeutronLoadBalancerPoolMember getNeutronLoadBalancerPoolMember(String poolUuid, String uuid)
+            throws ReadFailedException;
 
     /**
-     * Applications call this interface method to return all NeutronLoadBalancerPoolMember objects
+     * Applications call this interface method to return all NeutronLoadBalancerPoolMember objects.
      *
      * @param poolUuid
      *            UUID of the NeutronLoadBalancerPool object
      * @return List of OpenStackNetworks objects
+     * @throws ReadFailedException if the read failed
      */
-
-    List<NeutronLoadBalancerPoolMember> getAllNeutronLoadBalancerPoolMembers(String poolUuid);
+    List<NeutronLoadBalancerPoolMember> getAllNeutronLoadBalancerPoolMembers(String poolUuid)
+            throws ReadFailedException;
 
     /**
      * Applications call this interface method to add a NeutronLoadBalancerPoolMember object to the
-     * concurrent map
+     * concurrent map.
      *
      * @param poolUuid
      *            UUID of the NeutronLoadBalancerPool object
      * @param input
      *            OpenStackNetwork object
      * @return boolean on whether the object was added or not
+     * @throws OperationFailedException if the read or write failed
      */
-
-    boolean addNeutronLoadBalancerPoolMember(String poolUuid, NeutronLoadBalancerPoolMember input);
+    boolean addNeutronLoadBalancerPoolMember(String poolUuid, NeutronLoadBalancerPoolMember input)
+            throws OperationFailedException;
 
     /**
      * Applications call this interface method to remove a Neutron NeutronLoadBalancerPoolMember object to the
-     * concurrent map
+     * concurrent map.
      *
      * @param poolUuid
      *            UUID of the NeutronLoadBalancerPool object
      * @param uuid
      *            identifier for the NeutronLoadBalancerPoolMember object
      * @return boolean on whether the object was removed or not
+     * @throws OperationFailedException if the read or write failed
      */
-
-    boolean removeNeutronLoadBalancerPoolMember(String poolUuid, String uuid);
+    boolean removeNeutronLoadBalancerPoolMember(String poolUuid, String uuid) throws OperationFailedException;
 
     /**
-     * Applications call this interface method to edit a NeutronLoadBalancerPoolMember object
+     * Applications call this interface method to edit a NeutronLoadBalancerPoolMember object.
      *
      * @param poolUuid
      *            identifier of the NeutronLoadBalancerPool object
@@ -166,20 +92,21 @@ public interface INeutronLoadBalancerPoolCRUD
      * @param delta
      *            OpenStackNeutronLoadBalancerPoolMember object containing changes to apply
      * @return boolean on whether the object was updated or not
+     * @throws OperationFailedException if the read or write operation failed
      */
-
-    boolean updateNeutronLoadBalancerPoolMember(String poolUuid, String uuid, NeutronLoadBalancerPoolMember delta);
+    boolean updateNeutronLoadBalancerPoolMember(String poolUuid, String uuid, NeutronLoadBalancerPoolMember delta)
+            throws OperationFailedException;
 
     /**
-     * Applications call this interface method to see if a MAC address is in use
+     * Applications call this interface method to see if a MAC address is in use.
      *
      * @param poolUuid
      *            identifier of the NeutronLoadBalancerPool object
      * @param uuid
      *            identifier of the NeutronLoadBalancerPoolMember object
      * @return boolean on whether the macAddress is already associated with a
-     * port or not
+     *             port or not
+     * @throws ReadFailedException if the read operation failed
      */
-
-    boolean neutronLoadBalancerPoolMemberInUse(String poolUuid, String uuid);
+    boolean neutronLoadBalancerPoolMemberInUse(String poolUuid, String uuid) throws ReadFailedException;
 }