81 lines
1.8 KiB
PHP
81 lines
1.8 KiB
PHP
<?php
|
|
declare(strict_types=1);
|
|
/**
|
|
* @copyright Copyright (c) 2018 Joas Schilling <coding@schilljs.com>
|
|
*
|
|
* @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\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;
|
|
}
|