de.hybris.platform.sap.sapordermgmtservices.bolfacade

Interface BolOrderFacade

All Known Implementing Classes:

DefaultBolOrderFacade

public interface BolOrderFacade

Serves as facade to the BOL layer, allowing access to the order related business objects. Covers the access to a single order and the order search functions.

Method Summary

Modifier and Type	Method and Description
int	getDateRange() Returning the date range for order search from configuration, also see SAPConfigurationModel.getSapordermgmt_dateRange().
Order	getSavedOrder(java.lang.String orderId) Return order details for an order existing in the back end persistence.
java.lang.Integer	getSearchResultsTotalNumber() Get total number of orders found in the last back end call, not taking any pagination into account.
java.util.List<SortData>	getSearchSort() Returning the current search sort options, allowing to access them even if the UI does not specify them in each call.
java.util.List<SearchResult>	performSearch(SearchFilter searchFilter, PageableData pageableData) Performs search for orders.
void	setSearchDirty() Allows to state that the search result is dirty, i.e.

Method Detail

getSearchResultsTotalNumber

java.lang.Integer getSearchResultsTotalNumber()

Get total number of orders found in the last back end call, not taking any pagination into account. The call does not perform a search itself, but refers to the results of the last call of performSearch(SearchFilter, PageableData)

Returns:

Total number of orders

getSavedOrder

Order getSavedOrder(java.lang.String orderId)

Return order details for an order existing in the back end persistence. Cannot be called for non-persisted orders in checkout.

Parameters:

orderId - Back end ID of the order

Returns:

BOL representation of order

performSearch

java.util.List<SearchResult> performSearch(SearchFilter searchFilter,
                                           PageableData pageableData)

Performs search for orders. Will either access the back end, if no search has been performed so far or the search result is dirty (see setSearchDirty(), or will perform paging and sorting on the existing search result, without doing a back end call

Parameters:

searchFilter - Filter data

pageableData - Paging data as requested in the hybris service layer

Returns:

List of BOL search results

getDateRange

int getDateRange()

Returning the date range for order search from configuration, also see SAPConfigurationModel.getSapordermgmt_dateRange(). This range specifies the number of days the search will cover.
Example: 365 means search is done for the last year

Returns:

Date range in days

getSearchSort

java.util.List<SortData> getSearchSort()

Returning the current search sort options, allowing to access them even if the UI does not specify them in each call.

Returns:

The current sort options

setSearchDirty

void setSearchDirty()

Allows to state that the search result is dirty, i.e. search results need to be re-populated from the back end. If the search is not dirty, calls to the BOL layer will just perform pagination and sorting.