RequestInterface.php 1.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  1. <?php
  2. /**
  3. * Copyright © Magento, Inc. All rights reserved.
  4. * See COPYING.txt for license details.
  5. */
  6. namespace Magento\Framework\Search;
  7. use Magento\Framework\Search\Request\BucketInterface as RequestBucketInterface;
  8. use Magento\Framework\Search\Request\Dimension;
  9. use Magento\Framework\Search\Request\QueryInterface;
  10. /**
  11. * Search Request
  12. *
  13. * @api
  14. * @since 100.0.2
  15. */
  16. interface RequestInterface
  17. {
  18. /**
  19. * Get Name
  20. *
  21. * @return string
  22. */
  23. public function getName();
  24. /**
  25. * Get Index name
  26. *
  27. * @return string
  28. */
  29. public function getIndex();
  30. /**
  31. * Get all dimensions
  32. *
  33. * @return Dimension[]
  34. */
  35. public function getDimensions();
  36. /**
  37. * Get Aggregation Buckets
  38. *
  39. * @return RequestBucketInterface[]
  40. */
  41. public function getAggregation();
  42. /**
  43. * Get Main Request Query
  44. *
  45. * @return QueryInterface
  46. */
  47. public function getQuery();
  48. /**
  49. * Get From
  50. *
  51. * @return int|null
  52. */
  53. public function getFrom();
  54. /**
  55. * Get Size
  56. *
  57. * @return int|null
  58. */
  59. public function getSize();
  60. }