blob: 2790dfd57598c46bce6ce3b848ce531217d5aabd (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
|
/*
* Copyright 2015 Open Networking Laboratory
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package org.onosproject.cord.gui.model;
import com.fasterxml.jackson.databind.node.ObjectNode;
/**
* Designates a specific instance of an XOS function.
*/
public interface XosFunction {
/**
* Returns the descriptor for this function.
*
* @return function descriptor
*/
XosFunctionDescriptor descriptor();
/**
* Applies a parameter change for the given user.
*
* @param user user to apply change to
* @param param parameter name
* @param value new parameter value
*/
void applyParam(SubscriberUser user, String param, String value);
/**
* Create an initialized memento.
* If the function maintains no state per user, return null.
*
* @return a new memento
*/
Memento createMemento();
/**
* Create the XOS specific URL suffix for applying state change for
* the given user.
*
* @param user the user
* @return URL suffix
*/
String xosUrlApply(SubscriberUser user);
/**
* Internal state memento.
*/
interface Memento {
/**
* Returns a JSON representation of this memento.
*
* @return memento state as object node
*/
ObjectNode toObjectNode();
}
}
|
