MessageInterface.php

<?php

namespace AS2;

interface MessageInterface
{
    public const STATUS_PENDING    = 'pending';
    public const STATUS_SUCCESS    = 'success';
    public const STATUS_ERROR      = 'error';
    public const STATUS_WARNING    = 'warning';
    public const STATUS_RETRY      = 'retry';
    public const STATUS_IN_PROCESS = 'in_process';

    public const MDN_STATUS_PENDING  = 'pending';
    public const MDN_STATUS_RECEIVED = 'received';
    public const MDN_STATUS_SENT     = 'sent';
    public const MDN_STATUS_ERROR    = 'error';

    public const DIR_INBOUND  = 1;
    public const DIR_OUTBOUND = 0;

    /**
     * Unique Message Id.
     *
     * @return string
     */
    public function getMessageId();

    /**
     * @param string $id
     *
     * @return $this
     */
    public function setMessageId($id);

    /**
     * @return int
     */
    public function getDirection();

    /**
     * @param int $dir
     *
     * @return $this
     */
    public function setDirection($dir);

    /**
     * @return PartnerInterface
     */
    public function getSender();

    /**
     * @return $this
     */
    public function setSender(PartnerInterface $partner);

    /**
     * @return PartnerInterface
     */
    public function getReceiver();

    /**
     * @return $this
     */
    public function setReceiver(PartnerInterface $partner);

    /**
     * @return string
     */
    public function getHeaders();

    /**
     * @param string $headers
     *
     * @return $this
     */
    public function setHeaders($headers);

    /**
     * @return string
     */
    public function getPayload();

    /**
     * @param string $payload
     *
     * @return $this
     */
    public function setPayload($payload);

    /**
     * @return string
     */
    public function getStatus();

    /**
     * @param string $status
     *
     * @return $this
     */
    public function setStatus($status);

    /**
     * @return string
     */
    public function getStatusMsg();

    /**
     * @param string $msg
     *
     * @return $this
     */
    public function setStatusMsg($msg);

    /**
     * @return string
     */
    public function getMdnStatus();

    /**
     * @param string $status
     *
     * @return $this
     */
    public function setMdnStatus($status);

    /**
     * @return string
     */
    public function getMdnPayload();

    /**
     * @return $this
     */
    public function setMdnPayload($mdn);

    /**
     * @return string
     */
    public function getMdnMode();

    /**
     * @param string $mode
     *
     * @return $this
     */
    public function setMdnMode($mode);

    /**
     * Get Message Integrity Check value.
     *
     * @return string
     */
    public function getMic();

    /**
     * Set Message Integrity Check value.
     *
     * @param string $mic
     *
     * @return $this
     */
    public function setMic($mic);

    /**
     * @return bool
     */
    public function getSigned();

    /**
     * @param bool $val
     *
     * @return $this
     */
    public function setSigned($val = true);

    /**
     * @return bool
     */
    public function getEncrypted();

    /**
     * @param bool $val
     *
     * @return $this
     */
    public function setEncrypted($val = true);

    /**
     * @return bool
     */
    public function getCompressed();

    /**
     * @param bool $val
     *
     * @return $this
     */
    public function setCompressed($val = true);
}