summaryrefslogtreecommitdiffstats
path: root/lib/public/Accounts/IAccountPropertyCollection.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/Accounts/IAccountPropertyCollection.php')
-rw-r--r--lib/public/Accounts/IAccountPropertyCollection.php77
1 files changed, 77 insertions, 0 deletions
diff --git a/lib/public/Accounts/IAccountPropertyCollection.php b/lib/public/Accounts/IAccountPropertyCollection.php
new file mode 100644
index 00000000000..b67fa5646fd
--- /dev/null
+++ b/lib/public/Accounts/IAccountPropertyCollection.php
@@ -0,0 +1,77 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2021 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 <https://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCP\Accounts;
+
+use InvalidArgumentException;
+use JsonSerializable;
+
+/**
+ * Interface IAccountPropertyCollection
+ *
+ * @package OCP\Accounts
+ *
+ * @since 22.0.0
+ */
+interface IAccountPropertyCollection extends JsonSerializable {
+
+ /**
+ * set properties of this collection
+ *
+ * @param IAccountProperty[] $properties
+ * @throws InvalidArgumentException
+ * @since 22.0.0
+ */
+ public function setProperties(array $properties): IAccountPropertyCollection;
+
+ /**
+ * @return IAccountProperty[]
+ * @since 22.0.0
+ */
+ public function getProperties(): array;
+
+ /**
+ * adds a property to this collection
+ *
+ * @throws InvalidArgumentException
+ * @since 22.0.0
+ */
+ public function addProperty(IAccountProperty $property): IAccountPropertyCollection;
+
+ /**
+ * removes a property of this collection
+ *
+ * @since 22.0.0
+ */
+ public function removeProperty(IAccountProperty $property): IAccountPropertyCollection;
+
+ /**
+ * removes a property identified by its value
+ *
+ * @since 22.0.0
+ */
+ public function removePropertyByValue(string $value): IAccountPropertyCollection;
+}