aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/Collaboration/Resources/ICollection.php
blob: 6f9e14c52e2a9e108b75166dfbddbfe6bdf79414 (plain)
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
<?php

declare(strict_types=1);

/**
 * SPDX-FileCopyrightText: 2018 Nextcloud GmbH and Nextcloud contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */
namespace OCP\Collaboration\Resources;

use OCP\IUser;

/**
 * @since 16.0.0
 */
interface ICollection {
	/**
	 * @return int
	 * @since 16.0.0
	 */
	public function getId(): int;

	/**
	 * @return string
	 * @since 16.0.0
	 */
	public function getName(): string;

	/**
	 * @param string $name
	 * @since 16.0.0
	 */
	public function setName(string $name): void;

	/**
	 * @return IResource[]
	 * @since 16.0.0
	 */
	public function getResources(): array;

	/**
	 * Adds a resource to a collection
	 *
	 * @param IResource $resource
	 * @throws ResourceException when the resource is already part of the collection
	 * @since 16.0.0
	 */
	public function addResource(IResource $resource): void;

	/**
	 * Removes a resource from a collection
	 *
	 * @param IResource $resource
	 * @since 16.0.0
	 */
	public function removeResource(IResource $resource): void;

	/**
	 * Can a user/guest access the collection
	 *
	 * @param IUser|null $user
	 * @return bool
	 * @since 16.0.0
	 */
	public function canAccess(?IUser $user): bool;
}