com.elasticpath.cmweb.reportservice
Interface OrderReportService

All Superinterfaces:
EpService
All Known Implementing Classes:
OrderReportServiceImpl

public interface OrderReportService
extends EpService

This service provides access to functionality and data (beans) for manipulating order on the Javascript client.


Method Summary
 int getOrderCountByStatus(int orderStatusCode)
          Get the order count by status.
 java.util.List orderSummaryReport(java.util.Date startDate, java.util.Date endDate, java.lang.Boolean cancelled)
          List order summary based on create date and whether the order is cancelled.
 java.util.List orderTotalStatsReport(java.util.Date startDate, java.util.Date endDate, java.lang.String currencyCode, boolean cancelled)
          List order total stats based on create date, currency and whether the order is cancelled.
 
Methods inherited from interface com.elasticpath.service.EpService
getElasticPath, setElasticPath
 

Method Detail

getOrderCountByStatus

int getOrderCountByStatus(int orderStatusCode)
Get the order count by status.

Parameters:
orderStatusCode - the order status code
Returns:
the number of orders with that status.

orderSummaryReport

java.util.List orderSummaryReport(java.util.Date startDate,
                                  java.util.Date endDate,
                                  java.lang.Boolean cancelled)
List order summary based on create date and whether the order is cancelled.

Parameters:
startDate - the start date of the report.
endDate - the end date of the report.
cancelled - include cancelled orders.
Returns:
a list of order summary's.

orderTotalStatsReport

java.util.List orderTotalStatsReport(java.util.Date startDate,
                                     java.util.Date endDate,
                                     java.lang.String currencyCode,
                                     boolean cancelled)
List order total stats based on create date, currency and whether the order is cancelled.

Parameters:
startDate - the start date of the report.
endDate - the end date of the report.
currencyCode - ISO-4217 currency code
cancelled - include cancelled orders.
Returns:
a list of order total statistics (# orders, # items, total).