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

   1 /*
   2  * Copyright (c) 2015 IBM Corporation and others.  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 public interface INeutronVPNIPSECPolicyCRUD
  14     extends INeutronCRUD<NeutronVPNIPSECPolicy> {
  15
  16     /**yes
  17      * Applications call this interface method to determine if a particular
  18      *NeutronVPNIPSECPolicy object exists
  19      *
  20      * @param uuid
  21      *            UUID of the NeutronVPNIPSECPolicy object
  22      * @return boolean
  23      */
  24
  25     boolean neutronVPNIPSECPolicyExists(String uuid);
  26
  27     /**
  28      * Applications call this interface method to return if a particular
  29      * NeutronVPNIPSECPolicy object exists
  30      *
  31      * @param uuid
  32      *            UUID of the NeutronVPNIPSECPolicy object
  33      * @return {@link org.opendaylight.neutron.spi.NeutronVPNIPSECPolicy}
  34      *          OpenStackNeutronVPNIPSECPolicy class
  35      */
  36
  37     NeutronVPNIPSECPolicy getNeutronVPNIPSECPolicy(String uuid);
  38
  39     /**
  40      * Applications call this interface method to return all NeutronVPNIPSECPolicy objects
  41      *
  42      * @return List of OpenStackNetworks objects
  43      */
  44
  45     List<NeutronVPNIPSECPolicy> getAllNeutronVPNIPSECPolicies();
  46
  47     /**
  48      * Applications call this interface method to add a NeutronVPNIPSECPolicy object to the
  49      * concurrent map
  50      *
  51      * @param input
  52      *            OpenStackNetwork object
  53      * @return boolean on whether the object was added or not
  54      */
  55
  56     boolean addNeutronVPNIPSECPolicy(NeutronVPNIPSECPolicy input);
  57
  58     /**
  59      * Applications call this interface method to remove a Neutron NeutronVPNIPSECPolicy object to the
  60      * concurrent map
  61      *
  62      * @param uuid
  63      *            identifier for the NeutronVPNIPSECPolicy object
  64      * @return boolean on whether the object was removed or not
  65      */
  66
  67     boolean removeNeutronVPNIPSECPolicy(String uuid);
  68
  69     /**
  70      * Applications call this interface method to edit a NeutronVPNIPSECPolicy object
  71      *
  72      * @param uuid
  73      *            identifier of the NeutronVPNIPSECPolicy object
  74      * @param delta
  75      *            OpenStackNeutronVPNIPSECPolicy object containing changes to apply
  76      * @return boolean on whether the object was updated or not
  77      */
  78
  79     boolean updateNeutronVPNIPSECPolicy(String uuid, NeutronVPNIPSECPolicy delta);
  80
  81     /**
  82      * Applications call this interface method to see if a MAC address is in use
  83      *
  84      * @param uuid
  85      *            identifier of the NeutronVPNIPSECPolicy object
  86      * @return boolean on whether the macAddress is already associated with a
  87      * port or not
  88      */
  89
  90     boolean neutronVPNIPSECPolicyInUse(String uuid);
  91
  92 }