php-sap/interfaces

<?php

declare(strict_types=1);

namespace phpsap\interfaces\Config;

use phpsap\interfaces\exceptions\IIncompleteConfigException;
use phpsap\interfaces\exceptions\IInvalidArgumentException;

/**
 * Interface IConfigTypeA
 *
 * Interface to configure connection parameters for SAP remote function calls using
 * a specific SAP application server (type A).
 *
 * @package phpsap\interfaces\Config
 * @author  Gregor J.
 * @license MIT
 */
interface IConfigTypeA extends IConfiguration
{
    /**
     * The host name of a specific SAP application server.
     */
    public const JSON_ASHOST = 'ashost';

    /**
     * The SAP system number.
     */
    public const JSON_SYSNR = 'sysnr';

    /**
     * The gateway host on an application server.
     */
    public const JSON_GWHOST = 'gwhost';

    /**
     * The gateway server on an application server.
     */
    public const JSON_GWSERV = 'gwserv';

    /**
     * Get the hostname of a specific SAP application server.
     * @return string The hostname of a specific SAP application server.
     * @throws IIncompleteConfigException
     */
    public function getAshost(): string;

    /**
     * Set the hostname of a specific SAP application server.
     * @param  string  $ashost The hostname of a specific SAP application server.
     * @return $this
     * @throws IInvalidArgumentException
     */
    public function setAshost(string $ashost): IConfigTypeA;

    /**
     * Get the SAP system number.
     * @return string The SAP system number.
     * @throws IIncompleteConfigException
     */
    public function getSysnr(): string;

    /**
     * Set the SAP system number.
     * @param  string  $sysnr The SAP system number.
     * @return $this
     * @throws IInvalidArgumentException
     */
    public function setSysnr(string $sysnr): IConfigTypeA;

    /**
     * Get the gateway host on the application server.
     * @return string|null The gateway host or NULL in case no gateway host has been defined.
     */
    public function getGwhost(): ?string;

    /**
     * Set the gateway host on the application server.
     * @param  string  $gwhost The gateway host.
     * @return $this
     * @throws IInvalidArgumentException
     */
    public function setGwhost(string $gwhost): IConfigTypeA;

    /**
     * Get the gateway service on the application server.
     * @return string|null The gateway service or NULL in case no gateway service has been defined.
     */
    public function getGwserv(): ?string;

    /**
     * Set the gateway service on the application server.
     * @param  string  $gwserv The gateway service on the application server.
     * @return $this
     * @throws IInvalidArgumentException
     */
    public function setGwserv(string $gwserv): IConfigTypeA;
}