1 files changed, 86 insertions, 0 deletions
diff --git a/lib/public/Search/ISearchQuery.php b/lib/public/Search/ISearchQuery.php
new file mode 100644
index 00000000000..80f6de914d0
--- /dev/null
+++ b/lib/public/Search/ISearchQuery.php
@@ -0,0 +1,86 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * SPDX-FileCopyrightText: 2020 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCP\Search;
+
+/**
+ * The query objected passed into \OCP\Search\IProvider::search
+ *
+ * This mainly wraps the search term, but will ensure that Nextcloud can add new
+ * optional properties to a search request without having break the interface of
+ * \OCP\Search\IProvider::search.
+ *
+ * @see \OCP\Search\IProvider::search
+ *
+ * @since 20.0.0
+ */
+interface ISearchQuery {
+	/**
+	 * @since 20.0.0
+	 */
+	public const SORT_DATE_DESC = 1;
+
+	/**
+	 * Get the user-entered search term to find matches for
+	 *
+	 * @return string the search term
+	 * @since 20.0.0
+	 */
+	public function getTerm(): string;
+
+	/**
+	 * Get a single request filter
+	 *
+	 * @since 28.0.0
+	 */
+	public function getFilter(string $name): ?IFilter;
+
+	/**
+	 * Get request filters
+	 *
+	 * @since 28.0.0
+	 */
+	public function getFilters(): IFilterCollection;
+
+	/**
+	 * Get the sort order of results as defined as SORT_* constants on this interface
+	 *
+	 * @return int
+	 * @since 20.0.0
+	 */
+	public function getSortOrder(): int;
+
+	/**
+	 * Get the number of items to return for a paginated result
+	 *
+	 * @return int
+	 * @see \OCP\Search\IProvider for details
+	 * @since 20.0.0
+	 */
+	public function getLimit(): int;
+
+	/**
+	 * Get the app-specific cursor of the tail of the previous result entries
+	 *
+	 * @return int|string|null
+	 * @see \OCP\Search\IProvider for details
+	 * @since 20.0.0
+	 */
+	public function getCursor();
+
+	/**
+	 * @return string
+	 * @since 20.0.0
+	 */
+	public function getRoute(): string;
+
+	/**
+	 * @return array
+	 * @since 20.0.0
+	 */
+	public function getRouteParameters(): array;
+}