Unity Scopes API
SearchQueryBase.h
1 /*
2  * Copyright (C) 2013 Canonical Ltd
3  *
4  * This program is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License version 3 as
6  * published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU Lesser General Public License for more details.
12  *
13  * You should have received a copy of the GNU Lesser General Public License
14  * along with this program. If not, see <http://www.gnu.org/licenses/>.
15  *
16  * Authored by: Michi Henning <michi.henning@canonical.com>
17  */
18 
19 #pragma once
20 
21 #include <unity/scopes/ChildScope.h>
22 #include <unity/scopes/QueryBase.h>
23 #include <unity/scopes/QueryCtrlProxyFwd.h>
24 #include <unity/scopes/ScopeProxyFwd.h>
25 #include <unity/scopes/SearchReplyProxyFwd.h>
26 #include <unity/scopes/Variant.h>
27 #include <unity/scopes/SearchListenerBase.h>
28 
29 #include <unity/util/DefinesPtrs.h>
30 #include <unity/util/NonCopyable.h>
31 
32 #include <set>
33 
34 namespace unity
35 {
36 
37 namespace scopes
38 {
39 
40 class SearchMetadata;
41 
42 namespace internal
43 {
44 
45 class SearchQueryBaseImpl;
46 
47 namespace smartscopes
48 {
49 
50 class SSScopeObject;
51 class SSQueryObject;
52 
53 }
54 
55 } // namespace internal
56 
66 class SearchQueryBase : public QueryBase
67 {
68 public:
70  NONCOPYABLE(SearchQueryBase);
71  UNITY_DEFINES_PTRS(SearchQueryBase);
73 
91  virtual void run(SearchReplyProxy const& reply) = 0;
92 
104  //{@
105  QueryCtrlProxy subsearch(ScopeProxy const& scope,
106  std::string const& query_string,
107  SearchListenerBase::SPtr const& reply);
108  QueryCtrlProxy subsearch(ChildScope const& scope,
109  std::string const& query_string,
110  SearchListenerBase::SPtr const& reply);
111  QueryCtrlProxy subsearch(ScopeProxy const& scope,
112  std::string const& query_string,
113  FilterState const& filter_state,
114  SearchListenerBase::SPtr const& reply);
115  QueryCtrlProxy subsearch(ScopeProxy const& scope,
116  std::string const& query_string,
117  std::string const& department_id,
118  FilterState const& filter_state,
119  SearchListenerBase::SPtr const& reply);
120  QueryCtrlProxy subsearch(ChildScope const& scope,
121  std::string const& query_string,
122  std::string const& department_id,
123  FilterState const& filter_state,
124  SearchListenerBase::SPtr const& reply);
125  QueryCtrlProxy subsearch(ScopeProxy const& scope,
126  std::string const& query_string,
127  std::string const& department_id,
128  FilterState const& filter_state,
129  SearchMetadata const& hints,
130  SearchListenerBase::SPtr const& reply);
131  QueryCtrlProxy subsearch(ChildScope const& scope,
132  std::string const& query_string,
133  std::string const& department_id,
134  FilterState const& filter_state,
135  SearchMetadata const& hints,
136  SearchListenerBase::SPtr const& reply);
137  QueryCtrlProxy subsearch(ChildScope const& scope,
138  std::string const& query_string,
139  std::string const& department_id,
140  FilterState const& filter_state,
141  Variant const& user_data,
142  SearchMetadata const& hints,
143  SearchListenerBase::SPtr const& reply);
144  QueryCtrlProxy subsearch(ScopeProxy const& scope,
145  std::string const& query_string,
146  std::string const& department_id,
147  FilterState const& filter_state,
148  Variant const& user_data,
149  SearchMetadata const& hints,
150  SearchListenerBase::SPtr const& reply);
152 
159  CannedQuery query() const;
160 
167 
169  virtual ~SearchQueryBase();
171 
172 protected:
174  SearchQueryBase(CannedQuery const& query, SearchMetadata const& metadata);
176 
177 private:
178  internal::SearchQueryBaseImpl* fwd() const;
179 
180  void set_department_id(std::string const& department_id);
181  std::string department_id() const;
182 
183  friend class internal::QueryObject; // So QueryObject can call cancel() and set_department_id()
184  friend class internal::ScopeObject; // So ScopeObject can set department and query context
185  friend class internal::smartscopes::SSQueryObject; // So SSQueryObject can call cancel()
186  friend class internal::smartscopes::SSScopeObject; // So SSScopeObject can call set_department_id()
187 };
188 
189 } // namespace scopes
190 
191 } // namespace unity
virtual void run(SearchReplyProxy const &reply)=0
Called by scopes run time to start the query.
A container for details about an aggregator's child scope.
Definition: ChildScope.h:45
std::shared_ptr< Scope > ScopeProxy
Convenience type definition.
Definition: ScopeProxyFwd.h:34
Abstract server-side base interface for a query that is executed inside a scope.
Definition: QueryBase.h:60
Simple variant class that can hold an integer, boolean, string, double, dictionary, array or null value.
Definition: Variant.h:57
Metadata passed with search requests.
Definition: SearchMetadata.h:45
Top-level namespace for all things Unity-related.
Definition: Version.h:49
Definition: ActionMetadata.h:31
Parameters of a search query.
Definition: CannedQuery.h:49
Captures state of multiple filters.
Definition: FilterState.h:46
Abstract base class to represent a particular query.
Definition: SearchQueryBase.h:66
std::shared_ptr< QueryCtrl > QueryCtrlProxy
Convenience type definition.
Definition: QueryCtrlProxyFwd.h:33
std::shared_ptr< SearchReply > SearchReplyProxy
Convenience type definition.
Definition: SearchReplyProxyFwd.h:34
CannedQuery query() const
Get a canned query for this search request.
SearchMetadata search_metadata() const
Get metadata for this search request.