Package de.hybris.platform.b2ctelcofacades.order

Interface TmaOrderFacade

All Superinterfaces:

de.hybris.platform.commercefacades.order.OrderFacade

All Known Implementing Classes:

DefaultTmaB2bOrderFacade, DefaultTmaOrderFacade

public interface TmaOrderFacade
extends de.hybris.platform.commercefacades.order.OrderFacade

Facade that handles operations related to OrderData.

Since:

2102

Method Summary

Modifier and Type	Method	Description
boolean	canUserUpdateOrderStatus(String principalId, String authenticatedUserId, String orderId)	Checks if a specific user can update the status of an order.
Integer	getNumberOfOrders(TmaProductOrderFilterContextData productOrderFilterContextData)	Retrieves the total number of product orders found for the given filtering context.
OrderData	getOrderDetails(String code, String relatedPartyId)	Returns the details of an Order.
OrderData	getOrderForCode(String code)	Returns the details of an order.
List<OrderData>	getOrders(String principalId)	Provides the list of orders related to the principal provided by its id.
List<OrderData>	getOrdersByLimitAndOffset(TmaProductOrderFilterContextData productOrderFilterContextData, Integer offset, Integer limit)	Retrieves a list of product orders filtered by context
boolean	hasUserAccessToOrders(String authenticatedUserId, String principalId)	Checks if authenticated user provided by its id is able to access any orders related to the principal provided by its id.
void	updateStatus(String code, String principalId, String status)	Updates the status of the order.

Methods inherited from interface de.hybris.platform.commercefacades.order.OrderFacade

getOrderDetailsForCode, getOrderDetailsForCodeWithoutUser, getOrderDetailsForGUID, getOrderHistoryForStatuses, getPagedOrderHistoryForStatuses

Method Details

getOrderDetails

OrderData getOrderDetails(String code,
 String relatedPartyId)

Returns the details of an Order.

Parameters:

code - The id of the Order for which to retrieve the detail.

relatedPartyId - The id of the customer who owns the order

Returns:

The detail of the order with matching code and relatedPartyId

getOrders

List<OrderData> getOrders(String principalId)

Provides the list of orders related to the principal provided by its id.

Parameters:

principalId - The id of the principal having access to orders

Returns:

the list of orders related to the principal provided by its id

updateStatus

void updateStatus(String code,
 String principalId,
 String status)
           throws IllegalAccessException

Updates the status of the order.

Parameters:

code - The identifier of the order

principalId - The identifier of the principal

status - The new status

Throws:

IllegalAccessException - If the order status updated is not allowed

hasUserAccessToOrders

boolean hasUserAccessToOrders(String authenticatedUserId,
 String principalId)

Checks if authenticated user provided by its id is able to access any orders related to the principal provided by its id.

Parameters:

authenticatedUserId - The identifier of the authenticated user

principalId - The identifier of the principal for which the request was made

Returns:

True if user can access orders related to the principal, false otherwise

canUserUpdateOrderStatus

boolean canUserUpdateOrderStatus(String principalId,
 String authenticatedUserId,
 String orderId)

Checks if a specific user can update the status of an order.

Parameters:

principalId - The owner of the order

authenticatedUserId - The identifier of the authenticated user

orderId - The identifier of the order

Returns:

True if authenticated user has the right to updated the status of the specified order, false otherwise

getOrdersByLimitAndOffset

List<OrderData> getOrdersByLimitAndOffset(TmaProductOrderFilterContextData productOrderFilterContextData,
 Integer offset,
 Integer limit)

Retrieves a list of product orders filtered by context

Parameters:

productOrderFilterContextData - the context.

offset - the offset represents the position in list from where the result list will start.

limit - the limit represents the number of entries that will be selected for the result list.

Returns:

the list of product orders.

getNumberOfOrders

Integer getNumberOfOrders(TmaProductOrderFilterContextData productOrderFilterContextData)

Retrieves the total number of product orders found for the given filtering context.

Parameters:

productOrderFilterContextData - the filtering context.

Returns:

the number of product orders.

getOrderForCode

OrderData getOrderForCode(String code)

Returns the details of an order.

Parameters:

code - The id of the order for which to retrieve the detail.

Returns:

The detail of the order with matching code.