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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
|
# *****************************************************************************
# * Copyright (c) 2012-2013 Wind River Systems, Inc. and others.
# * All rights reserved. This program and the accompanying materials
# * are made available under the terms of the Eclipse Public License v1.0
# * which accompanies this distribution, and is available at
# * http://www.eclipse.org/legal/epl-v10.html
# *
# * Contributors:
# * Wind River Systems - initial API and implementation
# *****************************************************************************
"""TCF ContextQuery service interface.
.. |getAttrNames| replace:: :meth:`ContextQueryService.getAttrNames`
.. |query| replace:: :meth:`ContextQueryService.query`
.. |DoneGetAttrNames| replace:: :class:`DoneGetAttrNames`
.. |DoneQuery| replace:: :class:`DoneQuery`
Service Methods
---------------
.. autodata:: NAME
.. autoclass:: ContextQueryService
getAttrNames
^^^^^^^^^^^^
.. automethod:: ContextQueryService.getAttrNames
getName
^^^^^^^
.. automethod:: ContextQueryService.getName
query
^^^^^
.. automethod:: ContextQueryService.query
Callback Classes
----------------
DoneGetAttrNames
^^^^^^^^^^^^^^^^
.. autoclass:: DoneGetAttrNames
:members:
DoneQuery
^^^^^^^^^
.. autoclass:: DoneQuery
:members:
"""
from .. import services
NAME = "ContextQuery"
"""ContextQuery service name."""
class ContextQueryService(services.Service):
"""TCF context query service interface."""
def getName(self):
"""Get this service name.
:returns: A |basestring| representing this service name, which is the
value of :const:`NAME`
"""
return NAME
def query(self, querystr, done):
"""Get the list of contexts matching a given query.
:param querystr: Context query to be executed.
:type querystr: |basestring|
:param done: Command result call back object.
:type done: |DoneQuery|
:returns: Pending command handle.
"""
raise NotImplementedError("Abstract method")
def getAttrNames(self, done):
"""Get the list of Attributes registered with the context query
service.
:param done: Command result call back object.
:type done: |DoneGetAttrNames|
:return: Pending command handle.
"""
raise NotImplementedError("Abstract method")
class DoneQuery(object):
"Call back interface for |query| command."
def doneQuery(self, token, error, ctxList):
"""Called when |query| command is done.
:param token: Pending command handle.
:param error: Error description if operation failed, **None** if
succeeded.
:param ctxList: IDs of contexts matching the query.
:type ctxList: |list|
"""
pass
class DoneGetAttrNames(object):
"Call back interface for |getAttrNames| command."
def doneGetAttrNames(self, token, error, attrNameList):
"""Called when |getAttrNames| command is done.
:param token: Pending command handle.
:param error: Error description if operation failed, **None** if
succeeded.
:param attrNameList: List of the attributes supported by the agent.
:type attrNamesList: |list|
"""
pass
|
