<?php

declare(strict_types=1);

/**
 * vim:set softtabstop=4 shiftwidth=4 expandtab:
 *
 * LICENSE: GNU Affero General Public License, version 3 (AGPL-3.0-or-later)
 * Copyright Ampache.org, 2001-2024
 *
 * 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 Ampache\Module\Metadata;

use Ampache\Repository\Model\Metadata;
use Traversable;

/**
 * Defines a set of methods item must provide to support metadata
 */
interface MetadataEnabledInterface
{
    /**
     * Returns the metadata object-type
     */
    public function getMetadataItemType(): string;

    /**
     * Returns the linked items id
     */
    public function getId(): int;

    /**
     * Returns a list of metadata-keys to ignore
     *
     * @return list<string>
     */
    public function getIgnoredMetadataKeys(): array;

    /**
     * Returns the available metadata for this object
     *
     * @return Traversable<Metadata>
     */
    public function getMetadata(): Traversable;
}
