67c539dfbbe8de22c3adc614b798c36b2d0afad8
[onosfw.git] /
1 /*
2  * Copyright 2015 Open Networking Laboratory
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package org.onosproject.net.resource.device;
17
18 import org.onosproject.net.intent.IntentId;
19
20 import java.util.Set;
21
22 public interface IntentSetMultimap {
23
24     /**
25      * Allocates the mapping between the given intents.
26      *
27      * @param keyIntentId key intent ID
28      * @param valIntentId value intent ID
29      * @return true if mapping was successful, false otherwise
30      */
31     boolean allocateMapping(IntentId keyIntentId, IntentId valIntentId);
32
33     /**
34      * Returns the set of intents mapped to a lower intent.
35      *
36      * @param intentId intent ID
37      * @return set of intent IDs
38      */
39     Set<IntentId> getMapping(IntentId intentId);
40
41     /**
42      * Releases the mapping of the given intent.
43      *
44      * @param intentId intent ID
45      */
46     void releaseMapping(IntentId intentId);
47 }