1 <?php
2
3 /* --------------------------------------------------------------
4 OrderListGeneratorInterface.inc.php 2015-11-05
5 Gambio GmbH
6 http://www.gambio.de
7 Copyright (c) 2015 Gambio GmbH
8 Released under the GNU General Public License (Version 2)
9 [http://www.gnu.org/licenses/gpl-2.0.html]
10 --------------------------------------------------------------
11 */
12
13 /**
14 * Interface OrderListGeneratorInterface
15 *
16 * @category System
17 * @package Order
18 * @subpackage Interfaces
19 */
20 interface OrderListGeneratorInterface
21 {
22 /**
23 * Returns an order list item collection.
24 *
25 * @param array $conditions Associative array which holds the CI_DB_query_builder conditions (default empty
26 * array).
27 * @param IntType $startIndex The start index of the wanted array to be returned (default = null).
28 * @param IntType $maxCount Maximum amount of items which should be returned (default = null).
29 * @param StringType $orderBy A string which defines how the items should be ordered (default = null).
30 *
31 * @return OrderListItemCollection Order list item collection.
32 */
33 public function getOrderListByConditions(array $conditions = array(),
34 IntType $startIndex = null,
35 IntType $maxCount = null,
36 StringType $orderBy = null);
37
38
39 /**
40 * Filters records by a single keyword string.
41 *
42 * @param StringType $keyword Keyword string to be used for searching in order records.
43 * @param IntType|null $startIndex The start index of the wanted array to be returned (default = null).
44 * @param IntType|null $maxCount Maximum amount of items which should be returned (default = null).
45 * @param StringType|null $orderBy A string which defines how the items should be ordered (default = null).
46 *
47 * @return OrderListItemCollection Order list item collection.
48 */
49 public function getOrderListByKeyword(StringType $keyword,
50 IntType $startIndex = null,
51 IntType $maxCount = null,
52 StringType $orderBy = null);
53
54
55 }
56