Package org.cyclos.impl.marketplace

Class OrderServiceImpl

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.impl.BaseServiceImpl

org.cyclos.impl.CRUDServiceImpl<Order,QOrder,OrderDTO,OrderData,OrderDataParams>

org.cyclos.impl.marketplace.OrderServiceImpl

All Implemented Interfaces:

CRUDServiceLocal<Order,OrderDTO,OrderData,OrderDataParams>, OrderServiceLocal, CRUDService<OrderDTO,OrderData,OrderDataParams>, CRUDWithConfirmationPasswordService<OrderDTO,OrderData,OrderDataParams>, OrderService, Service

@Service
public class OrderServiceImpl
extends CRUDServiceImpl<Order,QOrder,OrderDTO,OrderData,OrderDataParams>
implements OrderServiceLocal

implementation for OrderService

Field Summary

Fields inherited from class org.cyclos.impl.CRUDServiceImpl

$, ATTR_CURRENT_COPY, cacheHandler, dtoClass, entityClass, extensionPointService, idPath, internalNamePath, namePath, ownerEntityIdPath, ownerEntityPath, ownerEntityPropertyName, richTextHandler, withConfirmationPassword

Fields inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

authHandler, conversionHandler, customFieldValueHandler, entityManagerHandler, groupsHandler, productsHandler, restBeanPropertyMapping, userLocatorHandler

Fields inherited from class org.cyclos.impl.AbstractServerComponent

accountHandler, configurationHandler, dataTranslationHandler, notificationHandler, profileFieldHandler, transactionHandler, translationHandler

Constructor Summary

Constructors

Constructor	Description
OrderServiceImpl()

Method Summary

Modifier and Type	Method	Description
OrderStatus	accept(AcceptOrderParams params)	Accepts the given order, which should be in either OrderStatus.PENDING_BUYER or OrderStatus.PENDING_SELLER status, and needs the delivery price to be already set.
int	addToCart(BasicAdVO adVO, BigDecimal quantity)	Adds the given product to the logged user's shopping cart, returning the total count of ads in the cart. When the given quantity is null, the minimum allowed quantity on the shopping cart for the given product is assumed
ShoppingCartDTO	adjustAndGetMyCart()	Returns the current logged user's shopping cart, adjusting all quantities
OrderData	adjustShoppingCartAndGetData(OrderVO vo)	Perform adjustments to the shopping cart quantities and returns the data for it
int	cancelOrdersInCurrencies(User user, Collection<Currency> currencies)	Cancels all pending orders which are linked to the given currencies
int	cancelWithReservedAmount(UserAccount account)	Cancels all pending orders which have amount reserved on the given account
void	checkCartStock(UserLocatorVO sellerVO, CurrencyVO currencyVO)	Checks that all items on the given cart are still on stock
ShoppingCartCheckoutResult	checkout(ShoppingCartCheckoutParams dto)	Checks out the logged user's shopping cart with the given seller and currency, checking the confirmation password (if any), and reserving the amount when the delivery price is previously known (otherwise, the buyer still needs to confirm before the payment is done).
int	countCartItems()	Returns the total number of items in the logged user's shopping cart
Integer	countPending(User user, boolean asSeller, OrderStatus status, Date since)	Counts pending orders for the current logged user as either seller or buyer, since the given time, or all time if null
FileInfo	exportOrder(ExportFormatVO formatVO, OrderVO orderVO)	Exports the given order to file
Order	findByOrderNumber(String orderNumber)	Returns an order by order number, or throws EntityNotFoundException if not found
OrderData	getCheckoutData(UserLocatorVO sellerVO, CurrencyVO currencyVO)	Returns data for checkout the cart items of the given seller and currency
protected OrderData	getData(Order order)	Returns details data for the given entity
protected Object[]	getExcludedPropertiesToEntity(OrderDTO dto)	May be overridden in order to exclude properties when converting the given DTO to entity
ShoppingCartDTO	getMyCart()	Returns the current logged user's shopping cart, without adjusting any quantity
OrderData	getOrderData(OrderVO vo)	Returns data of an order
long	getOrderId(OrderVO order)	Return the id of the given order only if the logged user can see the order.
OrderSearchData	getSearchData(@NotNull UserLocatorVO locator, boolean sales)	Returns data for searching orders / sales
boolean	hasPurchases(User user)	Returns whether the given user has ever finished a purchase
boolean	hasSales(User user)	Returns whether the given user has ever finished a sale
void	initialize()
int	modifyQuantityOnCart(BasicAdVO adVO, BigDecimal quantity)	Updates the quantity for the given product on the logged user's shopping cart returning the total count of ads in the cart.
Order	newEntity(OrderDataParams params)	Should be implemented in order to instantiate a new entity based on the given context parameters
protected void	onAfterSave(Order entity, Order currentCopy, Object dataFromOnBeforeSave)	May be overridden in order to perform custom logic after saving an entity
protected Object	onBeforeSave(Order order, Order currentCopy)	May be overridden in order to perform custom logic before saving an entity.
protected void	registerNetworkMappings(NetworkPathRegistry networkPathRegistry)	Needs to be overridden by subclasses to register the path up to the network
void	reject(RejectOrderParams params)	Rejects the given order
int	removeCart(UserLocatorVO sellerVO, CurrencyVO currencyVO)	Removes the logged user's shopping cart for the given seller and currency returning the remaining count of ads in the cart
int	removeCartById(Long id)	Same as CRUDService.remove(Long) but returning the total count of items present the whole shopping cart
int	removeCartItem(BasicAdVO adVO)	Removes the given product from the logged user's shopping cart returning the remaining count of ads in the cart.
protected Validator	resolveValidator(OrderDTO dto)
Page<OrderVO>	search(OrderQuery params)	Searches for orders based on OrderQuery
void	setDeliveryMethod(SetDeliveryMethodParams params)	Updates the delivery method information of an order when it is on the OrderStatus.PENDING_SELLER status and there is no delivery information yet.
Long	submitToBuyer(OrderDTO dto)	Submits the given order for buyer approval
OrderDTO	toDTO(Order entity)	Converts the given entity in a DTO, handling the CRUDServiceImpl.subClassMappings() mappings for subclasses
Order	toEntity(OrderDTO dto)	Converts the given DTO in an entity, handling the CRUDServiceImpl.subClassMappings() mappings for subclasses

Methods inherited from class org.cyclos.impl.CRUDServiceImpl

addCustomInternalNameValidations, addCustomNameValidations, checkConfirmationPassword, doRemove, find, findAll, from, getConfirmationPasswordInput, getConfirmationPasswordInputForRemove, getData, getDataForNew, getDeviceConfirmationParams, getEntityClass, getEntityInternalNameKey, getExcludedPropertiesToDTO, getNameLabel, getUniqueInternalNameQuery, getUniqueNameQuery, isEntityInternalNameRequired, isNameRequired, load, logEntity, onAfterRemove, onBeforeRemove, preProcessCurrentCopy, remove, remove, removeAll, removeAll, removeAllWithConfirmationPassword, removeWithConfirmationPassword, resolveDTOType, resolveEntityType, resolveExtensionPointAccessor, save, saveOrder, saveSkippingEntityLog, saveWithConfirmationPassword, shouldCheckConfirmationPassword, subClassMappings, validate

Methods inherited from class org.cyclos.impl.BaseServiceImpl

initializeNetworkMappings

Methods inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

canManage, checkManagesUser, checkPermission, checkRelatesToUser, checkValue, clearAlreadyValidated, getBaseEntityManagerHandler, getConfiguration, getLoggedBasicUser, getLoggedUser, getProducts, getTranslatedName, getTranslatedValue, hasPermission, hasValue, inSameNetwork, inSameNetworkOrGlobal, isAdmin, isAlreadyValidated, isBroker, isGlobalAdmin, isGlobalAdminInNetwork, isGuest, isLoggedIn, isMember, isMemberOnly, isNetworkAdmin, isOperator, isRelatedToUser, isSystem, isUserManager, isUserManagerOf, message, message, permission, permission, permissionOptionalValue, permissionOptionalValue, setAlreadyValidated, toDate, toDateTime, validate

Methods inherited from class org.cyclos.impl.AbstractServerComponent

dataTranslationProxy, dataTranslationProxy, delete, detach, doDataTranslationProxy, find, flush, from, getApplicationContext, getFormatter, getFormatter, getFormatter, getLogger, getRemoteAddress, getSessionData, mailContentBuilder, message, message, persist, processBatch, processBatch, refresh, remove, selectFrom, subQuery, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.cyclos.services.CRUDService

getData, getDataForNew, load, remove, removeAll, save

Methods inherited from interface org.cyclos.impl.CRUDServiceLocal

find, findAll, getEntityClass, remove, removeAll, saveEntity, saveSkippingEntityLog, validate

Constructor Detail

OrderServiceImpl

public OrderServiceImpl()

Method Detail

accept

public OrderStatus accept(AcceptOrderParams params)
                   throws FrameworkException,
                          TransferException,
                          PasswordException

Description copied from interface: OrderService

Accepts the given order, which should be in either OrderStatus.PENDING_BUYER or OrderStatus.PENDING_SELLER status, and needs the delivery price to be already set. When the buyer hasn't yet chosen a payment type, it is required now. Also, when no amount was reserved, the confirmation password will be checked before performing the actual payment.

Specified by:

accept in interface OrderService

Throws:

PasswordException - The given confirmation password is invalid

IllegalActionException - The given order is not in either OrderStatus.PENDING_BUYER or OrderStatus.PENDING_SELLER status

TransferException - When there was a problem while reserving the amount, like there is no available balance

FrameworkException

addToCart

public int addToCart(BasicAdVO adVO,
                     BigDecimal quantity)
              throws FrameworkException,
                     OutOfStockException,
                     CannotBuyException

Description copied from interface: OrderService

Adds the given product to the logged user's shopping cart, returning the total count of ads in the cart.
When the given quantity is null, the minimum allowed quantity on the shopping cart for the given product is assumed

Specified by:

addToCart in interface OrderService

Throws:

OutOfStockException - When the given quantity is greater than the available stock

FrameworkException

CannotBuyException

adjustAndGetMyCart

public ShoppingCartDTO adjustAndGetMyCart()
                                   throws FrameworkException

Description copied from interface: OrderService

Returns the current logged user's shopping cart, adjusting all quantities

Specified by:

adjustAndGetMyCart in interface OrderService

Throws:

FrameworkException

adjustShoppingCartAndGetData

public OrderData adjustShoppingCartAndGetData(OrderVO vo)
                                       throws FrameworkException

Description copied from interface: OrderService

Perform adjustments to the shopping cart quantities and returns the data for it

Specified by:

adjustShoppingCartAndGetData in interface OrderService

Throws:

FrameworkException

cancelOrdersInCurrencies

public int cancelOrdersInCurrencies(User user,
                                    Collection<Currency> currencies)

Description copied from interface: OrderServiceLocal

Cancels all pending orders which are linked to the given currencies

Specified by:

cancelOrdersInCurrencies in interface OrderServiceLocal

cancelWithReservedAmount

public int cancelWithReservedAmount(UserAccount account)

Description copied from interface: OrderServiceLocal

Cancels all pending orders which have amount reserved on the given account

Specified by:

cancelWithReservedAmount in interface OrderServiceLocal

checkCartStock

public void checkCartStock(UserLocatorVO sellerVO,
                           CurrencyVO currencyVO)
                    throws FrameworkException,
                           OutOfStockException

Description copied from interface: OrderService

Checks that all items on the given cart are still on stock

Specified by:

checkCartStock in interface OrderService

Throws:

FrameworkException

OutOfStockException

checkout

public ShoppingCartCheckoutResult checkout(ShoppingCartCheckoutParams dto)

Description copied from interface: OrderService

Checks out the logged user's shopping cart with the given seller and currency, checking the confirmation password (if any), and reserving the amount when the delivery price is previously known (otherwise, the buyer still needs to confirm before the payment is done).

Specified by:

checkout in interface OrderService

Returns:

A result containing the order and the remaining webshop ads added to the shopping cart.

countCartItems

public int countCartItems()
                   throws FrameworkException

Description copied from interface: OrderService

Returns the total number of items in the logged user's shopping cart

Specified by:

countCartItems in interface OrderService

Throws:

FrameworkException

countPending

public Integer countPending(User user,
                            boolean asSeller,
                            OrderStatus status,
                            Date since)

Description copied from interface: OrderServiceLocal

Counts pending orders for the current logged user as either seller or buyer, since the given time, or all time if null

Specified by:

countPending in interface OrderServiceLocal

exportOrder

public FileInfo exportOrder(ExportFormatVO formatVO,
                            OrderVO orderVO)
                     throws FrameworkException

Description copied from interface: OrderService

Exports the given order to file

Specified by:

exportOrder in interface OrderService

Throws:

FrameworkException

findByOrderNumber

public Order findByOrderNumber(String orderNumber)

Description copied from interface: OrderServiceLocal

Returns an order by order number, or throws EntityNotFoundException if not found

Specified by:

findByOrderNumber in interface OrderServiceLocal

getCheckoutData

public OrderData getCheckoutData(UserLocatorVO sellerVO,
                                 CurrencyVO currencyVO)

Description copied from interface: OrderService

Returns data for checkout the cart items of the given seller and currency

Specified by:

getCheckoutData in interface OrderService

getMyCart

public ShoppingCartDTO getMyCart()

Description copied from interface: OrderService

Returns the current logged user's shopping cart, without adjusting any quantity

Specified by:

getMyCart in interface OrderService

getOrderData

public OrderData getOrderData(OrderVO vo)
                       throws FrameworkException

Description copied from interface: OrderService

Returns data of an order

Specified by:

getOrderData in interface OrderService

Throws:

FrameworkException

getOrderId

public long getOrderId(OrderVO order)
                throws FrameworkException

Description copied from interface: OrderService

Return the id of the given order only if the logged user can see the order.

Specified by:

getOrderId in interface OrderService

Throws:

FrameworkException

getSearchData

public OrderSearchData getSearchData(@NotNull
                                     @NotNull UserLocatorVO locator,
                                     boolean sales)
                              throws FrameworkException

Description copied from interface: OrderService

Returns data for searching orders / sales

Specified by:

getSearchData in interface OrderService

Throws:

FrameworkException

hasPurchases

public boolean hasPurchases(User user)

Description copied from interface: OrderServiceLocal

Returns whether the given user has ever finished a purchase

Specified by:

hasPurchases in interface OrderServiceLocal

hasSales

public boolean hasSales(User user)

Description copied from interface: OrderServiceLocal

Returns whether the given user has ever finished a sale

Specified by:

hasSales in interface OrderServiceLocal

initialize

@PostConstruct
public void initialize()

modifyQuantityOnCart

public int modifyQuantityOnCart(BasicAdVO adVO,
                                BigDecimal quantity)
                         throws FrameworkException,
                                IllegalActionException,
                                OutOfStockException

Description copied from interface: OrderService

Updates the quantity for the given product on the logged user's shopping cart returning the total count of ads in the cart.

Specified by:

modifyQuantityOnCart in interface OrderService

Throws:

IllegalActionException - When the given ad is not in the logged user's shopping cart

OutOfStockException - When the new quantity is greater than the available stock

FrameworkException

newEntity

public Order newEntity(OrderDataParams params)

Description copied from class: CRUDServiceImpl

Should be implemented in order to instantiate a new entity based on the given context parameters

Specified by:

newEntity in interface CRUDServiceLocal<Order,OrderDTO,OrderData,OrderDataParams>

Specified by:

newEntity in class CRUDServiceImpl<Order,QOrder,OrderDTO,OrderData,OrderDataParams>

reject

public void reject(RejectOrderParams params)
            throws FrameworkException

Description copied from interface: OrderService

Rejects the given order

Specified by:

reject in interface OrderService

Throws:

IllegalActionException - When the given order is not in either OrderStatus.PENDING_BUYER or OrderStatus.PENDING_SELLER statuses.

FrameworkException

removeCart

public int removeCart(UserLocatorVO sellerVO,
                      CurrencyVO currencyVO)

Description copied from interface: OrderService

Removes the logged user's shopping cart for the given seller and currency returning the remaining count of ads in the cart

Specified by:

removeCart in interface OrderService

removeCartById

public int removeCartById(Long id)
                   throws EntityNotFoundException,
                          DataAccessException,
                          ValidationException

Description copied from interface: OrderService

Same as CRUDService.remove(Long) but returning the total count of items present the whole shopping cart

Specified by:

removeCartById in interface OrderService

Throws:

EntityNotFoundException

DataAccessException

ValidationException

See Also:

CRUDService.remove(java.lang.Long)

removeCartItem

public int removeCartItem(BasicAdVO adVO)
                   throws FrameworkException

Description copied from interface: OrderService

Removes the given product from the logged user's shopping cart returning the remaining count of ads in the cart.

Specified by:

removeCartItem in interface OrderService

Throws:

IllegalActionException - When the given ad is not in the logged user's shopping cart

FrameworkException

search

public Page<OrderVO> search(OrderQuery params)

Description copied from interface: OrderService

Searches for orders based on OrderQuery

Specified by:

search in interface OrderService

setDeliveryMethod

public void setDeliveryMethod(SetDeliveryMethodParams params)
                       throws FrameworkException

Description copied from interface: OrderService

Updates the delivery method information of an order when it is on the OrderStatus.PENDING_SELLER status and there is no delivery information yet. Afterwards, the new status will be OrderStatus.PENDING_BUYER for final approval.

Specified by:

setDeliveryMethod in interface OrderService

Throws:

IllegalActionException - When the referenced order is not on the OrderStatus.PENDING_SELLER status or already has delivery information

FrameworkException

submitToBuyer

public Long submitToBuyer(OrderDTO dto)
                   throws FrameworkException

Description copied from interface: OrderService

Submits the given order for buyer approval

Specified by:

submitToBuyer in interface OrderService

Throws:

FrameworkException

toDTO

public OrderDTO toDTO(Order entity)

Description copied from class: CRUDServiceImpl

Converts the given entity in a DTO, handling the CRUDServiceImpl.subClassMappings() mappings for subclasses

Specified by:

toDTO in interface CRUDServiceLocal<Order,OrderDTO,OrderData,OrderDataParams>

Overrides:

toDTO in class CRUDServiceImpl<Order,QOrder,OrderDTO,OrderData,OrderDataParams>

toEntity

public Order toEntity(OrderDTO dto)

Description copied from class: CRUDServiceImpl

Converts the given DTO in an entity, handling the CRUDServiceImpl.subClassMappings() mappings for subclasses

Specified by:

toEntity in interface CRUDServiceLocal<Order,OrderDTO,OrderData,OrderDataParams>

Overrides:

toEntity in class CRUDServiceImpl<Order,QOrder,OrderDTO,OrderData,OrderDataParams>

getData

protected OrderData getData(Order order)

Description copied from class: CRUDServiceImpl

Returns details data for the given entity

Specified by:

getData in class CRUDServiceImpl<Order,QOrder,OrderDTO,OrderData,OrderDataParams>

getExcludedPropertiesToEntity

protected Object[] getExcludedPropertiesToEntity(OrderDTO dto)

Description copied from class: CRUDServiceImpl

May be overridden in order to exclude properties when converting the given DTO to entity

Overrides:

getExcludedPropertiesToEntity in class CRUDServiceImpl<Order,QOrder,OrderDTO,OrderData,OrderDataParams>

onAfterSave

protected void onAfterSave(Order entity,
                           Order currentCopy,
                           Object dataFromOnBeforeSave)

Description copied from class: CRUDServiceImpl

May be overridden in order to perform custom logic after saving an entity

Overrides:

onAfterSave in class CRUDServiceImpl<Order,QOrder,OrderDTO,OrderData,OrderDataParams>

onBeforeSave

protected Object onBeforeSave(Order order,
                              Order currentCopy)

Description copied from class: CRUDServiceImpl

May be overridden in order to perform custom logic before saving an entity. Any returned value will be passed to the CRUDServiceImpl.onAfterSave(BaseEntity, BaseEntity, Object) method

Overrides:

onBeforeSave in class CRUDServiceImpl<Order,QOrder,OrderDTO,OrderData,OrderDataParams>

registerNetworkMappings

protected void registerNetworkMappings(NetworkPathRegistry networkPathRegistry)

Description copied from class: BaseServiceImpl

Needs to be overridden by subclasses to register the path up to the network

Specified by:

registerNetworkMappings in class BaseServiceImpl

resolveValidator

protected Validator resolveValidator(OrderDTO dto)

Specified by:

resolveValidator in class CRUDServiceImpl<Order,QOrder,OrderDTO,OrderData,OrderDataParams>