Interface OrderReadServiceInterface

Interface OrderReadServiceInterface

Direct known implementers

OrderReadService

Package: Order\Interfaces
Category: System
Located at Services/Core/Order/Interfaces/OrderReadServiceInterface.inc.php

Methods summary

public getOrderById( IdType $orderId ) : Order

Returns an order, depending on the provided order ID.

public getOrderItemById( IdType $orderItemId ) : StoredOrderItemInterface

Returns a stored order item, depending on the provided order item ID.

public getOrderList( IntType $startIndex = null, IntType $maxCount = null, StringType $orderBy = null ) : OrderListItemCollection

Returns an OrderListItemCollection depending on the provided arguments.

public filterOrderList( array $filterParameters, IntType $startIndex = null, IntType $maxCount = null, StringType $orderBy = null ) : OrderListItemCollection

Filter the order records with specific conditions.

public filterOrderListCount( array $filterParameters ) : integer

Get the filtered orders count.

public getOrderListByCustomerId( IdType $customerId, IntType $startIndex = null, IntType $maxCount = null, StringType $orderBy = null ) : OrderListItemCollection

Returns an OrderListItemCollection depending on the provided customer ID.

public getOrderListByOrderStatusId( IntType $orderStatusId, IntType $startIndex = null, IntType $maxCount = null, StringType $orderBy = null ) : OrderListItemCollection

Returns an OrderListItemCollection depending on the provided order status ID.

public getOrderListByKeyword( StringType $keyword, IntType $startIndex = null, IntType $maxCount = null, StringType $orderBy = null ) : OrderListItemCollection

Filter the order list by a string keyword.

public getOrderListByKeywordCount( StringType $keyword ) : integer

Get Count of orders filtered by keyword

public getOrderListCount( void ) : integer

Get the total count of all orders