StorableResource.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\ResourceStorage\Resource;

use ILIAS\ResourceStorage\Identification\ResourceIdentification;
use ILIAS\ResourceStorage\Revision\Revision;
use ILIAS\ResourceStorage\Revision\RevisionCollection;
use ILIAS\ResourceStorage\Stakeholder\ResourceStakeholder;

interface StorableResource
{
    public function getIdentification(): ResourceIdentification;

    public function getCurrentRevision(): Revision;

    public function getCurrentRevisionIncludingDraft(): Revision;

    public function getSpecificRevision(int $number): ?Revision;

    public function hasSpecificRevision(int $number): bool;

    public function getAllRevisions(): array;

    public function getAllRevisionsIncludingDraft(): array;

    public function getStakeholders(): array;

    public function addStakeholder(ResourceStakeholder $s): void;

    public function removeStakeholder(ResourceStakeholder $s): void;

    public function addRevision(Revision $revision): void;

    public function removeRevision(Revision $revision): void;

    public function replaceRevision(Revision $revision): void;

    public function setRevisions(RevisionCollection $collection): void;

    public function getStorageID(): string;

    public function setStorageID(string $storage_id): void;

    public function getMaxRevision(bool $including_drafts = false): int;

    public function getFullSize(): int;

    public function getType(): ResourceType;
}