Make I*Aware interfaces deprecated
[neutron.git] / neutron-spi / src / main / java / org / opendaylight / neutron / spi / INeutronVPNServiceAware.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 /**
12  * This interface defines the methods a service that wishes to be aware of NeutronVPNService needs to implement
13  *
14  */
15 @Deprecated
16 public interface INeutronVPNServiceAware {
17
18     /**
19      * Services provide this interface method to indicate if the specified NeutronVPNService can be created
20      *
21      * @param vpnService
22      *            instance of proposed new NeutronVPNService object
23      * @return integer
24      *            the return value is understood to be a HTTP status code.  A return value outside of 200 through 299
25      *            results in the create operation being interrupted and the returned status value reflected in the
26      *            HTTP response.
27      */
28     int canCreateNeutronVPNService(NeutronVPNService vpnService);
29
30     /**
31      * Services provide this interface method for taking action after a NeutronVPNService has been created
32      *
33      * @param vpnService
34      *            instance of new NeutronVPNService object
35      */
36     void neutronVPNServiceCreated(NeutronVPNService vpnService);
37
38     /**
39      * Services provide this interface method to indicate if the
40      * specified NeutronVPNService can be changed using the specified
41      * delta
42      *
43      * @param delta
44      *            updates to the NeutronVPNService object using patch semantics
45      * @param original
46      *            instance of the NeutronVPNService object to be updated
47      * @return integer
48      *            the return value is understood to be a HTTP status code.  A return value outside of 200 through 299
49      *            results in the update operation being interrupted and the returned status value reflected in the
50      *            HTTP response.
51      */
52     int canUpdateNeutronVPNService(NeutronVPNService delta, NeutronVPNService original);
53
54     /**
55      * Services provide this interface method for taking action after a NeutronVPNService has been updated
56      *
57      * @param vpnService
58      *            instance of modified NeutronVPNService object
59      */
60     void neutronVPNServiceUpdated(NeutronVPNService vpnService);
61
62     /**
63      * Services provide this interface method to indicate if the specified NeutronVPNService can be deleted
64      *
65      * @param vpnService
66      *            instance of the NeutronVPNService object to be deleted
67      * @return integer
68      *            the return value is understood to be a HTTP status code.  A return value outside of 200 through 299
69      *            results in the delete operation being interrupted and the returned status value reflected in the
70      *            HTTP response.
71      */
72     int canDeleteNeutronVPNService(NeutronVPNService vpnService);
73
74     /**
75      * Services provide this interface method for taking action after a NeutronVPNService has been deleted
76      *
77      * @param vpnService
78      *            instance of deleted NeutronVPNService object
79      */
80     void neutronVPNServiceDeleted(NeutronVPNService vpnService);
81 }