public interface OrderMgrIf
Modifier and Type | Method and Description |
---|---|
void |
addManufacturerAddr(Order order,
boolean allStores)
Only for TCPOS, add manufacturer address to order
|
Order |
changeDeliveryAddress(java.lang.String sessionId,
OrderIf order,
AddressIf deliveryAddress)
The current delivery address is substituted with the new one.
|
void |
changeOrderStatus(int orderId,
int status,
boolean customerNotified,
java.lang.String comments)
The state of the current order id changed and an orders_status_history record is added to the
order to keep track of the change.
|
void |
changeOrderStatus(java.lang.String sessionId,
int orderId,
int status,
boolean customerNotified,
java.lang.String comments)
The state of the current order id changed and an orders_status_history record is added to the
order to keep track of the change.
|
Order |
createAndSaveOrder(java.lang.String emailAddr,
java.lang.String password,
CustomerRegistrationIf custReg,
BasketIf[] basketItemArray,
java.lang.String shippingModule,
java.lang.String paymentModule,
int languageId) |
Order |
createOrder(java.lang.String sessionId,
BasketIf[] basketItemArray,
int languageId)
An order object is returned with all addresses populated with the default address of the
customer referenced by the session Id.
|
Order |
createOrderWithOptions(java.lang.String sessionId,
BasketIf[] basketItemArray,
CreateOrderOptionsIf options,
int languageId)
An order object is returned with all addresses populated with the default address of the
customer referenced by the session Id.
|
void |
deleteOrderIdForSecretKey(java.lang.String secretKey)
The order id stored in the database and indexed by the secretKey, is deleted
|
void |
escapeOrder(OrderIf order)
Escape the Strings in the Order object using the rules defined in the properties file by
the property konakart.escape.chars .
|
OrderStatus[] |
getAllOrderStatuses(int languageId)
Returns an array of Order Status objects for a given language
|
IpnHistory[] |
getIpnHistory(int orderId)
Retrieve an array of IpnHistory objects for an order.
|
IpnHistory[] |
getIpnHistory(java.lang.String sessionId,
int orderId)
Retrieve an array of IpnHistory objects for an order.
|
Order |
getOrder(java.lang.String sessionId,
int orderId,
int languageId)
Retrieve an order for the customer referenced by the sessionId.
|
Order |
getOrderForOrderId(int orderId,
int languageId)
Retrieve an order for an orderId.
|
int |
getOrderIdFromSecretKey(java.lang.String secretKey)
The order id stored in the database and indexed by the secretKey, is returned
|
Orders |
getOrdersPerCustomer(DataDescriptorIf dataDesc,
java.lang.String sessionId,
int languageId)
Retrieve a number of orders for the customer referenced by the sessionId.
|
Orders |
getOrdersPerCustomerWithOptions(DataDescriptorIf dataDescIn,
java.lang.String sessionId,
int languageId,
FetchOrderOptionsIf options)
Retrieve a number of orders for the customer referenced by the sessionId.
|
int |
getOrderStatus(java.lang.String sessionId,
int orderId)
Get the order status for an order.
|
Order |
getOrderWithOptions(java.lang.String sessionId,
int orderId,
int languageId,
FetchOrderOptionsIf options)
Retrieve an order for the customer referenced by the sessionId.
|
java.lang.String |
getSecretKeyForOrderId(int orderId)
Every time we send a notification to a payment gateway, we get a new secret key for the
order, which is sent back to us in the reply.
|
java.lang.String |
getStatusText(int statusId,
int languageId)
Returns the text of a status from the orders_status table
|
TaxRate[] |
getTaxRateObjectsPerOrder(Order order)
Returns a list of TaxRate objects used by this order.
|
void |
refreshConfigs()
Refresh the configuration of the order manager
|
int |
saveIpnHistory(java.lang.String sessionId,
IpnHistoryIf ipnHistory)
The IpnHistory object is saved in the database.
|
int |
saveOrder(java.lang.String sessionId,
OrderIf order,
int languageId)
A new order is created in the DB.
|
int |
saveOrderWithOptions(java.lang.String sessionId,
OrderIf orderToSave,
int languageId,
SaveOrderOptionsIf options)
A new order is created in the DB.
|
Orders |
searchForOrdersPerCustomer(int customerId,
DataDescriptorIf dataDesc,
OrderSearchIf orderSearch,
int languageId)
Return orders matching the search criteria.
|
Orders |
searchForOrdersPerCustomer(java.lang.String sessionId,
DataDescriptorIf dataDesc,
OrderSearchIf orderSearch,
int languageId)
Return orders matching the search criteria.
|
void |
setCreditCardDetailsOnOrder(java.lang.String sessionId,
int orderId,
CreditCardIf card)
The credit card details in the CreditCard object passed in as a parameter, are saved in the
database for an existing order.
|
void |
setRewardPointReservationId(int customerId,
int orderId,
int reservationId)
Verifies that the order belongs to the customer identified by the
customerId
parameter and then updates the reservation id. |
void |
setRewardPointReservationId(java.lang.String sessionId,
int orderId,
int reservationId)
Verifies that the order belongs to the customer identified by the
sessionId
parameter and then updates the reservation id. |
void |
updateInventory(java.lang.String sessionId,
int orderId)
If the STOCK_LIMITED configuration variable is set to true, we subtract the products in stock
by the product orders.
|
void |
updateInventoryWithOptions(java.lang.String sessionId,
int orderId,
CreateOrderOptionsIf options)
If the STOCK_LIMITED configuration variable is set to true, we subtract the products in stock
by the product orders.
|
void |
updateOrder(int orderId,
int status,
boolean customerNotified,
java.lang.String comments,
OrderUpdateIf updateOrder)
The state of the order referenced by the orderId parameter is changed, and an
orders_status_history record is added to the order to keep track of the change.
|
void |
updateOrder(java.lang.String sessionId,
int orderId,
int status,
boolean customerNotified,
java.lang.String comments,
OrderUpdateIf updateOrder)
The state of the order referenced by the orderId parameter is changed, and an
orders_status_history record is added to the order to keep track of the change.
|
void |
updateOrder(java.lang.String sessionId,
int orderId,
int status,
boolean customerNotified,
java.lang.String comments,
java.lang.String paymentModuleSubCode,
OrderUpdateIf updateOrder)
The state of the order referenced by the orderId parameter is changed, and an
orders_status_history record is added to the order to keep track of the change.
|
int saveOrder(java.lang.String sessionId, OrderIf order, int languageId) throws java.lang.Exception
sessionId
- the sessionIdorder
- the orderlanguageId
- the languageIdjava.lang.Exception
- an unexpected exceptionint saveOrderWithOptions(java.lang.String sessionId, OrderIf orderToSave, int languageId, SaveOrderOptionsIf options) throws java.lang.Exception
sessionId
- the sessionIdorderToSave
- the orderToSavelanguageId
- the languageIdoptions
- Options object allowing you to specify the id of the order to be archivedjava.lang.Exception
- an unexpected exceptionOrder createOrder(java.lang.String sessionId, BasketIf[] basketItemArray, int languageId) throws java.lang.Exception
sessionId
- the sessionIdbasketItemArray
- the basketItemArraylanguageId
- the languageIdjava.lang.Exception
- an unexpected exceptionOrder createOrderWithOptions(java.lang.String sessionId, BasketIf[] basketItemArray, CreateOrderOptionsIf options, int languageId) throws java.lang.Exception
sessionId
- the sessionIdbasketItemArray
- the basketItemArrayoptions
- the optionslanguageId
- the languageIdjava.lang.Exception
- an unexpected exceptionvoid addManufacturerAddr(Order order, boolean allStores) throws org.apache.torque.TorqueException, com.workingdogs.village.DataSetException, java.lang.Exception
order
- the OrderallStores
- the allStorescom.workingdogs.village.DataSetException
- an unexpected exception due to data in Torque (the database layer)org.apache.torque.TorqueException
- an unexpected exception in Torque (the database layer)java.lang.Exception
- an unexpected Exception exceptionOrder changeDeliveryAddress(java.lang.String sessionId, OrderIf order, AddressIf deliveryAddress) throws java.lang.Exception
sessionId
- the sessionIdorder
- the orderdeliveryAddress
- the deliveryAddressjava.lang.Exception
- an unexpected exceptionTaxRate[] getTaxRateObjectsPerOrder(Order order) throws java.lang.Exception
order
- the orderjava.lang.Exception
- an unexpected exceptionOrders getOrdersPerCustomer(DataDescriptorIf dataDesc, java.lang.String sessionId, int languageId) throws java.lang.Exception
dataDesc
- the dataDescsessionId
- the sessionIdlanguageId
- the languageIdjava.lang.Exception
- an unexpected exceptionOrders getOrdersPerCustomerWithOptions(DataDescriptorIf dataDescIn, java.lang.String sessionId, int languageId, FetchOrderOptionsIf options) throws java.lang.Exception
Options object allows you to define whether the orders may be orders belonging to a customer within the hierarchy of the customer referenced by the sessionId.
dataDescIn
- the dataDescInsessionId
- the sessionIdlanguageId
- the languageIdoptions
- the optionsjava.lang.Exception
- an unexpected exceptionOrder getOrder(java.lang.String sessionId, int orderId, int languageId) throws java.lang.Exception
sessionId
- the sessionIdorderId
- the orderIdlanguageId
- the languageIdjava.lang.Exception
- an unexpected exceptionOrder getOrderWithOptions(java.lang.String sessionId, int orderId, int languageId, FetchOrderOptionsIf options) throws java.lang.Exception
sessionId
- the sessionIdorderId
- the orderIdlanguageId
- the languageIdoptions
- the optionsjava.lang.Exception
- an unexpected exceptionOrder getOrderForOrderId(int orderId, int languageId) throws java.lang.Exception
orderId
- the orderIdlanguageId
- the languageIdjava.lang.Exception
- an unexpected exceptionjava.lang.String getStatusText(int statusId, int languageId) throws java.lang.Exception
statusId
- the statusIdlanguageId
- the languageIdjava.lang.Exception
- an unexpected exceptionvoid updateOrder(java.lang.String sessionId, int orderId, int status, boolean customerNotified, java.lang.String comments, OrderUpdateIf updateOrder) throws java.lang.Exception
sessionId
- The session id of the logged in userorderId
- The numeric id of the orderstatus
- The new numeric state of the order. Valid states are defined in the database.customerNotified
- If you send an eMail to the customer to notify him of the state change then set
this to true to register the fact that an eMail has been sentcomments
- These comments are written into the orders_status_history recordupdateOrder
- contains order update data such as who updated the orderjava.lang.Exception
- an unexpected exceptionvoid updateOrder(java.lang.String sessionId, int orderId, int status, boolean customerNotified, java.lang.String comments, java.lang.String paymentModuleSubCode, OrderUpdateIf updateOrder) throws java.lang.Exception
sessionId
- The session id of the logged in userorderId
- The numeric id of the orderstatus
- The new numeric state of the order. Valid states are defined in the database.customerNotified
- If you send an eMail to the customer to notify him of the state change then set
this to true to register the fact that an eMail has been sentcomments
- These comments are written into the orders_status_history recordpaymentModuleSubCode
- A code to indicate what type of payment method has been used when we're using gateway like
BraintreeupdateOrder
- contains order update data such as who updated the orderjava.lang.Exception
- an unexpected exceptionvoid updateOrder(int orderId, int status, boolean customerNotified, java.lang.String comments, OrderUpdateIf updateOrder) throws java.lang.Exception
orderId
- The numeric id of the orderstatus
- The new numeric state of the order. Valid states are defined in the database.customerNotified
- If you send an eMail to the customer to notify him of the state change then set
this to true to register the fact that an eMail has been sentcomments
- These comments are written into the orders_status_history recordupdateOrder
- contains order update data such as who updated the orderjava.lang.Exception
- an unexpected exceptionvoid changeOrderStatus(java.lang.String sessionId, int orderId, int status, boolean customerNotified, java.lang.String comments) throws java.lang.Exception
sessionId
- the sessionIdorderId
- the orderIdstatus
- the statuscustomerNotified
- Has the customer been notifiedcomments
- the commentsjava.lang.Exception
- an unexpected exceptionvoid changeOrderStatus(int orderId, int status, boolean customerNotified, java.lang.String comments) throws java.lang.Exception
orderId
- the orderIdstatus
- the statuscustomerNotified
- Has the customer been notifiedcomments
- the commentsjava.lang.Exception
- an unexpected exceptionvoid updateInventory(java.lang.String sessionId, int orderId) throws java.lang.Exception
sessionId
- the sessionIdorderId
- the orderIdjava.lang.Exception
- an unexpected exceptionvoid updateInventoryWithOptions(java.lang.String sessionId, int orderId, CreateOrderOptionsIf options) throws java.lang.Exception
sessionId
- the sessionIdorderId
- the orderIdoptions
- the optionsjava.lang.Exception
- an unexpected exceptionjava.lang.String getSecretKeyForOrderId(int orderId) throws java.lang.Exception
orderId
- the orderIdjava.lang.Exception
- an unexpected exceptionint getOrderIdFromSecretKey(java.lang.String secretKey) throws com.workingdogs.village.DataSetException, org.apache.torque.TorqueException
secretKey
- the secretKeycom.workingdogs.village.DataSetException
- an unexpected exception due to data in Torque (the database layer)org.apache.torque.TorqueException
- an unexpected exception in Torque (the database layer)void deleteOrderIdForSecretKey(java.lang.String secretKey) throws org.apache.torque.TorqueException
secretKey
- the secretKeyorg.apache.torque.TorqueException
- an unexpected exception in Torque (the database layer)int saveIpnHistory(java.lang.String sessionId, IpnHistoryIf ipnHistory) throws java.lang.Exception
sessionId
- the sessionIdipnHistory
- the ipnHistoryjava.lang.Exception
- an unexpected exceptionOrder createAndSaveOrder(java.lang.String emailAddr, java.lang.String password, CustomerRegistrationIf custReg, BasketIf[] basketItemArray, java.lang.String shippingModule, java.lang.String paymentModule, int languageId) throws java.lang.Exception
emailAddr
- the emailAddrpassword
- the passwordcustReg
- the custRegbasketItemArray
- the basketItemArrayshippingModule
- the shippingModulepaymentModule
- the paymentModulelanguageId
- the languageIdjava.lang.Exception
- an unexpected exceptionvoid setCreditCardDetailsOnOrder(java.lang.String sessionId, int orderId, CreditCardIf card) throws java.lang.Exception
sessionId
- the sessionIdorderId
- the orderIdcard
- the cardjava.lang.Exception
- an unexpected exceptionvoid setRewardPointReservationId(java.lang.String sessionId, int orderId, int reservationId) throws java.lang.Exception
sessionId
parameter and then updates the reservation id.sessionId
- the sessionIdorderId
- the orderIdreservationId
- the reservationIdjava.lang.Exception
- an unexpected exceptionvoid setRewardPointReservationId(int customerId, int orderId, int reservationId) throws java.lang.Exception
customerId
parameter and then updates the reservation id.customerId
- the customerIdorderId
- the orderIdreservationId
- the reservationIdjava.lang.Exception
- an unexpected exceptionIpnHistory[] getIpnHistory(int orderId) throws com.workingdogs.village.DataSetException, org.apache.torque.TorqueException
orderId
- the orderIdcom.workingdogs.village.DataSetException
- an unexpected exception due to data in Torque (the database layer)org.apache.torque.TorqueException
- an unexpected exception in Torque (the database layer)IpnHistory[] getIpnHistory(java.lang.String sessionId, int orderId) throws java.lang.Exception
sessionId
- The session id of the logged in userorderId
- The numeric id of the orderjava.lang.Exception
- an unexpected exceptionint getOrderStatus(java.lang.String sessionId, int orderId) throws java.lang.Exception
sessionId
- The session id of the logged in userorderId
- The numeric id of the orderjava.lang.Exception
- an unexpected exceptionOrders searchForOrdersPerCustomer(java.lang.String sessionId, DataDescriptorIf dataDesc, OrderSearchIf orderSearch, int languageId) throws java.lang.Exception
sessionId
- Valid session id of a logged in customerdataDesc
- the dataDescorderSearch
- the orderSearchlanguageId
- the languageIdjava.lang.Exception
- an unexpected exceptionOrders searchForOrdersPerCustomer(int customerId, DataDescriptorIf dataDesc, OrderSearchIf orderSearch, int languageId) throws java.lang.Exception
customerId
- the customerIddataDesc
- the dataDescorderSearch
- the orderSearchlanguageId
- the languageIdjava.lang.Exception
- an unexpected exceptionOrderStatus[] getAllOrderStatuses(int languageId) throws java.lang.Exception
languageId
- the languageIdjava.lang.Exception
- an unexpected exceptionvoid refreshConfigs() throws java.lang.Exception
java.lang.Exception
- an unexpected exceptionvoid escapeOrder(OrderIf order)
order
- the orderCopyright © 2018 DS Data Systems UK Ltd.