DocumentationInterface.php 1.15 KB
Newer Older
Ketan's avatar
Ketan committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
<?php
/**
 * Refer to LICENSE.txt distributed with the Temando Shipping module for notice of license
 */
namespace Temando\Shipping\Model;

/**
 * Temando Documentation Interface.
 *
 * The documentation data object represents one dispatch or completion document,
 * e.g. a shipping label.
 *
 * @package  Temando\Shipping\Model
 * @author   Christoph Aßmann <christoph.assmann@netresearch.de>
 * @license  http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link     http://www.temando.com/
 */
interface DocumentationInterface
{
    const DOCUMENTATION_ID = 'documentation_id';
    const NAME = 'name';
    const TYPE = 'type';
    const SIZE = 'size';
    const MIME_TYPE = 'mime_type';
    const URL = 'url';

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

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

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

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

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

    /**
     * @return string
     */
    public function getUrl();
}