<?php

/*
 * Copyright 2005 - 2025 Centreon (https://www.centreon.com/)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * For more information : contact@centreon.com
 *
 */

declare(strict_types=1);

namespace Core\Broker\Application\Repository;

use Core\Broker\Domain\Model\BrokerInputOutput;
use Core\Broker\Domain\Model\BrokerInputOutputField;
use Core\Broker\Domain\Model\Type;

interface ReadBrokerInputOutputRepositoryInterface
{
    /**
     * Find parameters of an input or output by type.
     * Result key is the parameter fieldname, in case of grouped fields the groupname is used as a key.
     *
     * @param int $typeId
     *
     * @throws \Throwable
     *
     * @return array<string,BrokerInputOutputField|array<string,BrokerInputOutputField>>
     */
    public function findParametersByType(int $typeId): array;

    /**
     * Find an input or output stream type by its ID.
     *
     * @param string $tag
     * @param int $typeId
     *
     * @throws \Throwable
     *
     * @return ?Type
     */
    public function findType(string $tag, int $typeId): ?Type;

    /**
     * Find a broker input or output configuration by its ID and its broker ID.
     *
     * @param string $tag
     * @param int $outputId
     * @param int $brokerId
     *
     * @throws \Throwable
     *
     * @return null|BrokerInputOutput
     */
    public function findByIdAndBrokerId(string $tag, int $outputId, int $brokerId): ?BrokerInputOutput;

    /**
     * Return the vault path corresponding to a broker configuration ID.
     *
     * @param int $brokerId
     *
     * @throws \Throwable
     *
     * @return string|null
     */
    public function findVaultPathByBrokerId(int $brokerId): ?string;

    /**
     * Return all the broker inputs and outputs ordered by broker configuration ID.
     *
     * @throws \Throwable
     *
     * @return array<int,BrokerInputOutput[]>
     */
    public function findAll(): array;
}
