-
Notifications
You must be signed in to change notification settings - Fork 246
/
SourceInterface.php
339 lines (297 loc) · 6.75 KB
/
SourceInterface.php
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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\InventoryApi\Api\Data;
use Magento\Framework\Api\ExtensibleDataInterface;
use Magento\InventoryApi\Api\Data\SourceExtensionInterface;
/**
* Represents physical storage, i.e. brick and mortar store or warehouse
*
* Used fully qualified namespaces in annotations for proper work of WebApi request parser
*
* @api
*/
interface SourceInterface extends ExtensibleDataInterface
{
/**
* Constants for keys of data array. Identical to the name of the getter in snake case
*/
const SOURCE_ID = 'source_id';
const NAME = 'name';
const CONTACT_NAME = 'contact_name';
const EMAIL = 'email';
const ENABLED = 'enabled';
const DESCRIPTION = 'description';
const LATITUDE = 'latitude';
const LONGITUDE = 'longitude';
const COUNTRY_ID = 'country_id';
const REGION_ID = 'region_id';
const REGION = 'region';
const CITY = 'city';
const STREET = 'street';
const POSTCODE = 'postcode';
const PHONE = 'phone';
const FAX = 'fax';
const PRIORITY = 'priority';
const USE_DEFAULT_CARRIER_CONFIG = 'use_default_carrier_config';
const CARRIER_LINKS = 'carrier_links';
/**#@-*/
/**
* Get source id
*
* @return int|null
*/
public function getSourceId();
/**
* Set source id
*
* @param int $sourceId
* @return void
*/
public function setSourceId($sourceId);
/**
* Get source name
*
* @return string
*/
public function getName();
/**
* Set source name
*
* @param string $name
* @return void
*/
public function setName($name);
/**
* Get source email
*
* @return string|null
*/
public function getEmail();
/**
* Set source email
*
* @param string|null $email
* @return void
*/
public function setEmail($email);
/**
* Get source contact name
*
* @return string|null
*/
public function getContactName();
/**
* Set source contact name
*
* @param string|null $contactName
* @return void
*/
public function setContactName($contactName);
/**
* Check if source is enabled. For new entity can be null
*
* @return bool|null
*/
public function isEnabled();
/**
* Enable or disable source
*
* @param bool $enabled
* @return void|null
*/
public function setEnabled($enabled);
/**
* Get source description
*
* @return string|null
*/
public function getDescription();
/**
* Set source description
*
* @param string|null $description
* @return void
*/
public function setDescription($description);
/**
* Get source latitude
*
* @return float|null
*/
public function getLatitude();
/**
* Set source latitude
*
* @param float|null $latitude
* @return void
*/
public function setLatitude($latitude);
/**
* Get source longitude
*
* @return float|null
*/
public function getLongitude();
/**
* Set source longitude
*
* @param float|null $longitude
* @return void
*/
public function setLongitude($longitude);
/**
* Get source country id
*
* @return string
*/
public function getCountryId();
/**
* Set source country id
*
* @param string $countryId
* @return void
*/
public function setCountryId($countryId);
/**
* Get region id if source has registered region.
*
* @return int|null
*/
public function getRegionId();
/**
* Set region id if source has registered region.
*
* @param int|null $regionId
* @return void
*/
public function setRegionId($regionId);
/**
* Get region title if source has custom region
*
* @return string|null
*/
public function getRegion();
/**
* Set source region title
*
* @param string|null $region
* @return void
*/
public function setRegion($region);
/**
* Get source city
*
* @return string|null
*/
public function getCity();
/**
* Set source city
*
* @param string|null $city
* @return void
*/
public function setCity($city);
/**
* Get source street name
*
* @return string|null
*/
public function getStreet();
/**
* Set source street name
*
* @param string|null $street
* @return void
*/
public function setStreet($street);
/**
* Get source post code
*
* @return string
*/
public function getPostcode();
/**
* Set source post code
*
* @param string $postcode
* @return void
*/
public function setPostcode($postcode);
/**
* Get source phone number
*
* @return string|null
*/
public function getPhone();
/**
* Set source phone number
*
* @param string|null $phone
* @return void
*/
public function setPhone($phone);
/**
* Get source fax
*
* @return string|null
*/
public function getFax();
/**
* Set source fax
*
* @param string $fax
* @return void|null
*/
public function setFax($fax);
/**
* Get source priority
*
* @return int|null
*/
public function getPriority();
/**
* Set source priority
*
* @param int|null $priority
* @return void
*/
public function setPriority($priority);
/**
* Check is need to use default config. For new entity can be null
*
* @return bool|null
*/
public function isUseDefaultCarrierConfig();
/**
* @param bool|null $useDefaultCarrierConfig
* @return $this
*/
public function setUseDefaultCarrierConfig($useDefaultCarrierConfig);
/**
* For new entity can be null
*
* @return \Magento\InventoryApi\Api\Data\SourceCarrierLinkInterface[]|null
*/
public function getCarrierLinks();
/**
* @param \Magento\InventoryApi\Api\Data\SourceCarrierLinkInterface[]|null $carrierLinks
* @return void
*/
public function setCarrierLinks(array $carrierLinks);
/**
* Retrieve existing extension attributes object
*
* @return \Magento\InventoryApi\Api\Data\SourceExtensionInterface|null
*/
public function getExtensionAttributes();
/**
* Set an extension attributes object
*
* @param \Magento\InventoryApi\Api\Data\SourceExtensionInterface $extensionAttributes
* @return void
*/
public function setExtensionAttributes(SourceExtensionInterface $extensionAttributes);
}