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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);
namespace Magento\AsynchronousOperations\Api\Data;
/**
* ItemStatusInterface interface
* Temporary object with status of requested item.
* Indicate if entity param was Accepted|Rejected to bulk schedule
*
* @api
* @since 100.2.3
*/
interface ItemStatusInterface
{
const ENTITY_ID = 'entity_id';
const DATA_HASH = 'data_hash';
const STATUS = 'status';
const ERROR_MESSAGE = 'error_message';
const ERROR_CODE = 'error_code';
const STATUS_ACCEPTED = 'accepted';
const STATUS_REJECTED = 'rejected';
/**
* Get entity Id.
*
* @return int
* @since 100.2.3
*/
public function getId();
/**
* Sets entity Id.
*
* @param int $entityId
* @return $this
* @since 100.2.3
*/
public function setId($entityId);
/**
* Get hash of entity data.
*
* @return string md5 hash of entity params array.
* @since 100.2.3
*/
public function getDataHash();
/**
* Sets hash of entity data.
*
* @param string $hash md5 hash of entity params array.
* @return $this
* @since 100.2.3
*/
public function setDataHash($hash);
/**
* Get status.
*
* @return string accepted|rejected
* @since 100.2.3
*/
public function getStatus();
/**
* Sets entity status.
*
* @param string $status accepted|rejected
* @return $this
* @since 100.2.3
*/
public function setStatus($status = self::STATUS_ACCEPTED);
/**
* Get error information.
*
* @return string|null
* @since 100.2.3
*/
public function getErrorMessage();
/**
* Sets error information.
*
* @param string|null|\Exception $error
* @return $this
* @since 100.2.3
*/
public function setErrorMessage($error = null);
/**
* Get error code.
*
* @return int|null
* @since 100.2.3
*/
public function getErrorCode();
/**
* Sets error information.
*
* @param int|null|\Exception $errorCode Default: null
* @return $this
* @since 100.2.3
*/
public function setErrorCode($errorCode = null);
}