SummaryOperationStatusInterface.php 1.05 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
<?php
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */

declare(strict_types=1);

namespace Magento\AsynchronousOperations\Api\Data;

/**
 * Getter Class OperationsStatusInterface
 * Instead of OperationInterface this class don't provide all operation data
 * and not responsive to set any data, just to get operation data
 * without serialized_data and result_serialized_data
 *
 * @api
 * @since 100.2.3
 */
interface SummaryOperationStatusInterface
{
    /**
     * Operation id
     *
     * @return int
     * @since 100.2.3
     */
    public function getId();

    /**
     * Get operation status
     *
     * OPEN | COMPLETE | RETRIABLY_FAILED | NOT_RETRIABLY_FAILED
     *
     * @return int
     * @since 100.2.3
     */
    public function getStatus();

    /**
     * Get result message
     *
     * @return string
     * @since 100.2.3
     */
    public function getResultMessage();

    /**
     * Get error code
     *
     * @return int
     * @since 100.2.3
     */
    public function getErrorCode();
}