summaryrefslogtreecommitdiffstats
path: root/lib/public/Collaboration/Collaborators/ISearchResult.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/Collaboration/Collaborators/ISearchResult.php')
-rw-r--r--lib/public/Collaboration/Collaborators/ISearchResult.php73
1 files changed, 73 insertions, 0 deletions
diff --git a/lib/public/Collaboration/Collaborators/ISearchResult.php b/lib/public/Collaboration/Collaborators/ISearchResult.php
new file mode 100644
index 00000000000..abea5df8598
--- /dev/null
+++ b/lib/public/Collaboration/Collaborators/ISearchResult.php
@@ -0,0 +1,73 @@
+<?php
+/**
+ * @copyright Copyright (c) 2017 Arthur Schiwon <blizzz@arthur-schiwon.de>
+ *
+ * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCP\Collaboration\Collaborators;
+
+/**
+ * Interface ISearchResult
+ *
+ * @package OCP\Collaboration\Collaborators
+ * @since 13.0.0
+ */
+interface ISearchResult {
+ /**
+ * @param SearchResultType $type
+ * @param array $matches
+ * @param array|null $exactMatches
+ * @since 13.0.0
+ */
+ public function addResultSet(SearchResultType $type, array $matches, array $exactMatches = null);
+
+ /**
+ * @param SearchResultType $type
+ * @param string $collaboratorId
+ * @return bool
+ * @since 13.0.0
+ */
+ public function hasResult(SearchResultType $type, $collaboratorId);
+
+ /**
+ * @param SearchResultType $type
+ * @since 13.0.0
+ */
+ public function unsetResult(SearchResultType $type);
+
+ /**
+ * @param SearchResultType $type
+ * @since 13.0.0
+ */
+ public function markExactIdMatch(SearchResultType $type);
+
+ /**
+ * @param SearchResultType $type
+ * @return bool
+ * @since 13.0.0
+ */
+ public function hasExactIdMatch(SearchResultType $type);
+
+ /**
+ * @return array
+ * @since 13.0.0
+ */
+ public function asArray();
+}