/framework/GetCategoryListingsRequestType.php

https://github.com/iloveitaly/ebay-php · PHP · 561 lines · 346 code · 2 blank · 213 comment · 1 complexity · e3a3acb99904c6f455bd5be6e7e8169c MD5 · raw file

  1. <?php
  2. // autogenerated file 04.06.2009 09:55
  3. // $Id: $
  4. // $Log: $
  5. //
  6. //
  7. require_once 'PaginationType.php';
  8. require_once 'SearchLocationType.php';
  9. require_once 'CategoryListingsOrderCodeType.php';
  10. require_once 'CurrencyCodeType.php';
  11. require_once 'ProximitySearchType.php';
  12. require_once 'PaymentMethodSearchCodeType.php';
  13. require_once 'GroupType.php';
  14. require_once 'AbstractRequestType.php';
  15. require_once 'CategoryListingsSearchCodeType.php';
  16. require_once 'ItemTypeFilterCodeType.php';
  17. /**
  18. * Returns items in a specified category. A number of inputs are providedfor
  19. * filtering the item listings returned using such criteria aslocation, whether the
  20. * item is listed in an ebay Store,the listing type, and including or excluding
  21. * specified sellers.<br><br>If you are not using the BestMatch search option, the
  22. * API search results may not match the search results returned by the eBay
  23. * website.<br><br>It is recommended that you consider using FindItemsAdvanced(in
  24. * the Shopping API) instead of GetCategoryListings becauseFindItemsAdvanced is
  25. * easier to use and faster.See <a
  26. * href="http://developer.ebay.com/products/shopping/" target="_blank">Shopping
  27. * API</a>for more information.
  28. *
  29. * @link http://developer.ebay.com/DevZone/XML/docs/Reference/eBay/types/GetCategoryListingsRequestType.html
  30. *
  31. */
  32. class GetCategoryListingsRequestType extends AbstractRequestType
  33. {
  34. /**
  35. * @var boolean
  36. */
  37. protected $MotorsGermanySearchable;
  38. /**
  39. * @var string
  40. */
  41. protected $CategoryID;
  42. /**
  43. * @var boolean
  44. */
  45. protected $AdFormat;
  46. /**
  47. * @var boolean
  48. */
  49. protected $FreeShipping;
  50. /**
  51. * @var CurrencyCodeType
  52. */
  53. protected $Currency;
  54. /**
  55. * @var ItemTypeFilterCodeType
  56. */
  57. protected $ItemTypeFilter;
  58. /**
  59. * @var CategoryListingsSearchCodeType
  60. */
  61. protected $SearchType;
  62. /**
  63. * @var CategoryListingsOrderCodeType
  64. */
  65. protected $OrderBy;
  66. /**
  67. * @var PaginationType
  68. */
  69. protected $Pagination;
  70. /**
  71. * @var SearchLocationType
  72. */
  73. protected $SearchLocation;
  74. /**
  75. * @var ProximitySearchType
  76. */
  77. protected $ProximitySearch;
  78. /**
  79. * @var boolean
  80. */
  81. protected $IncludeGetItFastItems;
  82. /**
  83. * @var PaymentMethodSearchCodeType
  84. */
  85. protected $PaymentMethod;
  86. /**
  87. * @var boolean
  88. */
  89. protected $IncludeCondition;
  90. /**
  91. * @var boolean
  92. */
  93. protected $IncludeFeedback;
  94. /**
  95. * @var string
  96. */
  97. protected $LocalSearchPostalCode;
  98. /**
  99. * @var int
  100. */
  101. protected $MaxRelatedSearchKeywords;
  102. /**
  103. * @var GroupType
  104. */
  105. protected $Group;
  106. /**
  107. * @var boolean
  108. */
  109. protected $HideDuplicateItems;
  110. /**
  111. * @return boolean
  112. */
  113. function getMotorsGermanySearchable()
  114. {
  115. return $this->MotorsGermanySearchable;
  116. }
  117. /**
  118. * @return void
  119. * @param boolean $value
  120. */
  121. function setMotorsGermanySearchable($value)
  122. {
  123. $this->MotorsGermanySearchable = $value;
  124. }
  125. /**
  126. * @return string
  127. */
  128. function getCategoryID()
  129. {
  130. return $this->CategoryID;
  131. }
  132. /**
  133. * @return void
  134. * @param string $value
  135. */
  136. function setCategoryID($value)
  137. {
  138. $this->CategoryID = $value;
  139. }
  140. /**
  141. * @return boolean
  142. */
  143. function getAdFormat()
  144. {
  145. return $this->AdFormat;
  146. }
  147. /**
  148. * @return void
  149. * @param boolean $value
  150. */
  151. function setAdFormat($value)
  152. {
  153. $this->AdFormat = $value;
  154. }
  155. /**
  156. * @return boolean
  157. */
  158. function getFreeShipping()
  159. {
  160. return $this->FreeShipping;
  161. }
  162. /**
  163. * @return void
  164. * @param boolean $value
  165. */
  166. function setFreeShipping($value)
  167. {
  168. $this->FreeShipping = $value;
  169. }
  170. /**
  171. * @return CurrencyCodeType
  172. */
  173. function getCurrency()
  174. {
  175. return $this->Currency;
  176. }
  177. /**
  178. * @return void
  179. * @param CurrencyCodeType $value
  180. */
  181. function setCurrency($value)
  182. {
  183. $this->Currency = $value;
  184. }
  185. /**
  186. * @return ItemTypeFilterCodeType
  187. */
  188. function getItemTypeFilter()
  189. {
  190. return $this->ItemTypeFilter;
  191. }
  192. /**
  193. * @return void
  194. * @param ItemTypeFilterCodeType $value
  195. */
  196. function setItemTypeFilter($value)
  197. {
  198. $this->ItemTypeFilter = $value;
  199. }
  200. /**
  201. * @return CategoryListingsSearchCodeType
  202. */
  203. function getSearchType()
  204. {
  205. return $this->SearchType;
  206. }
  207. /**
  208. * @return void
  209. * @param CategoryListingsSearchCodeType $value
  210. */
  211. function setSearchType($value)
  212. {
  213. $this->SearchType = $value;
  214. }
  215. /**
  216. * @return CategoryListingsOrderCodeType
  217. */
  218. function getOrderBy()
  219. {
  220. return $this->OrderBy;
  221. }
  222. /**
  223. * @return void
  224. * @param CategoryListingsOrderCodeType $value
  225. */
  226. function setOrderBy($value)
  227. {
  228. $this->OrderBy = $value;
  229. }
  230. /**
  231. * @return PaginationType
  232. */
  233. function getPagination()
  234. {
  235. return $this->Pagination;
  236. }
  237. /**
  238. * @return void
  239. * @param PaginationType $value
  240. */
  241. function setPagination($value)
  242. {
  243. $this->Pagination = $value;
  244. }
  245. /**
  246. * @return SearchLocationType
  247. */
  248. function getSearchLocation()
  249. {
  250. return $this->SearchLocation;
  251. }
  252. /**
  253. * @return void
  254. * @param SearchLocationType $value
  255. */
  256. function setSearchLocation($value)
  257. {
  258. $this->SearchLocation = $value;
  259. }
  260. /**
  261. * @return ProximitySearchType
  262. */
  263. function getProximitySearch()
  264. {
  265. return $this->ProximitySearch;
  266. }
  267. /**
  268. * @return void
  269. * @param ProximitySearchType $value
  270. */
  271. function setProximitySearch($value)
  272. {
  273. $this->ProximitySearch = $value;
  274. }
  275. /**
  276. * @return boolean
  277. */
  278. function getIncludeGetItFastItems()
  279. {
  280. return $this->IncludeGetItFastItems;
  281. }
  282. /**
  283. * @return void
  284. * @param boolean $value
  285. */
  286. function setIncludeGetItFastItems($value)
  287. {
  288. $this->IncludeGetItFastItems = $value;
  289. }
  290. /**
  291. * @return PaymentMethodSearchCodeType
  292. */
  293. function getPaymentMethod()
  294. {
  295. return $this->PaymentMethod;
  296. }
  297. /**
  298. * @return void
  299. * @param PaymentMethodSearchCodeType $value
  300. */
  301. function setPaymentMethod($value)
  302. {
  303. $this->PaymentMethod = $value;
  304. }
  305. /**
  306. * @return boolean
  307. */
  308. function getIncludeCondition()
  309. {
  310. return $this->IncludeCondition;
  311. }
  312. /**
  313. * @return void
  314. * @param boolean $value
  315. */
  316. function setIncludeCondition($value)
  317. {
  318. $this->IncludeCondition = $value;
  319. }
  320. /**
  321. * @return boolean
  322. */
  323. function getIncludeFeedback()
  324. {
  325. return $this->IncludeFeedback;
  326. }
  327. /**
  328. * @return void
  329. * @param boolean $value
  330. */
  331. function setIncludeFeedback($value)
  332. {
  333. $this->IncludeFeedback = $value;
  334. }
  335. /**
  336. * @return string
  337. */
  338. function getLocalSearchPostalCode()
  339. {
  340. return $this->LocalSearchPostalCode;
  341. }
  342. /**
  343. * @return void
  344. * @param string $value
  345. */
  346. function setLocalSearchPostalCode($value)
  347. {
  348. $this->LocalSearchPostalCode = $value;
  349. }
  350. /**
  351. * @return int
  352. */
  353. function getMaxRelatedSearchKeywords()
  354. {
  355. return $this->MaxRelatedSearchKeywords;
  356. }
  357. /**
  358. * @return void
  359. * @param int $value
  360. */
  361. function setMaxRelatedSearchKeywords($value)
  362. {
  363. $this->MaxRelatedSearchKeywords = $value;
  364. }
  365. /**
  366. * @return GroupType
  367. */
  368. function getGroup()
  369. {
  370. return $this->Group;
  371. }
  372. /**
  373. * @return void
  374. * @param GroupType $value
  375. */
  376. function setGroup($value)
  377. {
  378. $this->Group = $value;
  379. }
  380. /**
  381. * @return boolean
  382. */
  383. function getHideDuplicateItems()
  384. {
  385. return $this->HideDuplicateItems;
  386. }
  387. /**
  388. * @return void
  389. * @param boolean $value
  390. */
  391. function setHideDuplicateItems($value)
  392. {
  393. $this->HideDuplicateItems = $value;
  394. }
  395. /**
  396. * @return
  397. */
  398. function __construct()
  399. {
  400. parent::__construct('GetCategoryListingsRequestType', 'urn:ebay:apis:eBLBaseComponents');
  401. if (!isset(self::$_elements[__CLASS__]))
  402. self::$_elements[__CLASS__] = array_merge(self::$_elements[get_parent_class()],
  403. array(
  404. 'MotorsGermanySearchable' =>
  405. array(
  406. 'required' => false,
  407. 'type' => 'boolean',
  408. 'nsURI' => 'http://www.w3.org/2001/XMLSchema',
  409. 'array' => false,
  410. 'cardinality' => '0..1'
  411. ),
  412. 'CategoryID' =>
  413. array(
  414. 'required' => false,
  415. 'type' => 'string',
  416. 'nsURI' => 'http://www.w3.org/2001/XMLSchema',
  417. 'array' => false,
  418. 'cardinality' => '0..1'
  419. ),
  420. 'AdFormat' =>
  421. array(
  422. 'required' => false,
  423. 'type' => 'boolean',
  424. 'nsURI' => 'http://www.w3.org/2001/XMLSchema',
  425. 'array' => false,
  426. 'cardinality' => '0..1'
  427. ),
  428. 'FreeShipping' =>
  429. array(
  430. 'required' => false,
  431. 'type' => 'boolean',
  432. 'nsURI' => 'http://www.w3.org/2001/XMLSchema',
  433. 'array' => false,
  434. 'cardinality' => '0..1'
  435. ),
  436. 'Currency' =>
  437. array(
  438. 'required' => false,
  439. 'type' => 'CurrencyCodeType',
  440. 'nsURI' => 'urn:ebay:apis:eBLBaseComponents',
  441. 'array' => false,
  442. 'cardinality' => '0..1'
  443. ),
  444. 'ItemTypeFilter' =>
  445. array(
  446. 'required' => false,
  447. 'type' => 'ItemTypeFilterCodeType',
  448. 'nsURI' => 'urn:ebay:apis:eBLBaseComponents',
  449. 'array' => false,
  450. 'cardinality' => '0..1'
  451. ),
  452. 'SearchType' =>
  453. array(
  454. 'required' => false,
  455. 'type' => 'CategoryListingsSearchCodeType',
  456. 'nsURI' => 'urn:ebay:apis:eBLBaseComponents',
  457. 'array' => false,
  458. 'cardinality' => '0..1'
  459. ),
  460. 'OrderBy' =>
  461. array(
  462. 'required' => false,
  463. 'type' => 'CategoryListingsOrderCodeType',
  464. 'nsURI' => 'urn:ebay:apis:eBLBaseComponents',
  465. 'array' => false,
  466. 'cardinality' => '0..1'
  467. ),
  468. 'Pagination' =>
  469. array(
  470. 'required' => false,
  471. 'type' => 'PaginationType',
  472. 'nsURI' => 'urn:ebay:apis:eBLBaseComponents',
  473. 'array' => false,
  474. 'cardinality' => '0..1'
  475. ),
  476. 'SearchLocation' =>
  477. array(
  478. 'required' => false,
  479. 'type' => 'SearchLocationType',
  480. 'nsURI' => 'urn:ebay:apis:eBLBaseComponents',
  481. 'array' => false,
  482. 'cardinality' => '0..1'
  483. ),
  484. 'ProximitySearch' =>
  485. array(
  486. 'required' => false,
  487. 'type' => 'ProximitySearchType',
  488. 'nsURI' => 'urn:ebay:apis:eBLBaseComponents',
  489. 'array' => false,
  490. 'cardinality' => '0..1'
  491. ),
  492. 'IncludeGetItFastItems' =>
  493. array(
  494. 'required' => false,
  495. 'type' => 'boolean',
  496. 'nsURI' => 'http://www.w3.org/2001/XMLSchema',
  497. 'array' => false,
  498. 'cardinality' => '0..1'
  499. ),
  500. 'PaymentMethod' =>
  501. array(
  502. 'required' => false,
  503. 'type' => 'PaymentMethodSearchCodeType',
  504. 'nsURI' => 'urn:ebay:apis:eBLBaseComponents',
  505. 'array' => false,
  506. 'cardinality' => '0..1'
  507. ),
  508. 'IncludeCondition' =>
  509. array(
  510. 'required' => false,
  511. 'type' => 'boolean',
  512. 'nsURI' => 'http://www.w3.org/2001/XMLSchema',
  513. 'array' => false,
  514. 'cardinality' => '0..1'
  515. ),
  516. 'IncludeFeedback' =>
  517. array(
  518. 'required' => false,
  519. 'type' => 'boolean',
  520. 'nsURI' => 'http://www.w3.org/2001/XMLSchema',
  521. 'array' => false,
  522. 'cardinality' => '0..1'
  523. ),
  524. 'LocalSearchPostalCode' =>
  525. array(
  526. 'required' => false,
  527. 'type' => 'string',
  528. 'nsURI' => 'http://www.w3.org/2001/XMLSchema',
  529. 'array' => false,
  530. 'cardinality' => '0..1'
  531. ),
  532. 'MaxRelatedSearchKeywords' =>
  533. array(
  534. 'required' => false,
  535. 'type' => 'int',
  536. 'nsURI' => 'http://www.w3.org/2001/XMLSchema',
  537. 'array' => false,
  538. 'cardinality' => '0..1'
  539. ),
  540. 'Group' =>
  541. array(
  542. 'required' => false,
  543. 'type' => 'GroupType',
  544. 'nsURI' => 'urn:ebay:apis:eBLBaseComponents',
  545. 'array' => false,
  546. 'cardinality' => '0..1'
  547. ),
  548. 'HideDuplicateItems' =>
  549. array(
  550. 'required' => false,
  551. 'type' => 'boolean',
  552. 'nsURI' => 'http://www.w3.org/2001/XMLSchema',
  553. 'array' => false,
  554. 'cardinality' => '0..1'
  555. )
  556. ));
  557. }
  558. }
  559. ?>