27c176c10efce2c0dbe3ce5b3b7ddd08c53b2063
[ta/config-manager.git] / cmpluginclient.py
1 # Copyright 2019 Nokia
2
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
6 #
7 #     http://www.apache.org/licenses/LICENSE-2.0
8 #
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
14 from cmframework.apis import cmerror
15
16
17 class CMPluginClient(object):
18     # pylint: disable=no-self-use, unused-argument
19     def get_property(self, prop_name):
20         """read the value assoicated with a property
21
22             Arguments:
23
24             prop_name: The name of the property to be read.
25
26             Raise:
27
28             CMError is raised in-case of failure
29         """
30         raise cmerror.CMError('Not implemented')
31
32     # pylint: disable=no-self-use, unused-argument
33     def get_properties(self, prop_filter):
34         """read a set of properties matching a filter.
35
36             Arguments:
37
38             prop_filter: A string containing the re used to match the read
39                          properties.
40
41             Raise:
42
43             CMError is raised in-case of a failure.
44         """
45         raise cmerror.CMError('Not implemented')
46
47     # pylint: disable=no-self-use, unused-argument
48     def set_property(self, name, value):
49         raise cmerror.CMError('Not implemented')