public interface KKRMIEngServerIf
extends java.rmi.Remote
| Modifier and Type | Method and Description |
|---|---|
int |
addAddressToCustomer(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_Address addr)
The Address object is added to the customer defined by the
sessionId. |
int |
addCreditCardToCustomer(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_CreditCard card,
com.konakart.rmi.app.S_CreditCardOptions options)
Inserts a CreditCard object into the database.
|
void |
addCustomDataToSession(java.lang.String storeId,
java.lang.String sessionId,
java.lang.String data,
int position)
A sessionId is created when a customer logs in to KonaKart using the login() API call.
|
void |
addCustomerNotifications(java.lang.String storeId,
com.konakart.rmi.app.S_NotificationOptions options)
A method that allows you sign up a customer for a newsletter or product notification.
|
int |
addPoints(java.lang.String storeId,
java.lang.String sessionId,
int points,
java.lang.String code,
java.lang.String description)
Adds a number of reward points to the total for customer identified by the
sessionId parameter. |
void |
addProductNotificationToCustomer(java.lang.String storeId,
java.lang.String sessionId,
int productId)
Adds a product notification to the list of notifications for the customer.
|
java.math.BigDecimal |
addTax(java.lang.String storeId,
java.math.BigDecimal cost,
int countryId,
int zoneId,
int taxClassId)
Calculates the final cost (including tax) for a product with a certain
taxClassId and cost, delivered to a country (countryId
) and zone (zoneId). |
int |
addToBasket(java.lang.String storeId,
java.lang.String sessionId,
int customerId,
com.konakart.rmi.app.S_Basket item)
Saves the Basket object in the database for a customer.
|
int |
addToBasketWithOptions(java.lang.String storeId,
java.lang.String sessionId,
int customerId,
com.konakart.rmi.app.S_Basket item,
com.konakart.rmi.app.S_AddToBasketOptions options)
If
options is set to null, this method is identical to
addToBasket(). |
void |
addToCustomerTag(java.lang.String storeId,
java.lang.String sessionId,
java.lang.String tagName,
int tagValue)
This method is used for customer tags where the value is of type
com.konakart.app.CustomerTag.MULTI_INT_TYPE or
MULTI_INT_PLUS_TIME_TYPE. |
void |
addToCustomerTagForGuest(java.lang.String storeId,
int customerId,
java.lang.String tagName,
int tagValue)
This method is used for customer tags where the value is of type
com.konakart.app.CustomerTag.MULTI_INT_TYPE or
MULTI_INT_PLUS_TIME_TYPE. |
int |
addToWishList(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_WishListItem wishListItem)
Add a WishListItem object to the wish list referenced by wishListId.
|
int |
addToWishListWithOptions(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_WishListItem wishListItem,
com.konakart.rmi.app.S_AddToWishListOptions options)
If
options is set to null, this method is identical to
addToWishList(). |
com.konakart.rmi.app.S_Order |
changeDeliveryAddress(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_Order order,
com.konakart.rmi.app.S_Address deliveryAddress)
The delivery address of the order is changed and the tax rates for the various products
within the order are re-calculated.
|
void |
changeOrderStatus(java.lang.String storeId,
java.lang.String sessionId,
int orderId,
int status,
boolean customerNotified,
java.lang.String comments)
Deprecated.
From version 6.2.0.0 you should use
updateOrder(java.lang.String, java.lang.String, int, int, boolean, java.lang.String, com.konakart.rmi.app.S_OrderUpdate) instead. |
void |
changePassword(java.lang.String storeId,
java.lang.String sessionId,
java.lang.String currentPassword,
java.lang.String newPassword)
Ensures that the current password is correct, and then changes it to the new password.
|
int |
checkCoupon(java.lang.String storeId,
java.lang.String couponCode)
This method is used to verify whether a coupon code actually exists and if it does, whether
the coupon is still active.
|
void |
checkFileAccess(java.lang.String storeId,
java.lang.String fileName)
Check that we allow access to this location.
|
int |
checkSession(java.lang.String storeId,
java.lang.String sessionId)
The given
sessionId is checked to see whether it exists and whether it is has
timed out. |
com.konakart.rmi.app.S_Order |
createAndSaveOrder(java.lang.String storeId,
java.lang.String emailAddr,
java.lang.String password,
com.konakart.rmi.app.S_CustomerRegistration custReg,
com.konakart.rmi.app.S_Basket[] basketItemArray,
java.lang.String shippingModule,
java.lang.String paymentModule,
int languageId)
A high level call to simplify the process of creating a KonaKart order.
|
com.konakart.rmi.app.S_Order |
createOrder(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_Basket[] basketItemArray,
int languageId)
An order object is returned with all addresses populated with the default address of the
customer referenced by
sessionId. |
com.konakart.rmi.app.S_Order |
createOrderWithOptions(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_Basket[] basketItemArray,
com.konakart.rmi.app.S_CreateOrderOptions options,
int languageId)
If
options is set to null, this method is identical to
createOrder(). |
com.konakart.rmi.app.S_ProductQuantity |
createProductQuantityEncodedKeyFromEncodedProductId(java.lang.String storeId,
java.lang.String encodedProductId)
A utility API that returns a ProductQuantity object containing the product id and the encoded
option values from an encoded product id.
|
int |
createWishList(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_WishList wishList)
Create a wish list from a WishList object.
|
int |
createWishListWithOptions(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_WishList wishList,
com.konakart.rmi.app.S_AddToWishListOptions options)
Create a wish list from a WishList object.
|
java.lang.String |
custom(java.lang.String storeId,
java.lang.String input1,
java.lang.String input2)
A custom interface that you have to provide an implementation for.
|
java.lang.String |
customSecure(java.lang.String storeId,
java.lang.String sessionId,
java.lang.String input1,
java.lang.String input2)
A custom interface that you have to provide an implementation for.
|
void |
deleteAddressFromCustomer(java.lang.String storeId,
java.lang.String sessionId,
int addressId)
The address defined by the
sessionId and addressId is deleted. |
void |
deleteCookie(java.lang.String storeId,
java.lang.String customerUuid,
java.lang.String attrId)
Deletes the cookie object from the database that is referenced by the customerUuid and attrId
parameters.
|
void |
deleteCreditCard(java.lang.String storeId,
java.lang.String sessionId,
int cardId)
Deletes the CreditCard object referenced by cardId that must belong to the logged in
customer.
|
void |
deleteCustomer(java.lang.String storeId,
int custId)
The customer defined by the
customerId is deleted. |
void |
deleteCustomerNotifications(java.lang.String storeId,
com.konakart.rmi.app.S_NotificationOptions options)
A method that allows you remove a customer notification for a newsletter or product.
|
void |
deleteCustomerTag(java.lang.String storeId,
java.lang.String sessionId,
java.lang.String tagName)
This method deletes the customer tag referenced by the parameter
tagName and for
the customer referenced by the sessionId. |
void |
deleteCustomerTagForGuest(java.lang.String storeId,
int customerId,
java.lang.String tagName)
This method deletes the customer tag referenced by the parameter
tagName and for
the guest customer referenced by the negative customerId. |
void |
deleteOrderIdForSecretKey(java.lang.String storeId,
java.lang.String secretKey)
The secret key is removed from the system.
|
int |
deletePoints(java.lang.String storeId,
java.lang.String sessionId,
int points,
java.lang.String code,
java.lang.String description)
Deletes a number of reward points from the total for the customer identified by the
sessionId parameter. |
void |
deleteProductNotificationFromCustomer(java.lang.String storeId,
java.lang.String sessionId,
int productId)
Deletes a product notification from the list of notifications for the customer.
|
void |
deleteReservedPoints(java.lang.String storeId,
java.lang.String sessionId,
int reservationId,
java.lang.String code,
java.lang.String description)
Verifies that the
reservationId parameter exists and that it belongs to the
customer identified by the sessionId parameter. |
void |
deleteWishList(java.lang.String storeId,
java.lang.String sessionId,
int wishListId)
The wish list referenced by wishListId and all of the items contained by the wish list, will
be deleted.
|
void |
deleteWishListWithOptions(java.lang.String storeId,
java.lang.String sessionId,
int wishListId,
com.konakart.rmi.app.S_AddToWishListOptions options)
The wish list referenced by wishListId and all of the items contained by the wish list, will
be deleted.
|
boolean |
doesCustomerExistForEmail(java.lang.String storeId,
java.lang.String emailAddr)
Determine whether a customer has already registered with a certain eMail address as their
username.
|
void |
editConfiguration(java.lang.String storeId,
java.lang.String key,
java.lang.String value)
Deprecated.
From version 6.3.0.0 you should use the Administration APIs (KKAdminIf) instead.
|
void |
editCreditCard(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_CreditCard card,
com.konakart.rmi.app.S_CreditCardOptions options)
Edit the CreditCard object of a logged in customer referenced by sessionId.
|
void |
editCustomer(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_Customer cust)
The Customer object will replace the existing customer object in the database.
|
void |
editCustomerAddress(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_Address addr)
The Address object will replace the existing address object in the database with the same id.
|
void |
editCustomerWithOptions(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_Customer cust,
com.konakart.rmi.app.S_EditCustomerOptions options)
The Customer object will replace the existing customer object in the database.
|
void |
editDigitalDownload(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DigitalDownload digitalDownload)
Edits the digital download object if it belongs to the customer identified by the sessionId.
|
void |
editWishList(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_WishList wishList)
Edit an existing wish list object.
|
void |
editWishListWithOptions(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_WishList wishList,
com.konakart.rmi.app.S_AddToWishListOptions options)
Edit an existing wish list object.
|
void |
enableCustomer(java.lang.String storeId,
java.lang.String secretKey)
This method reads the SSO token using the Secret Key.
|
boolean |
evaluateExpression(java.lang.String storeId,
java.lang.String sessionId,
int expressionId,
java.lang.String expressionName)
An expression object is retrieved from the database and evaluated for the customer referenced
by the
sessionId. |
boolean |
evaluateExpressionForGuest(java.lang.String storeId,
int customerId,
int expressionId,
java.lang.String expressionName)
An expression object is retrieved from the database and evaluated for the guest customer
referenced by the negative
customerId. |
com.konakart.rmi.app.S_ExternalLoginResult |
externalLogin(java.lang.String storeId,
com.konakart.rmi.app.S_ExternalLoginInput loginInfo)
Used for logging in customers using a mechanism outside of KonaKart such as social login
using Facebook.
|
int |
forceRegisterCustomer(java.lang.String storeId,
com.konakart.rmi.app.S_CustomerRegistration custReg)
This API Call is used rather than
registerCustomer() when you want to provide a
store that doesn't force a customer to register. |
int |
freeReservedPoints(java.lang.String storeId,
java.lang.String sessionId,
int reservationId)
Verifies that the
reservationId parameter exists and that it belongs to the
customer identified by the sessionId parameter. |
com.konakart.rmi.app.S_Address[] |
getAddressesPerCustomer(java.lang.String storeId,
java.lang.String sessionId)
Returns all of the addresses registered for the given customer.
|
com.konakart.rmi.app.S_Address[] |
getAddressesPerManufacturer(java.lang.String storeId,
int manufacturerId)
Gets an array of Address objects that have been defined for the manufacturer referenced by
the manufacturerId.
|
com.konakart.rmi.app.S_Address[] |
getAddressesPerProduct(java.lang.String storeId,
int productId)
Gets an array of Address objects that have been defined for the product referenced by the
productId.
|
com.konakart.rmi.app.S_Address[] |
getAddressesPerStore(java.lang.String storeId,
java.lang.String addressStoreId)
Gets an array of Address objects that have been defined for the store referenced by the
addressStoreId.
|
com.konakart.rmi.app.S_Address[] |
getAddressesPerVendor(java.lang.String storeId,
com.konakart.rmi.app.S_Vendor vendor)
Returns all of the addresses registered for the given vendor.
|
java.lang.String |
getAddressFormatTemplate(java.lang.String storeId,
int templateId)
Returns the address format template for the numeric id passed in as a parameter.
|
com.konakart.rmi.app.S_KKCookie[] |
getAllCookies(java.lang.String storeId,
java.lang.String customerUuid)
Fetches all of the cookie object from the database that are referenced by the customerUuid
parameter.
|
com.konakart.rmi.app.S_Country[] |
getAllCountries(java.lang.String storeId)
Returns an array of Country objects for all of the countries in the system.
|
com.konakart.rmi.app.S_Currency[] |
getAllCurrencies(java.lang.String storeId)
Returns an array of currency objects for all the records in the currencies table.
|
com.konakart.rmi.app.S_CustomerGroup[] |
getAllCustomerGroups(java.lang.String storeId,
int languageId)
Returns an array of customer groups for all customer groups that have been defined in the
system.
|
com.konakart.rmi.app.S_Language[] |
getAllLanguages(java.lang.String storeId)
Returns an array of Language classes containing all of the languages that have been defined
within the system.
|
com.konakart.rmi.app.S_Manufacturer[] |
getAllManufacturers(java.lang.String storeId)
Returns an array of Manufacturer objects for all of the manufacturers in the system.
|
com.konakart.rmi.app.S_OrderStatus[] |
getAllOrderStatuses(java.lang.String storeId,
int languageId)
Returns an array of order status objects for the language defined by languageId.
|
com.konakart.rmi.app.S_ProductRelationship[] |
getAllProductRelationships(java.lang.String storeId)
A fast utility to returns all product relationships in the products_to_products table.
|
com.konakart.rmi.app.S_Products |
getAllProducts(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
int languageId)
Returns all products using the given language.
|
com.konakart.rmi.app.S_Products |
getAllProductsWithOptions(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
int languageId,
com.konakart.rmi.app.S_FetchProductOptions options)
An options object is passed in to customize from where some of the product attributes (such
as price and quantity) are fetched from.
|
com.konakart.rmi.app.S_Promotion[] |
getAllPromotions(java.lang.String storeId)
Returns an array of all active promotions.
|
com.konakart.rmi.app.S_Reviews |
getAllReviews(java.lang.String storeId,
com.konakart.rmi.app.S_DataDescriptor dataDesc)
An array of review objects is returned.
|
com.konakart.rmi.app.S_Products |
getAllSpecials(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
int languageId)
Returns all specials using the given language.
|
com.konakart.rmi.app.S_Product[] |
getAlsoPurchased(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
int productId,
int languageId)
Find products that were in the same order as orders containing the product referenced by
productId. |
com.konakart.rmi.app.S_Product[] |
getAlsoPurchasedWithOptions(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
int productId,
int languageId,
com.konakart.rmi.app.S_FetchProductOptions options)
An options object is passed in to customize from where some of the product attributes (such
as price and quantity) are fetched from.
|
com.konakart.rmi.app.S_Basket[] |
getBasketItemsPerCustomer(java.lang.String storeId,
java.lang.String sessionId,
int customerId,
int languageId)
Get the basket items for a customer and language.
|
com.konakart.rmi.app.S_Basket[] |
getBasketItemsPerCustomerWithOptions(java.lang.String storeId,
java.lang.String sessionId,
int customerId,
int languageId,
com.konakart.rmi.app.S_AddToBasketOptions options)
Get the basket items for a customer and language.
|
com.konakart.rmi.app.S_Product[] |
getBestSellers(java.lang.String storeId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
int categoryId,
int languageId)
Returns an array of bestseller products for the category referenced by
categoryId and its children. |
com.konakart.rmi.app.S_Product[] |
getBestSellersWithOptions(java.lang.String storeId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
int categoryId,
int languageId,
com.konakart.rmi.app.S_FetchProductOptions options)
An options object is passed in to customize from where some of the product attributes (such
as price and quantity) are fetched from.
|
com.konakart.rmi.app.S_Product[] |
getBookableProductConflict(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_Product bookableProd,
com.konakart.rmi.app.S_BookableProductOptions options)
This method checks to see whether the bookable product passed in as a parameter conflicts
with any bookable products that the customer identified by the sessionId has already signed
up for.
If no conflicts are found, null is returned. |
com.konakart.rmi.app.S_Bookings |
getBookingsPerCustomer(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
com.konakart.rmi.app.S_BookableProductOptions options)
Get an array of bookings for a logged in customer.
|
com.konakart.rmi.app.S_Bookings |
getBookingsPerProduct(java.lang.String storeId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
int productId,
com.konakart.rmi.app.S_BookableProductOptions options)
Get an array of bookings for a bookable product.
|
com.konakart.rmi.app.S_Products |
getBundlesThatProductBelongsTo(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
int productId,
int languageId,
com.konakart.rmi.app.S_FetchProductOptions options)
The method fetches an array of bundles (products of type bundle), all of which contain the
product with id
productId as one of the bundled products. |
com.konakart.rmi.app.S_Products |
getBundlesThatProductsBelongTo(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
int[] productIds,
boolean exactMatch,
int languageId,
com.konakart.rmi.app.S_FetchProductOptions options)
The method fetches an array of bundles (products of type bundle), all of which contain the
products with ids
productIds as one or more of the bundled products. |
com.konakart.rmi.app.S_Catalog |
getCatalogPerKey(java.lang.String storeId,
java.lang.String catalogKey)
Returns a catalog object for the catalog key.
|
com.konakart.rmi.app.S_Category[] |
getCategoriesPerManufacturer(java.lang.String storeId,
int manufacturerId,
int languageId)
Returns an array of leaf Category objects for the given manufacturer.
|
com.konakart.rmi.app.S_Category[] |
getCategoriesPerProduct(java.lang.String storeId,
int productId,
int languageId)
Returns an array of Category objects for the given product.
|
com.konakart.rmi.app.S_Category |
getCategory(java.lang.String storeId,
int categoryId,
int languageId)
Returns a complete single Category object for the given
categoryId and language. |
com.konakart.rmi.app.S_Category[] |
getCategoryTree(java.lang.String storeId,
int languageId,
boolean getNumProducts)
Returns a category tree structure consisting of an array of top level categories, each of
which may contain an array of child categories.
|
com.konakart.rmi.app.S_Category[] |
getCategoryTreeWithOptions(java.lang.String storeId,
com.konakart.rmi.app.S_CategoryTreeOptions options)
Returns a category tree structure consisting of an array of top level categories, each of
which may contain an array of child categories.
|
com.konakart.rmi.app.S_ConfigData[] |
getConfigData(java.lang.String storeId,
java.lang.String sessionId,
java.lang.String key)
Returns the ConfigData items with the specified key or all ConfigData items if the key is
null
|
com.konakart.rmi.app.S_KKConfiguration |
getConfiguration(java.lang.String storeId,
java.lang.String key)
Returns a Configuration object referenced by the key passed in as a parameter.
|
com.konakart.rmi.app.S_KKConfiguration |
getConfigurationNoCache(java.lang.String storeId,
java.lang.String key)
Returns a Configuration object referenced by the key passed in as a parameter.
|
com.konakart.rmi.app.S_KKConfiguration[] |
getConfigurations(java.lang.String storeId)
Returns an array of Configuration objects containing all configurations that have been
defined in the system and that have been defined to be returned via the API.
|
java.lang.String |
getConfigurationValue(java.lang.String storeId,
java.lang.String key)
Returns a Configuration Value referenced by the key passed in as a parameter.
|
java.math.BigDecimal |
getConfigurationValueAsBigDecimal(java.lang.String storeId,
java.lang.String key)
Returns a Configuration Value as a BigDecimal for the key passed in as a parameter.
|
java.math.BigDecimal |
getConfigurationValueAsBigDecimalWithDefault(java.lang.String storeId,
java.lang.String key,
java.math.BigDecimal def)
Returns a Configuration Value as a BigDecimal for the key passed in as a parameter.
|
java.lang.Boolean |
getConfigurationValueAsBool(java.lang.String storeId,
java.lang.String key,
java.lang.Boolean def)
Returns a Configuration Value as a Boolean for the key passed in as a parameter.
|
int |
getConfigurationValueAsInt(java.lang.String storeId,
java.lang.String key)
Returns a Configuration Value as an integer for the key passed in as a parameter.
|
int |
getConfigurationValueAsIntWithDefault(java.lang.String storeId,
java.lang.String key,
int def)
Returns a Configuration Value as an integer for the key passed in as a parameter.
|
com.konakart.rmi.app.S_Content |
getContent(java.lang.String storeId,
int contentId,
int languageId)
Get the latest (last to be inserted) enabled Content record with the specified contentId for
the specified languageId.
|
com.konakart.rmi.app.S_ContentSearchResult |
getContents(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_ContentSearch search,
com.konakart.rmi.app.S_DataDescriptor dd)
Retrieve Content records using the specified search criteria
|
com.konakart.rmi.app.S_ContentType |
getContentType(java.lang.String storeId,
int contentTypeId,
int languageId)
Return the ContentType for the specified language and contentTypeId
|
com.konakart.rmi.app.S_ContentType[] |
getContentTypes(java.lang.String storeId,
int languageId)
Return all the ContentTypes for the specified language
|
com.konakart.rmi.app.S_KKCookie |
getCookie(java.lang.String storeId,
java.lang.String customerUuid,
java.lang.String attrId)
Fetches the cookie object from the database that is referenced by the customerUuid and attrId
parameters.
|
com.konakart.rmi.app.S_Country |
getCountry(java.lang.String storeId,
int countryId)
Returns the country object for the
countryId, or null if the country doesn't
exist in the DB. |
com.konakart.rmi.app.S_Country |
getCountryPerName(java.lang.String storeId,
java.lang.String countryName)
Returns the country object for the
countryName, or null if the country doesn't
exist in the DB. |
com.konakart.rmi.app.S_Coupon |
getCouponPerId(java.lang.String storeId,
int couponId,
com.konakart.rmi.app.S_CouponOptions options)
Returns a coupon for the coupon id passed in as a parameter.
|
com.konakart.rmi.app.S_Coupon[] |
getCouponsPerCode(java.lang.String storeId,
java.lang.String couponCode,
com.konakart.rmi.app.S_CouponOptions options)
Returns an array of coupons for the coupon code passed in as a parameter.
|
com.konakart.rmi.app.S_CreditCard[] |
getCreditCardsPerCustomer(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_CreditCardOptions options)
Get an array of CreditCard objects for a logged in customer.
|
com.konakart.rmi.app.S_Currency |
getCurrency(java.lang.String storeId,
java.lang.String currencyCode)
Returns the currency referenced by
currencyCode. |
java.lang.String |
getCustomDataFromSession(java.lang.String storeId,
java.lang.String sessionId,
int position)
A sessionId is created when a customer logs in to KonaKart using the login() API call.
|
com.konakart.rmi.app.S_Customer |
getCustomer(java.lang.String storeId,
java.lang.String sessionId)
Returns the customer object for the customer defined by the given
sessionId. |
com.konakart.rmi.app.S_CustomerGroup |
getCustomerGroup(java.lang.String storeId,
int customerGroupId,
int languageId)
Returns a customer group object for the customerGroupId passed in as a parameter.
|
com.konakart.rmi.app.S_CustomerTag |
getCustomerTag(java.lang.String storeId,
java.lang.String sessionId,
java.lang.String tagName)
A CustomerTag object referenced by the parameter
tagName is returned. |
com.konakart.rmi.app.S_CustomerTag |
getCustomerTagForGuest(java.lang.String storeId,
int customerId,
java.lang.String tagName)
A CustomerTag object referenced by the parameter
tagName is returned. |
com.konakart.rmi.app.S_CustomerTag[] |
getCustomerTags(java.lang.String storeId,
java.lang.String sessionId)
This method fetches all of the customer tags for the customer referenced by the
sessionId. |
com.konakart.rmi.app.S_CustomerTag[] |
getCustomerTagsForGuest(java.lang.String storeId,
int customerId)
This method fetches all of the customer tags for the guest customer referenced by the
customerId which must have a negative value. |
java.lang.String |
getCustomerTagValue(java.lang.String storeId,
java.lang.String sessionId,
java.lang.String tagName)
A string is returned containing the value of the customer tag referenced by the parameter
tagName and for the customer referenced by the sessionId. |
java.lang.String |
getCustomerTagValueForGuest(java.lang.String storeId,
int customerId,
java.lang.String tagName)
A string is returned containing the value of the customer tag referenced by the parameter
tagName and for the guest customer referenced by the negative
customerId. |
com.konakart.rmi.app.S_Customer |
getCustomerWithOptions(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_FetchCustomerOptions options)
Returns the customer object for the customer defined by the given
sessionId. |
com.konakart.rmi.app.S_Address |
getDefaultAddressPerCustomer(java.lang.String storeId,
java.lang.String sessionId)
Returns the default address for the given customer.
|
com.konakart.rmi.app.S_Currency |
getDefaultCurrency(java.lang.String storeId)
The default currency is referenced by a configuration variable called DEFAULT_CURRENCY.
|
com.konakart.rmi.app.S_Customer |
getDefaultCustomer(java.lang.String storeId)
Returns the customer object for the default customer.
|
com.konakart.rmi.app.S_Language |
getDefaultLanguage(java.lang.String storeId)
The default language is referenced by a configuration variable called DEFAULT_LANGUAGE.
|
com.konakart.rmi.app.S_DigitalDownload |
getDigitalDownloadById(java.lang.String storeId,
java.lang.String sessionId,
int digitalDownloadId)
Returns a Digital Download object for the digital download id.
|
com.konakart.rmi.app.S_DigitalDownload[] |
getDigitalDownloads(java.lang.String storeId,
java.lang.String sessionId)
Returns an array of Digital Download objects for the customer identified by the
sessionId parameter. |
com.konakart.rmi.app.S_DigitalDownload[] |
getDigitalDownloadsWithOptions(java.lang.String storeId,
java.lang.String sessionId,
int languageId,
com.konakart.rmi.app.S_FetchDigitalDownloadOptions ddOptions,
com.konakart.rmi.app.S_FetchProductOptions prodOptions)
Returns an array of Digital Download objects for the customer identified by the
sessionId parameter. |
com.konakart.rmi.app.S_Expression |
getExpression(java.lang.String storeId,
java.lang.String sessionId,
int expressionId,
java.lang.String expressionName)
An Expression object, fully populated with an array of Expression Variables is returned.
|
com.konakart.rmi.app.S_Expression |
getExpressionForGuest(java.lang.String storeId,
int customerId,
int expressionId,
java.lang.String expressionName)
An Expression object, fully populated with an array of Expression Variables is returned.
|
com.konakart.rmi.app.S_GeoZone[] |
getGeoZonesPerZone(java.lang.String storeId,
com.konakart.rmi.app.S_Zone zone)
Returns an array of GeoZone objects (tax areas) for the zone passed in as a parameter.
|
com.konakart.rmi.app.S_IpnHistory[] |
getIpnHistory(java.lang.String storeId,
java.lang.String sessionId,
int orderId)
Retrieve an array of IpnHistory objects for an order.
|
com.konakart.rmi.app.S_KKEvent[] |
getKKEvents(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_KKEventSearch search,
com.konakart.rmi.app.S_DataDescriptor desc)
Search for events
|
java.util.Calendar |
getKonakartTimeStamp(java.lang.String storeId)
Get a Date Time Stamp from the server
|
java.lang.String |
getKonaKartVersion(java.lang.String storeId)
Return the version number of KonaKart that is contained within the konakart.jar
|
com.konakart.rmi.app.S_Language |
getLanguagePerCode(java.lang.String storeId,
java.lang.String code)
Retrieves the language object referenced by the two letter code (i.e.
|
com.konakart.rmi.app.S_Language |
getLanguagePerId(java.lang.String storeId,
int languageId)
Retrieves the language object referenced by the id.
|
com.konakart.rmi.app.S_Language[] |
getLanguages(java.lang.String storeId,
com.konakart.rmi.app.S_LanguageSearch search)
Returns an array of Language classes containing all of the languages that satisfy the search
criteria.
|
com.konakart.rmi.app.S_Manufacturer |
getManufacturer(java.lang.String storeId,
int manufacturerId,
int languageId)
Returns a Manufacturer object for the given
manufacturerId and language. |
com.konakart.rmi.app.S_Manufacturer |
getManufacturerPerProduct(java.lang.String storeId,
int productId,
int languageId)
Returns a Manufacturer object for the given
productId and language. |
com.konakart.rmi.app.S_Manufacturer[] |
getManufacturers(java.lang.String storeId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
com.konakart.rmi.app.S_ManufacturerSearch search,
int languageId)
Returns an array of Manufacturer objects that match the specified search criteria in the
ManufacturerSearch object.
|
com.konakart.rmi.app.S_Manufacturer[] |
getManufacturersPerCategory(java.lang.String storeId,
int categoryId)
Returns an array of Manufacturer objects for the given category.
|
com.konakart.rmi.app.S_NameValue[] |
getMessages(java.lang.String storeId,
int type,
java.lang.String locale)
Used to fetch a message catalog for a locale and message type.
|
com.konakart.rmi.app.S_MiscItem[] |
getMiscItemsPerType(java.lang.String storeId,
int typeId,
int languageId)
Get an array of MiscItem objects for a MiscItem type.
|
java.lang.String |
getMsgValue(java.lang.String storeId,
java.lang.String key,
int type,
java.lang.String locale)
Get an Application Message Value.
|
com.konakart.rmi.app.S_Order |
getOrder(java.lang.String storeId,
java.lang.String sessionId,
int orderId,
int languageId)
Gets on order with the specified order Id, for the customer referenced by the
sessionId. |
com.konakart.rmi.app.S_Product[] |
getOrderHistory(java.lang.String storeId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
java.lang.String sessionId,
int languageId)
Get a list of the products ordered by the customer referenced by
sessionId. |
com.konakart.rmi.app.S_Product[] |
getOrderHistoryWithOptions(java.lang.String storeId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
java.lang.String sessionId,
int languageId,
com.konakart.rmi.app.S_FetchProductOptions options)
An options object is passed in to customize from where some of the product attributes (such
as price and quantity) are fetched from.
|
int |
getOrderIdFromSecretKey(java.lang.String storeId,
java.lang.String secretKey)
When an order is created, a secret key is generated that may be used to send to the payment
gateway if the payment gateway uses a callback mechanism.
|
com.konakart.rmi.app.S_Orders |
getOrdersPerCustomer(java.lang.String storeId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
java.lang.String sessionId,
int languageId)
Retrieve a number of orders for the customer referenced by the
sessionId. |
com.konakart.rmi.app.S_Orders |
getOrdersPerCustomerWithOptions(java.lang.String storeId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
java.lang.String sessionId,
int languageId,
com.konakart.rmi.app.S_FetchOrderOptions options)
Retrieve a number of orders for the customer referenced by the
sessionId. |
int |
getOrderStatus(java.lang.String storeId,
java.lang.String sessionId,
int orderId)
Get the order status for an order.
|
com.konakart.rmi.app.S_Order |
getOrderTotals(java.lang.String storeId,
com.konakart.rmi.app.S_Order order,
int languageId)
The order object is populated with an array of order totals.
|
com.konakart.rmi.app.S_Order |
getOrderWithOptions(java.lang.String storeId,
java.lang.String sessionId,
int orderId,
int languageId,
com.konakart.rmi.app.S_FetchOrderOptions options)
Gets on order with the specified order Id, for the customer referenced by the
sessionId. |
com.konakart.rmi.app.S_PaymentDetails |
getPaymentDetails(java.lang.String storeId,
java.lang.String sessionId,
java.lang.String moduleCode,
int orderId,
java.lang.String hostAndPort,
int languageId)
This method is called once a payment gateway has been selected and an order has been saved in
the database.
|
com.konakart.rmi.app.S_PaymentDetails |
getPaymentDetailsCustom(java.lang.String storeId,
java.lang.String sessionId,
java.lang.String moduleCode,
com.konakart.rmi.app.S_NameValue[] parameters)
Method used to return any custom information required from the payment module.
|
com.konakart.rmi.app.S_PaymentDetails |
getPaymentDetailsPerOrder(java.lang.String storeId,
java.lang.String sessionId,
java.lang.String moduleCode,
com.konakart.rmi.app.S_Order order,
java.lang.String hostAndPort,
int languageId)
This method is called once a payment gateway has been selected even if the order has not been
saved in the database.
|
com.konakart.rmi.app.S_PaymentDetails |
getPaymentGateway(java.lang.String storeId,
com.konakart.rmi.app.S_Order order,
java.lang.String moduleName,
int languageId)
The payment module called
moduleName is called to get a PaymentDetails object
for the order passed in as a parameter. |
com.konakart.rmi.app.S_PaymentDetails[] |
getPaymentGateways(java.lang.String storeId,
com.konakart.rmi.app.S_Order order,
int languageId)
Each payment module is called and asked to return a PaymentDetails object.
|
com.konakart.rmi.app.S_PaymentSchedule |
getPaymentSchedule(java.lang.String storeId,
int id)
Returns the payment schedule object for the
id parameter, or Null if the payment
schedule object doesn't exist in the DB. |
com.konakart.rmi.app.S_PdfResult |
getPdf(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_PdfOptions options)
Creates a PDF document.
|
com.konakart.rmi.app.S_Product |
getProduct(java.lang.String storeId,
java.lang.String sessionId,
int productId,
int languageId)
Returns a complete Product object for the given
productId and language. |
com.konakart.rmi.app.S_ProductImages |
getProductImages(java.lang.String storeId,
com.konakart.rmi.app.S_ProductImagesOptions options)
Get the image file names associated with the product whose id is specified.
|
com.konakart.rmi.app.S_Product[] |
getProductNotificationsPerCustomer(java.lang.String storeId,
java.lang.String sessionId,
int languageId)
Returns all products sorted by name, that the customer has asked to be notified about.
|
com.konakart.rmi.app.S_Product[] |
getProductNotificationsPerCustomerWithOptions(java.lang.String storeId,
java.lang.String sessionId,
int languageId,
com.konakart.rmi.app.S_FetchProductOptions options)
An options object is passed in to customize from where some of the product attributes (such
as price and quantity) are fetched from.
|
com.konakart.rmi.app.S_Product |
getProductPerSku(java.lang.String storeId,
java.lang.String sessionId,
java.lang.String sku,
int languageId)
Get a product from its SKU.
|
com.konakart.rmi.app.S_Product |
getProductPerSkuWithOptions(java.lang.String storeId,
java.lang.String sessionId,
java.lang.String sku,
int languageId,
com.konakart.rmi.app.S_FetchProductOptions options)
Get a product from its SKU.
|
com.konakart.rmi.app.S_ProductQuantity |
getProductQuantity(java.lang.String storeId,
java.lang.String encodedProductId)
The stock level of the product and the date available are returned within a ProductQuantity
object.
|
com.konakart.rmi.app.S_ProductQuantity |
getProductQuantityWithOptions(java.lang.String storeId,
java.lang.String encodedProductId,
com.konakart.rmi.app.S_FetchProductOptions options)
The stock level of the product and the date available are returned within a ProductQuantity
object.
|
com.konakart.rmi.app.S_Product[] |
getProductsFromIdsWithOptions(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
int[] prodIdArray,
int languageId,
com.konakart.rmi.app.S_FetchProductOptions options)
An array of products is returned that corresponds to an array of productIds passed in as a
parameter.
|
com.konakart.rmi.app.S_Products |
getProductsPerCategory(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
int categoryId,
boolean searchInSubCats,
int languageId)
Returns a Products object for the given category and language.
|
com.konakart.rmi.app.S_Products |
getProductsPerCategoryPerManufacturer(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
int categoryId,
int manufacturerId,
int languageId)
Returns a Products object for the given category, language and manufacturer.
|
com.konakart.rmi.app.S_Products |
getProductsPerCategoryPerManufacturerWithOptions(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
int categoryId,
int manufacturerId,
int languageId,
com.konakart.rmi.app.S_FetchProductOptions options)
An options object is passed in to customize from where some of the product attributes (such
as price and quantity) are fetched from.
|
com.konakart.rmi.app.S_Products |
getProductsPerCategoryWithOptions(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
int categoryId,
boolean searchInSubCats,
int languageId,
com.konakart.rmi.app.S_FetchProductOptions options)
An options object is passed in to customize from where some of the product attributes (such
as price and quantity) are fetched from.
|
com.konakart.rmi.app.S_Products |
getProductsPerManufacturer(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
int manufacturerId,
int languageId)
Returns a Products object for the given manufacturer and language.
|
com.konakart.rmi.app.S_Products |
getProductsPerManufacturerWithOptions(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
int manufacturerId,
int languageId,
com.konakart.rmi.app.S_FetchProductOptions options)
An options object is passed in to customize from where some of the product attributes (such
as price and quantity) are fetched from.
|
com.konakart.rmi.app.S_Product |
getProductWithOptions(java.lang.String storeId,
java.lang.String sessionId,
int productId,
int languageId,
com.konakart.rmi.app.S_FetchProductOptions options)
An options object is passed in to customize from where some of the product attributes (such
as price and quantity) are fetched from.
|
com.konakart.rmi.app.S_Promotion |
getPromotion(java.lang.String storeId,
int promotionId,
java.lang.String promotionName,
int languageId,
com.konakart.rmi.app.S_FetchPromotionOptions prmOptions,
com.konakart.rmi.app.S_FetchProductOptions prodOptions)
This API call is used to retrieve a single promotion matching an id or name.
|
com.konakart.rmi.app.S_Promotion[] |
getPromotionsPerCoupon(java.lang.String storeId,
java.lang.String couponCode,
int couponId,
com.konakart.rmi.app.S_PromotionOptions options)
This method is used to return an array of promotions associated with the coupon(s) identified
by the input parameters.
|
com.konakart.rmi.app.S_Product[] |
getPromotionsPerProducts(java.lang.String storeId,
java.lang.String sessionId,
int customerId,
com.konakart.rmi.app.S_Product[] products,
com.konakart.rmi.app.S_Promotion[] promotions,
java.lang.String[] couponCodes,
com.konakart.rmi.app.S_PromotionOptions options)
This method is used to calculate a discount on individual products so that the discount can
be displayed without having to add the product to the cart.
The method receives an array of products and returns an array of products with attached PromotionResult objects that contain the results of one or more of the promotions passed in as a parameter. |
com.konakart.rmi.app.S_PunchOutResult |
getPunchOutMessage(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_Order order,
com.konakart.rmi.app.S_PunchOutOptions options)
Creates a punch out message from an order.
|
com.konakart.rmi.app.S_Products |
getRelatedProducts(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
int productId,
int relationType,
int languageId)
Find products related to the product defined by the
productId parameter. |
com.konakart.rmi.app.S_Products |
getRelatedProductsWithOptions(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
int productId,
int relationType,
int languageId,
com.konakart.rmi.app.S_FetchProductOptions options)
An options object is passed in to customize from where some of the product attributes (such
as price and quantity) are fetched from.
|
com.konakart.rmi.app.S_Review |
getReview(java.lang.String storeId,
int reviewId)
An review object is returned for the given
reviewId. |
com.konakart.rmi.app.S_Reviews |
getReviews(java.lang.String storeId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
com.konakart.rmi.app.S_ReviewSearch search)
Returns an array of Reviews (within a Reviews object) that match the specified search
criteria in the ReviewSearch object.
|
com.konakart.rmi.app.S_Reviews |
getReviewsPerProduct(java.lang.String storeId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
int productId)
An array of review objects is returned for the given
productId. |
com.konakart.rmi.app.S_Reviews |
getReviewsPerVendor(java.lang.String storeId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
int vendorId)
Returns an array of reviews for the vendor referenced by the given vendorId.
|
com.konakart.rmi.app.S_RewardPoints |
getRewardPoints(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc)
Gets an array of reward point objects for a customer identified by the
sessionId
parameter. |
com.konakart.rmi.app.S_RewardPoints |
getRewardPointsWithOptions(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
com.konakart.rmi.app.S_FetchRewardPointOptions options)
Gets an array of reward point objects for a customer identified by the
sessionId
parameter. |
java.lang.String |
getSecretKeyForOrderId(java.lang.String storeId,
int orderId)
A secret key is generated and stored in the database for the orderId passed as a parameter.
|
com.konakart.rmi.app.S_ShippingQuote |
getShippingQuote(java.lang.String storeId,
com.konakart.rmi.app.S_Order order,
java.lang.String moduleName,
int languageId)
The shipping module called
moduleName is called to get a shipping quote for the
order passed in as a parameter. |
com.konakart.rmi.app.S_ShippingQuote[] |
getShippingQuotes(java.lang.String storeId,
com.konakart.rmi.app.S_Order order,
int languageId)
All active installed shipping modules are called in order to get an array of shipping quotes.
|
java.lang.String |
getSku(java.lang.String storeId,
com.konakart.rmi.app.S_OrderProduct orderProd)
Deprecated.
|
com.konakart.rmi.app.S_Products |
getSpecialsPerCategory(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
int categoryId,
boolean searchInSubCats,
int languageId)
Returns all specials for the given
categoryId and language. |
com.konakart.rmi.app.S_SSOToken |
getSSOToken(java.lang.String storeId,
java.lang.String secretKey,
boolean deleteToken)
Returns an SSOToken object for the secretKey (UUID).
|
java.lang.String |
getStatusText(java.lang.String storeId,
int statusId,
int languageId)
Returns the text of a status from the orders_status table.
|
com.konakart.rmi.app.S_Store |
getStore(java.lang.String storeId)
Returns the store that this KonaKart engine is connected to.
|
com.konakart.rmi.app.S_Store |
getStoreForId(java.lang.String storeId,
java.lang.String vendorStoreId)
Returns the store referenced by the vendorStoreId parameter.
|
java.lang.String[] |
getStoreIds(java.lang.String storeId)
Returns an array of strings containing the store ids for the stores being used in a
multi-store / multi-database environment.
|
com.konakart.rmi.app.S_Subscription[] |
getSubscriptionsPerCustomer(java.lang.String storeId,
java.lang.String sessionId)
Returns an array of Subscription objects for a customer referred to by the sessionId
parameter.
|
com.konakart.rmi.app.S_SuggestedSearchItem[] |
getSuggestedSearchItems(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_SuggestedSearchOptions options)
An array of SuggestedSearchItems is returned for search text within the options parameter.
|
com.konakart.rmi.app.S_SuggestedSpellingItem[] |
getSuggestedSpellingItems(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_SuggestedSpellingOptions options)
An array of SuggestedSpellingItems is returned for search text within the options parameter.
|
com.konakart.rmi.app.S_Suggestion[] |
getSuggestions(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_Suggestion suggestion,
com.konakart.rmi.app.S_DataDescriptor dataDesc)
This retrieves Product Recommendation Suggestion objects from the database.
|
com.konakart.rmi.app.S_Tag |
getTag(java.lang.String storeId,
int tagId,
boolean getProdCount,
int languageId)
Returns a Tag object for the id passed in as a parameter.
|
com.konakart.rmi.app.S_TagGroup |
getTagGroup(java.lang.String storeId,
int tagGroupId,
boolean getProdCount,
int languageId)
Returns a TagGroup object for the id passed in as a parameter.
|
com.konakart.rmi.app.S_TagGroup[] |
getTagGroupsPerCategory(java.lang.String storeId,
int categoryId,
boolean getProdCount,
int languageId)
Return an array of TagGroup objects for a category.
|
com.konakart.rmi.app.S_TagGroup[] |
getTagGroupsPerCategoryWithOptions(java.lang.String storeId,
int categoryId,
int languageId,
com.konakart.rmi.app.S_FetchTagGroupOptions options)
Return an array of TagGroup objects for a category.
|
com.konakart.rmi.app.S_Tag[] |
getTagsPerCategory(java.lang.String storeId,
int categoryId,
boolean getProdCount,
int languageId)
Return an array of Tag objects for a category.
|
java.math.BigDecimal |
getTax(java.lang.String storeId,
java.math.BigDecimal cost,
int countryId,
int zoneId,
int taxClassId)
Calculates the tax for a product with a
taxClassId and cost,
delivered to a country (countryId) and zone (zoneId). |
java.math.BigDecimal |
getTaxRate(java.lang.String storeId,
int countryId,
int zoneId,
int taxClassId)
Calculates the tax rate for a product with a
taxClassId delivered to a country (
countryId) and zone (zoneId). |
int |
getTempCustomerId(java.lang.String storeId)
When a customer that hasn't logged in adds products to the shopping cart, we use a temporary
customer id which is always negative and unique.
|
com.konakart.rmi.app.S_Vendor |
getVendorForId(java.lang.String storeId,
int vendorId)
Returns the vendor object for the vendor defined by the given vendorId.
|
com.konakart.rmi.app.S_Review |
getVendorReview(java.lang.String storeId,
int reviewId)
Returns a vendor review for the given reviewId
|
com.konakart.rmi.app.S_Reviews |
getVendorReviews(java.lang.String storeId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
com.konakart.rmi.app.S_ReviewSearch search)
Returns an array of Reviews (within a Reviews object) that match the specified search
criteria in the ReviewSearch object.
|
com.konakart.rmi.app.S_Vendors |
getVendors(java.lang.String storeId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
com.konakart.rmi.app.S_VendorSearch search)
Returns an array of Vendors (within a Vendors object) that match the specified search
criteria in the VendorSearch object.
|
com.konakart.rmi.app.S_WishList |
getWishList(java.lang.String storeId,
java.lang.String sessionId,
int wishListId)
Returns a WishList object not populated with an array of WishListItem objects.
|
com.konakart.rmi.app.S_WishListItems |
getWishListItems(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
int wishListId,
int languageId)
Returns a WishListItems object containing an array of items and the number of items returned.
|
com.konakart.rmi.app.S_WishListItems |
getWishListItemsWithOptions(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
int wishListId,
int languageId,
com.konakart.rmi.app.S_AddToWishListOptions options)
Returns a WishListItems object containing an array of items and the number of items returned.
|
com.konakart.rmi.app.S_WishList |
getWishListWithItems(java.lang.String storeId,
java.lang.String sessionId,
int wishListId,
int languageId)
Returns a fully populated WishList object that may contain an array of WishListItem objects.
|
com.konakart.rmi.app.S_WishList |
getWishListWithItemsWithOptions(java.lang.String storeId,
java.lang.String sessionId,
int wishListId,
int languageId,
com.konakart.rmi.app.S_AddToWishListOptions options)
If
options is set to null, this method is identical to
getWishListWithItems(). |
com.konakart.rmi.app.S_WishList |
getWishListWithOptions(java.lang.String storeId,
java.lang.String sessionId,
int wishListId,
com.konakart.rmi.app.S_AddToWishListOptions options)
Returns a WishList object not populated with an array of WishListItem objects.
|
com.konakart.rmi.app.S_Zone[] |
getZonesPerCountry(java.lang.String storeId,
int countryId)
Returns an array of Zone objects for the country referenced by the
countryId. |
int |
insertBooking(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_Booking booking,
com.konakart.rmi.app.S_BookableProductOptions options)
Inserts a Booking object into the database.
|
void |
insertCustomerEvent(java.lang.String storeId,
com.konakart.rmi.app.S_CustomerEvent event)
The customer event is written to a queue and control is immediately returned to the caller.
|
void |
insertCustomerTag(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_CustomerTag tag)
Assigns a customer tag to the customer referenced by the
sessionId. |
void |
insertCustomerTagForGuest(java.lang.String storeId,
int customerId,
com.konakart.rmi.app.S_CustomerTag tag)
Assigns a customer tag to the guest customer referenced by the
customerId which
must have a negative value. |
int |
insertDigitalDownload(java.lang.String storeId,
java.lang.String sessionId,
int productId)
Create and insert a digital download record for the product identified by the
productId and the customer identified by the sessionId. |
int |
insertKKEvent(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_KKEvent event)
Insert an event
|
int |
insertSubscription(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_Subscription subscription)
A Subscription object is inserted into the database.
|
boolean |
isCustomerSubscribedToNewsletter(java.lang.String storeId,
java.lang.String emailAddr)
Regardless of the type of customer, this API call returns true if the customer referenced by
the
emailAddr parameter is subscribed to receive the newsletter. |
boolean |
isEmailValid(java.lang.String storeId,
java.lang.String emailAddr)
Determines whether the eMail address is valid
|
java.lang.String |
login(java.lang.String storeId,
java.lang.String emailAddr,
java.lang.String password)
Returns a 16 byte long session key is the login is successful, otherwise it returns null.
|
java.lang.String |
loginByAdmin(java.lang.String storeId,
java.lang.String adminSession,
int customerId)
Used to log in to the application as a customer by an Administrator.
|
com.konakart.rmi.app.S_LoginResult |
loginWithOptions(java.lang.String storeId,
com.konakart.rmi.app.S_LoginInput input)
Returns a LoginResult object containing the result of the login.
|
void |
logout(java.lang.String storeId,
java.lang.String sessionId)
Logs out the user with the specified session Id.
|
void |
mergeBaskets(java.lang.String storeId,
java.lang.String sessionId,
int customerFromId)
Add all items from the basket of customerFrom to the basket of the customer associated to the
sessionId. |
void |
mergeBasketsWithOptions(java.lang.String storeId,
java.lang.String sessionId,
int customerFromId,
com.konakart.rmi.app.S_AddToBasketOptions options)
Add all items from the basket of customerFrom to the basket of the customer associated to the
sessionId. |
void |
mergeWishListsWithOptions(java.lang.String storeId,
java.lang.String sessionId,
int customerFromId,
int languageId,
com.konakart.rmi.app.S_AddToWishListOptions options)
Add all items from the wish list of customerFrom to the wish list of customerTo which is
retrieved from the sessionId.
|
com.konakart.rmi.app.S_Email |
notifySysAdmin(java.lang.String storeId,
java.lang.String message,
com.konakart.rmi.app.S_EmailOptions options)
This method is used to send a template based eMail to the System Administrator.
|
int |
pointsAvailable(java.lang.String storeId,
java.lang.String sessionId)
Calculates the number of reward points available for the customer identified by the
sessionId parameter. |
void |
postMessageToQueue(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_MqOptions options)
Post a message to a specified queue.
|
void |
processKKEvents(java.lang.String storeId,
java.lang.String sessionId)
To force the processing of KKEvents
|
com.konakart.rmi.app.S_MqResponse |
readMessageFromQueue(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_MqOptions options)
Read a single message from a specified queue.
|
int |
registerCustomer(java.lang.String storeId,
com.konakart.rmi.app.S_CustomerRegistration custReg)
Receives all of the necessary parameters from the Customer Registration object to create a
new customer in the database.
|
void |
removeBasketItemsPerCustomer(java.lang.String storeId,
java.lang.String sessionId,
int customerId)
All Basket objects that exist for this customer are deleted.
|
void |
removeFromBasket(java.lang.String storeId,
java.lang.String sessionId,
int customerId,
com.konakart.rmi.app.S_Basket item)
The Basket object is deleted.
|
void |
removeFromWishList(java.lang.String storeId,
java.lang.String sessionId,
int wishListItemId)
Remove the WishListItem object referenced by wishListItemId.
|
void |
removeFromWishListWithOptions(java.lang.String storeId,
java.lang.String sessionId,
int wishListItemId,
com.konakart.rmi.app.S_AddToWishListOptions options)
Remove the WishListItem object referenced by wishListItemId.
|
int |
removeStockReservationsForBasketItems(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_Basket[] basketItems,
com.konakart.rmi.app.S_StockReservationOptions options)
This API call is used to remove stock reservations.
|
int |
removeStockReservationsForIds(java.lang.String storeId,
java.lang.String sessionId,
int[] idArray,
com.konakart.rmi.app.S_StockReservationOptions options)
This API call is used to remove stock reservations.
|
int |
removeStockReservationsForOrderProducts(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_OrderProduct[] orderProducts,
com.konakart.rmi.app.S_StockReservationOptions options)
This API call is used to remove stock reservations.
|
int |
reservePoints(java.lang.String storeId,
java.lang.String sessionId,
int points)
Removes a number of reward points from the total for the customer identified by the
sessionId parameter. |
com.konakart.rmi.app.S_Basket[] |
reserveStock(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_Basket[] basketItems,
com.konakart.rmi.app.S_StockReservationOptions options)
The purpose of this API call is to reserve stock in order to give a customer enough time to
checkout without risking that the products being ordered become unavailable while checking
out.
|
int |
saveIpnHistory(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_IpnHistory ipnHistory)
A new IpnHistory (Instant Product Notification) record is created in the database.
|
int |
saveOrder(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_Order order,
int languageId)
A new order is created in the DB.
|
int |
saveOrderWithOptions(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_Order order,
int languageId,
com.konakart.rmi.app.S_SaveOrderOptions options)
A new order is created in the DB.
|
java.lang.String |
saveSSOToken(java.lang.String storeId,
com.konakart.rmi.app.S_SSOToken token)
Saves the SSOToken in the database and returns a UUID secret key identifier.
|
com.konakart.rmi.app.S_Orders |
searchForOrdersPerCustomer(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
com.konakart.rmi.app.S_OrderSearch orderSearch,
int languageId)
Retrieve a number of orders for the customer referenced by the
sessionId for the
given language. |
com.konakart.rmi.app.S_Products |
searchForProducts(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
com.konakart.rmi.app.S_ProductSearch prodSearch,
int languageId)
Returns all products using the given language.
|
com.konakart.rmi.app.S_Products |
searchForProductsWithOptions(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
com.konakart.rmi.app.S_ProductSearch prodSearch,
int languageId,
com.konakart.rmi.app.S_FetchProductOptions options)
An options object is passed in to customize from where some of the product attributes (such
as price and quantity) are fetched from.
|
com.konakart.rmi.app.S_Subscriptions |
searchForSubscriptionsPerCustomer(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
com.konakart.rmi.app.S_SubscriptionSearch subscriptionSearch)
Retrieve a number of subscriptions for the customer referenced by the
sessionId. |
com.konakart.rmi.app.S_WishLists |
searchForWishLists(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
com.konakart.rmi.app.S_CustomerSearch customerSearch)
All wish lists matching the search criteria will be returned.
|
com.konakart.rmi.app.S_Zone[] |
searchForZones(java.lang.String storeId,
com.konakart.rmi.app.S_ZoneSearch search)
Search for zones using various search criteria
|
void |
sendNewPassword(java.lang.String storeId,
java.lang.String emailAddr,
java.lang.String subject,
java.lang.String countryCode)
Deprecated.
|
com.konakart.rmi.app.S_Email |
sendNewPassword1(java.lang.String storeId,
java.lang.String emailAddr,
com.konakart.rmi.app.S_EmailOptions options)
A mail is sent to emailAddr containing a new password.
|
void |
sendOrderConfirmationEmail(java.lang.String storeId,
java.lang.String sessionId,
int orderId,
java.lang.String mailSubject,
int languageId)
Deprecated.
|
com.konakart.rmi.app.S_Email |
sendOrderConfirmationEmail1(java.lang.String storeId,
java.lang.String sessionId,
int orderId,
int langIdForOrder,
com.konakart.rmi.app.S_EmailOptions options)
A confirmation mail is sent after submitting an order.
|
void |
sendTemplateEmailToCustomer(java.lang.String storeId,
int customerId,
java.lang.String templateName,
java.lang.String message,
java.lang.String countryCode)
Deprecated.
|
com.konakart.rmi.app.S_Email |
sendTemplateEmailToCustomer1(java.lang.String storeId,
int customerId,
java.lang.String message,
com.konakart.rmi.app.S_EmailOptions options)
This method is used to send a template based eMail to a customer identified by the customerId
parameter.
|
void |
sendWelcomeEmail(java.lang.String storeId,
int customerId,
java.lang.String mailSubject,
java.lang.String countryCode)
Deprecated.
|
com.konakart.rmi.app.S_Email |
sendWelcomeEmail1(java.lang.String storeId,
int customerId,
com.konakart.rmi.app.S_EmailOptions options)
A welcome email is sent after registration of a new customer.
|
void |
setCookie(java.lang.String storeId,
com.konakart.rmi.app.S_KKCookie cookie)
Saves the cookie in the database.
|
void |
setCreditCardDetailsOnOrder(java.lang.String storeId,
java.lang.String sessionId,
int orderId,
com.konakart.rmi.app.S_CreditCard card)
The credit card details in the CreditCard object passed in as a parameter, are saved in the
database for an existing order.
|
void |
setDefaultAddressPerCustomer(java.lang.String storeId,
java.lang.String sessionId,
int addressId)
Sets the default address for this customer to be the address identified by
addressId. |
void |
setEndpoint(java.lang.String storeId,
java.lang.String wsEndpoint)
Set the Web Service endpoint for the engine.
|
void |
setNewPassword(java.lang.String storeId,
java.lang.String adminSession,
java.lang.String customerEmailAddr,
int customerId,
java.lang.String newPassword)
Used to change the password of a customer.
|
void |
setRewardPointReservationId(java.lang.String storeId,
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 on the order. |
void |
updateBasket(java.lang.String storeId,
java.lang.String sessionId,
int customerId,
com.konakart.rmi.app.S_Basket item)
Updates the Basket object in the database.
|
void |
updateBasketWithOptions(java.lang.String storeId,
java.lang.String sessionId,
int customerId,
com.konakart.rmi.app.S_Basket item,
com.konakart.rmi.app.S_AddToBasketOptions options)
Updates the Basket object in the database.
|
com.konakart.rmi.app.S_Basket[] |
updateBasketWithStockInfo(java.lang.String storeId,
com.konakart.rmi.app.S_Basket[] basketItems)
Receives an array of basket items and updates each one with the current stock level.
|
com.konakart.rmi.app.S_Basket[] |
updateBasketWithStockInfoWithOptions(java.lang.String storeId,
com.konakart.rmi.app.S_Basket[] basketItems,
com.konakart.rmi.app.S_AddToBasketOptions options)
Receives an array of basket items and updates each one with the current stock level.
|
void |
updateCachedConfigurations(java.lang.String storeId)
Wherever in the engine any configurations have been cached, they are refreshed when this
method is called.
|
int |
updateDigitalDownloadCount(java.lang.String storeId,
java.lang.String sessionId,
int productId)
Updates the count of the Digital Download identified by the
productId and the
customer identified by the sessionId. |
int |
updateDigitalDownloadCountById(java.lang.String storeId,
java.lang.String sessionId,
int digitalDownloadId)
Updates the count of the Digital Download identified by the
digitalDownloadId
and the customer identified by the sessionId. |
void |
updateInventory(java.lang.String storeId,
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 storeId,
java.lang.String sessionId,
int orderId,
com.konakart.rmi.app.S_CreateOrderOptions options)
If
options is set to null, this method is identical to
updateInventory(). |
void |
updateManufacturerViewedCount(java.lang.String storeId,
int manufacturerId,
int languageId)
It updates the number of times that the manufacturer referenced by
manufacturerId, has been clicked on, to view the home page. |
void |
updateOrder(java.lang.String storeId,
java.lang.String sessionId,
int orderId,
int status,
boolean customerNotified,
java.lang.String comments,
com.konakart.rmi.app.S_OrderUpdate 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 |
updateOrderWithPaymentModuleSubCode(java.lang.String storeId,
java.lang.String sessionId,
int orderId,
int status,
boolean customerNotified,
java.lang.String comments,
java.lang.String paymentModuleSubCode,
com.konakart.rmi.app.S_OrderUpdate 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 |
updateProductViewedCount(java.lang.String storeId,
int productId,
int languageId)
It updates the number of times that the product referenced by
productId, has
been viewed. |
void |
updateSubscription(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_Subscription subscription)
A Subscription object identified by the subscription passed in as a parameter is updated in
the database.
|
com.konakart.rmi.app.S_CaptchaResult |
validateCaptcha(java.lang.String storeId,
com.konakart.rmi.app.S_CaptchaInput captchaInfo)
Used for validate captcha
|
boolean |
validatePassword(java.lang.String storeId,
java.lang.String sessionId,
java.lang.String password)
This method validates the password of a logged in customer and can be used to force the
customer to enter his password before allowing certain actions like the modification of the
customer's email address.
|
int |
writeReview(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_Review review)
Receives all of the necessary parameters from the Review object to create a new review in the
database.
|
com.konakart.rmi.app.S_Language[] getLanguages(java.lang.String storeId,
com.konakart.rmi.app.S_LanguageSearch search)
throws java.rmi.RemoteException
storeId - the storeIdsearch - criteriajava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Language[] getAllLanguages(java.lang.String storeId)
throws java.rmi.RemoteException
storeId - the storeIdjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Language getDefaultLanguage(java.lang.String storeId)
throws java.rmi.RemoteException
storeId - the storeIdjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Language getLanguagePerCode(java.lang.String storeId,
java.lang.String code)
throws java.rmi.RemoteException
storeId - the storeIdcode - The two letter language code such as en, de, es etc.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Language getLanguagePerId(java.lang.String storeId,
int languageId)
throws java.rmi.RemoteException
storeId - the storeIdlanguageId - The numeric id of the language objectjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Category[] getCategoryTree(java.lang.String storeId,
int languageId,
boolean getNumProducts)
throws java.rmi.RemoteException
The name of the category is language dependent and will be returned in the language defined
by the languageId parameter.
Each Category class contains a numberOfProducts field that describes how many
products exist for that category. It is only calculated if the getNumProducts
input parameter is set to true. For performance reasons this parameter should be set to false
if numberOfProducts is not required.
If you do not set numberOfProducts to true beware that the category tree
returned will be a reference to the static category tree object and not a clone. This is only
relevant when using the POJO KKEng engine.
storeId - the storeIdlanguageId - The id for the language that will be used to determine the Category name. Value of
-1 selects the default language.getNumProducts - A boolean that specifies whether the Category objects should have the
numberOfProducts attribute set.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Category[] getCategoryTreeWithOptions(java.lang.String storeId,
com.konakart.rmi.app.S_CategoryTreeOptions options)
throws java.rmi.RemoteException
The name of the category is language dependent and will be returned in the language defined
by the languageId parameter of the CategoryTreeOptions object.
Each Category class contains a numberOfProducts field that describes how many
products exist for that category. It is only calculated if the getNumProducts
input parameter of the CategoryTreeOptions object is set to true. For performance reasons
this parameter should be set to false if numberOfProducts is not required.
If the CategoryTreeOptions object has its returnClonedTree attribute set to true a cloned
version of the category tree will be returned. A cloned version of the category tree will
always be returned if you set the numberOfProducts to true. This is only
relevant when using the POJO KKEng engine.
storeId - the storeIdoptions - Category tree options object.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Products getProductsPerCategory(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
int categoryId,
boolean searchInSubCats,
int languageId)
throws java.rmi.RemoteException
Only Products with a non zero status and non zero invisible are returned. The description (which can be very long) and the array of options are not set. The specialPrice is null if a special offer doesn't exist for the product.
dataDesc may be null. In this case, the number of retrieved products is limited
to a default number, the products are ordered by the ProductId and the offset is set to zero.
However, by setting the attributes of dataDesc, the following functionality may
be controlled :
storeId - the storeIdsessionId - The session id of the logged in user; use null if the customer isn't logged in.dataDesc - Used to control the data offset, limit the number of items returned and set the
sort ordercategoryId - The numeric id of the categorysearchInSubCats - Determines whether products are searched for in the sub-categories of the
specified categorylanguageId - The id for the language that will be used. Value of -1 selects the default
language.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Products getProductsPerCategoryWithOptions(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
int categoryId,
boolean searchInSubCats,
int languageId,
com.konakart.rmi.app.S_FetchProductOptions options)
throws java.rmi.RemoteException
Returns a Products object for the given category and language.
Only Products with a non zero status and non zero invisible are returned. The description (which can be very long) and the array of options are not set. The specialPrice is null if a special offer doesn't exist for the product.
dataDesc may be null. In this case, the number of retrieved products is limited
to a default number, the products are ordered by the ProductId and the offset is set to zero.
However, by setting the attributes of dataDesc, the following functionality may
be controlled :
storeId - the storeIdsessionId - The session id of the logged in user; use null if the customer isn't logged in.dataDesc - Used to control the data offset, limit the number of items returned and set the
sort ordercategoryId - The numeric id of the categorysearchInSubCats - Determines whether products are searched for in the sub-categories of the
specified categorylanguageId - The id for the language that will be used. Value of -1 selects the default
language.options - An object containing options for the method. It may be set to null.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Products getProductsPerCategoryPerManufacturer(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
int categoryId,
int manufacturerId,
int languageId)
throws java.rmi.RemoteException
Only Products with a non zero status and non zero invisible are returned. The description (which can be very long) and the array of options are not set. The specialPrice is null if a special offer doesn't exist for the product.
dataDesc may be null. In this case, the number of retrieved products is limited
to a default number, the products are ordered by the ProductId and the offset is set to zero.
However, by setting the attributes of dataDesc, the following functionality may
be controlled :
storeId - the storeIdsessionId - The session id of the logged in user; use null if the customer isn't logged in.dataDesc - Used to control the data offset, limit the number of items returned and set the
sort ordercategoryId - The numeric id of the categorylanguageId - The id for the language that will be used. Value of -1 selects the default
language.manufacturerId - The numeric id of the manufacturerjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Products getProductsPerCategoryPerManufacturerWithOptions(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
int categoryId,
int manufacturerId,
int languageId,
com.konakart.rmi.app.S_FetchProductOptions options)
throws java.rmi.RemoteException
Returns a Products object for the given category, language and manufacturer.
Only Products with a non zero status and non zero invisible are returned. The description (which can be very long) and the array of options are not set. The specialPrice is null if a special offer doesn't exist for the product.
dataDesc may be null. In this case, the number of retrieved products is limited
to a default number, the products are ordered by the ProductId and the offset is set to zero.
However, by setting the attributes of dataDesc, the following functionality may
be controlled :
storeId - the storeIdsessionId - The session id of the logged in user; use null if the customer isn't logged in.dataDesc - Used to control the data offset, limit the number of items returned and set the
sort ordercategoryId - The numeric id of the categorylanguageId - The id for the language that will be used. Value of -1 selects the default
language.manufacturerId - The numeric id of the manufactureroptions - An object containing options for the method. It may be set to null.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Products getProductsPerManufacturer(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
int manufacturerId,
int languageId)
throws java.rmi.RemoteException
Only Products with a non zero status and non zero invisible are returned. The description (which can be very long) and the array of options are not set. The specialPrice is null if a special offer doesn't exist for the product.
dataDesc may be null. In this case, the number of retrieved products is limited
to a default number, the products are ordered by the ProductId and the offset is set to zero.
However, by setting the attributes of dataDesc, the following functionality may
be controlled :
storeId - the storeIdsessionId - The session id of the logged in user; use null if the customer isn't logged in.dataDesc - Used to control the data offset, limit the number of items returned and set the
sort ordermanufacturerId - The numeric id of the manufacturerlanguageId - The id for the language that will be used. Value of -1 selects the default
language.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Products getProductsPerManufacturerWithOptions(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
int manufacturerId,
int languageId,
com.konakart.rmi.app.S_FetchProductOptions options)
throws java.rmi.RemoteException
Returns a Products object for the given manufacturer and language.
Only Products with a non zero status and non zero invisible are returned. The description (which can be very long) and the array of options are not set. The specialPrice is null if a special offer doesn't exist for the product.
dataDesc may be null. In this case, the number of retrieved products is limited
to a default number, the products are ordered by the ProductId and the offset is set to zero.
However, by setting the attributes of dataDesc, the following functionality may
be controlled :
storeId - the storeIdsessionId - The session id of the logged in user; use null if the customer isn't logged in.dataDesc - Used to control the data offset, limit the number of items returned and set the
sort ordermanufacturerId - The numeric id of the manufacturerlanguageId - The id for the language that will be used. Value of -1 selects the default
language.options - An object containing options for the method. It may be set to null.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Product getProduct(java.lang.String storeId,
java.lang.String sessionId,
int productId,
int languageId)
throws java.rmi.RemoteException
productId and language.
Returns null if no product is found. The specialPrice is null if a special offer doesn't exist for the product.
storeId - the storeIdsessionId - The session id of the logged in user; use null if the customer isn't logged in.productId - The numeric id of the productlanguageId - The id for the language that will be used. Value of -1 selects the default
language.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Product getProductWithOptions(java.lang.String storeId,
java.lang.String sessionId,
int productId,
int languageId,
com.konakart.rmi.app.S_FetchProductOptions options)
throws java.rmi.RemoteException
Returns a complete Product object for the given productId and language.
Returns null if no product is found. The specialPrice is null if a special offer doesn't exist for the product.
storeId - the storeIdsessionId - The session id of the logged in user; use null if the customer isn't logged in.productId - The numeric id of the productlanguageId - The id for the language that will be used. Value of -1 selects the default
language.options - An object containing options for the method. It may be set to null.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Category[] getCategoriesPerManufacturer(java.lang.String storeId,
int manufacturerId,
int languageId)
throws java.rmi.RemoteException
storeId - the storeIdmanufacturerId - The numeric id of the manufacturerlanguageId - The id for the language that will be used. Value of -1 selects the default
language.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Category[] getCategoriesPerProduct(java.lang.String storeId,
int productId,
int languageId)
throws java.rmi.RemoteException
storeId - the storeIdproductId - The numeric id of the productlanguageId - The id for the language that will be used. Value of -1 selects the default
language.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Manufacturer[] getManufacturersPerCategory(java.lang.String storeId,
int categoryId)
throws java.rmi.RemoteException
This method is normally used for fetching all the product manufacturers within a category so that products may be filtered by manufacturer.
storeId - the storeIdcategoryId - The numeric id of the categoryjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Manufacturer[] getManufacturers(java.lang.String storeId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
com.konakart.rmi.app.S_ManufacturerSearch search,
int languageId)
throws java.rmi.RemoteException
dataDesc controls the following functionality:
storeId - the storeIddataDesc - The data descriptor object that defines the sort order, constraints on custom
fields and offset and limit for paging.search - The Manufacturer search object that defines the search criterialanguageId - The language id is used for language specific attributes of the manufacturer such
as the URL.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Manufacturer[] getAllManufacturers(java.lang.String storeId)
throws java.rmi.RemoteException
If the system has a large number of manufacturers, it better to use the
getManufacturers(DataDescriptorIf dataDesc, ManufacturerSearchIf search, int languageId)
method where the DatDescriptor can be used to limit the number of manufacturers returned.
storeId - the storeIdjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Manufacturer getManufacturerPerProduct(java.lang.String storeId,
int productId,
int languageId)
throws java.rmi.RemoteException
productId and language.storeId - the storeIdproductId - The numeric id of the productlanguageId - The id for the language that will be used. Value of -1 selects the default
language.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Manufacturer getManufacturer(java.lang.String storeId,
int manufacturerId,
int languageId)
throws java.rmi.RemoteException
manufacturerId and language.storeId - the storeIdmanufacturerId - The numeric id of the manufacturerlanguageId - The id for the language that will be used. Value of -1 selects the default
language.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Category getCategory(java.lang.String storeId,
int categoryId,
int languageId)
throws java.rmi.RemoteException
categoryId and language.
It does not populate the children even if they exist. It does populate the MiscItem array.storeId - the storeIdcategoryId - The numeric id of the categorylanguageId - The id for the language that will be used. Value of -1 selects the default
language.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Products getSpecialsPerCategory(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
int categoryId,
boolean searchInSubCats,
int languageId)
throws java.rmi.RemoteException
categoryId and language.
Only Products with a non zero status and non zero invisible are returned. The description (which can be very long) and the array of options are not set. The specialPrice is null if a special offer doesn't exist for the product.
dataDesc may be null. In this case, the number of retrieved products is limited
to a default number, the products are ordered by the ProductId and the offset is set to zero.
However, by setting the attributes of dataDesc, the following functionality may
be controlled :
storeId - the storeIdsessionId - The session id of the logged in userdataDesc - Used to control the data offset, limit the number of items returned and set the
sort ordercategoryId - The numeric id of the categorysearchInSubCats - Determines whether products are searched for in the sub-categories of the
specified categorylanguageId - The id for the language that will be used. Value of -1 selects the default
language.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Products getAllSpecials(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
int languageId)
throws java.rmi.RemoteException
Only Products with a non zero status and non zero invisible are returned. The description (which can be very long) and the array of options are not set. The specialPrice is null if a special offer doesn't exist for the product.
dataDesc may be null. In this case, the number of retrieved products is limited
to a default number, the products are ordered by the ProductId and the offset is set to zero.
However, by setting the attributes of dataDesc, the following functionality may
be controlled :
storeId - the storeIdsessionId - The session id of the logged in userdataDesc - Used to control the data offset, limit the number of items returned and set the
sort orderlanguageId - The id for the language that will be used. Value of -1 selects the default
language.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Products getAllProducts(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
int languageId)
throws java.rmi.RemoteException
Only Products with a non zero status and non zero invisible are returned. The description (which can be very long) and the array of options are not set. The specialPrice is null if a special offer doesn't exist for the product.
dataDesc may be null. In this case, the number of retrieved products is limited
to a default number, the products are ordered by the ProductId and the offset is set to zero.
However, by setting the attributes of dataDesc, the following functionality may
be controlled :
storeId - the storeIdsessionId - The session id of the logged in userdataDesc - Used to control the data offset, limit the number of items returned and set the
sort orderlanguageId - The id for the language that will be used. Value of -1 selects the default
language.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Products getAllProductsWithOptions(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
int languageId,
com.konakart.rmi.app.S_FetchProductOptions options)
throws java.rmi.RemoteException
Returns all products using the given language.
Only Products with a non zero status and non zero invisible are returned. The description (which can be very long) and the array of options are not set. The specialPrice is null if a special offer doesn't exist for the product.
dataDesc may be null. In this case, the number of retrieved products is limited
to a default number, the products are ordered by the ProductId and the offset is set to zero.
However, by setting the attributes of dataDesc, the following functionality may
be controlled :
storeId - the storeIdsessionId - The session id of the logged in userdataDesc - Used to control the data offset, limit the number of items returned and set the
sort orderlanguageId - The id for the language that will be used. Value of -1 selects the default
language.options - An object containing options for the method. It may be set to null.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Reviews getReviewsPerProduct(java.lang.String storeId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
int productId)
throws java.rmi.RemoteException
productId.
The averageRating attribute of the reviews is calculated and set by the method.
All reviews are retrieved, regardless of the language. dataDesc may be null. In
this case, the number of retrieved reviews is limited to a default number, the reviews are
ordered by the ReviewId and the offset is set to zero. However, by setting the attributes of
dataDesc, the following functionality may be controlled :
storeId - the storeIddataDesc - Used to control the data offset, limit the number of items returned and set the
sort orderproductId - The numeric id of the productjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Review getReview(java.lang.String storeId,
int reviewId)
throws java.rmi.RemoteException
reviewId. The
averageRating attribute of the review is calculated and set by the method.storeId - the storeIdreviewId - The numeric id of the reviewjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Reviews getAllReviews(java.lang.String storeId,
com.konakart.rmi.app.S_DataDescriptor dataDesc)
throws java.rmi.RemoteException
dataDesc may be null. In this case, the number of retrieved reviews is limited
to a default number, the reviews are ordered by the ReviewId and the offset is set to zero.
However, by setting the attributes of dataDesc, the following functionality may
be controlled :
storeId - the storeIddataDesc - Used to control the data offset, limit the number of items returned and set the
sort orderjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Reviews getReviews(java.lang.String storeId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
com.konakart.rmi.app.S_ReviewSearch search)
throws java.rmi.RemoteException
The ReviewSearch object also allows you to specify that the return data contains:
dataDesc controls the following functionality:
storeId - the storeIddataDesc - The data descriptor object that defines the sort order, constraints on custom
fields and offset and limit for paging.search - The Review search object that defines the search criteriajava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Products searchForProducts(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
com.konakart.rmi.app.S_ProductSearch prodSearch,
int languageId)
throws java.rmi.RemoteException
Only Products with a non zero status and non zero invisible are returned. The description (which can be very long) and the array of options are not set. The specialPrice is null if a special offer doesn't exist for the product.
dataDesc may be null. In this case, the number of retrieved products is limited
to a default number, the products are ordered by the ProductId and the offset is set to zero.
However, by setting the attributes of dataDesc, the following functionality may
be controlled :
storeId - the storeIdsessionId - The session id of the logged in userdataDesc - Used to control the data offset, limit the number of items returned and set the
sort orderprodSearch - Contains information used to search the catalog for a productlanguageId - The id for the language that will be used. Value of -1 selects the default
language.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Products searchForProductsWithOptions(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
com.konakart.rmi.app.S_ProductSearch prodSearch,
int languageId,
com.konakart.rmi.app.S_FetchProductOptions options)
throws java.rmi.RemoteException
Returns all products using the given language. The ProductSearch class contains the search criteria.
Only Products with a non zero status and non zero invisible are returned. The description (which can be very long) and the array of options are not set. The description will only be set if specified in the ProductSearch object passed in as a parameter. The specialPrice is null if a special offer doesn't exist for the product.
dataDesc may be null. In this case, the number of retrieved products is limited
to a default number, the products are ordered by the ProductId and the offset is set to zero.
However, by setting the attributes of dataDesc, the following functionality may
be controlled :
storeId - the storeIdsessionId - The session id of the logged in userdataDesc - Used to control the data offset, limit the number of items returned and set the
sort orderprodSearch - Contains information used to search the catalog for a productlanguageId - The id for the language that will be used. Value of -1 selects the default
language.options - An object containing options for the method. It may be set to null.java.rmi.RemoteException - an unexpected KKException exceptionint registerCustomer(java.lang.String storeId,
com.konakart.rmi.app.S_CustomerRegistration custReg)
throws java.rmi.RemoteException
telephoneUnique and
telephone1Unique attributes of the CustomerRegistration object you can instruct
KonaKart to check the telephone numbers for uniqueness.
If the country has at least one zone defined in the database, then we verify that the State attribute of the CustomerRegistration object matches one of the defined zones, otherwise a kkInvalidZoneException is thrown. If a match is found, then the zoneId is saved in the database table. If no zones are defined for the country, then we don't make the check and save the State attribute directly in the database.
storeId - the storeIdcustReg - Contains all the required data in order to register a new customerjava.rmi.RemoteException - an unexpected KKException exceptionint forceRegisterCustomer(java.lang.String storeId,
com.konakart.rmi.app.S_CustomerRegistration custReg)
throws java.rmi.RemoteException
registerCustomer() when you want to provide a
store that doesn't force a customer to register. It registers a customer as a temporary
customer and allows you to register this customer more than once as long as the customer
remains temporary. i.e. Doesn't go through a proper registration process.
KonaKart requires a temporary customer (one that has never registered) to be present in its database even if the store doesn't require registration. If a temporary customer with the same eMail address already exists, then this customer is deleted. An exception is thrown if a non-temporary customer (one that has registered) exists with the same eMail. You must still supply a password (which can be randomly generated) which you must then use to log in the customer so that he can checkout.
If you wish to allow a registered customer to checkout without logging in, then you must set
allowMultipleRegistrations to true in the CustomerRegistration
object passed in as a parameter. Note that a temporary customer is created for the checkout,
and the order is not added to the account of the existing registered customer with the same
email address.
If your online store lets users choose whether to register or not, this method should be used if a user decides not to register since you still require to gather the user's personal details such as name and address.
Depending on how much customer information you have, you may set booleans in the Customer Registration object in order to instruct KonaKart to create default values. These booleans are:
storeId - the storeIdcustReg - Contains all the required data in order to register a new customerjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Country[] getAllCountries(java.lang.String storeId)
throws java.rmi.RemoteException
storeId - the storeIdjava.rmi.RemoteException - an unexpected KKException exceptionjava.lang.String login(java.lang.String storeId,
java.lang.String emailAddr,
java.lang.String password)
throws java.rmi.RemoteException
storeId - the storeIdemailAddr - The username required to log inpassword - The log in passwordjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_LoginResult loginWithOptions(java.lang.String storeId,
com.konakart.rmi.app.S_LoginInput input)
throws java.rmi.RemoteException
The input object allows you to set either the email address, username, telephone number or telephone number 1 as the username. Only one of these must contain a non null value, otherwise an exception will be thrown.
storeId - the storeIdinput - LoginInput object containing the username and passwordjava.rmi.RemoteException - an unexpected KKException exceptionvoid logout(java.lang.String storeId,
java.lang.String sessionId)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - The session Id of the logged in userjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Address[] getAddressesPerCustomer(java.lang.String storeId,
java.lang.String sessionId)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - The session id of the logged in userjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Address[] getAddressesPerManufacturer(java.lang.String storeId,
int manufacturerId)
throws java.rmi.RemoteException
storeId - the storeIdmanufacturerId - the manufacturerIdjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Address[] getAddressesPerProduct(java.lang.String storeId,
int productId)
throws java.rmi.RemoteException
storeId - the storeIdproductId - the productIdjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Address[] getAddressesPerStore(java.lang.String storeId,
java.lang.String addressStoreId)
throws java.rmi.RemoteException
storeId - the storeIdaddressStoreId - the addressStoreIdjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Address getDefaultAddressPerCustomer(java.lang.String storeId,
java.lang.String sessionId)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - The session id of the logged in userjava.rmi.RemoteException - an unexpected KKException exceptionvoid setDefaultAddressPerCustomer(java.lang.String storeId,
java.lang.String sessionId,
int addressId)
throws java.rmi.RemoteException
addressId. A check is made to determine whether an address exists with that id
and that it belongs to the customer logged in with this sessionId.storeId - the storeIdsessionId - The session id of the logged in useraddressId - The numeric id of the address objectjava.rmi.RemoteException - an unexpected KKException exceptionint addAddressToCustomer(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_Address addr)
throws java.rmi.RemoteException
sessionId. The id of
the address object is ignored since it is calculated during the insertion process. The zoneId
is also calculated unless addr.isUseZoneId()is set to true. In this case the zoneId from the
address object is used. The customerId of the address object is also ignored. An exception is
thrown if the sessionId isn't valid.storeId - the storeIdsessionId - The session id of the logged in useraddr - The address object which will be added to the customerjava.rmi.RemoteException - an unexpected KKException exceptionvoid deleteAddressFromCustomer(java.lang.String storeId,
java.lang.String sessionId,
int addressId)
throws java.rmi.RemoteException
sessionId and addressId is deleted. The
customerId is retrieved from the session. An exception is thrown if the session isn't valid
and if the address referenced by the addressId doesn't belong to the customer
referenced by the sessionId. An exception is also thrown if we attempt to delete
the default address.storeId - the storeIdsessionId - The session id of the logged in useraddressId - The numeric id of the address objectjava.rmi.RemoteException - an unexpected KKException exceptionvoid editCustomerAddress(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_Address addr)
throws java.rmi.RemoteException
sessionId passed in as a parameter. The zoneId is ignored since it is calculated
during the insertion process, unless addr.isUseZoneId() is set to true. In this case the
zoneId from the address object is used. The addressId is used to identify the
address object. The customerId attribute of the address object is ignored since it is
obtained from the sessionId. An exception is thrown if the session isn't valid.storeId - the storeIdsessionId - The session id of the logged in useraddr - The address object to editjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Customer getCustomer(java.lang.String storeId,
java.lang.String sessionId)
throws java.rmi.RemoteException
sessionId.
Throws an exception if the session has expired.storeId - the storeIdsessionId - The session id of the logged in userjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Customer getCustomerWithOptions(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_FetchCustomerOptions options)
throws java.rmi.RemoteException
sessionId.
Throws an exception if the session has expired.storeId - the storeIdsessionId - The session id of the logged in useroptions - An object containing options for the method. It may be set to null.java.rmi.RemoteException - an unexpected KKException exceptionvoid editCustomer(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_Customer cust)
throws java.rmi.RemoteException
cust has to be the same customer logged in with a valid sessionId.
Only non null attributes or integers not equal to -1 will be used (i.e. set an integer field
to -1 if you do not want to change it).
The attributes from the Customer object that are used are :
storeId - the storeIdsessionId - The session id of the logged in usercust - The customer object to editjava.rmi.RemoteException - an unexpected KKException exceptionvoid editCustomerWithOptions(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_Customer cust,
com.konakart.rmi.app.S_EditCustomerOptions options)
throws java.rmi.RemoteException
cust has to be the same customer logged in with a valid sessionId.
Only non null attributes or integers not equal to -1 will be used (i.e. set an integer field
to -1 if you do not want to change it).
The attributes from the Customer object that are used are :
storeId - the storeIdsessionId - The session id of the logged in usercust - The customer object to editoptions - Allows you to define whether KonaKart should check that the telephone number being
set is unique (does not belong to an existing registered customer).java.rmi.RemoteException - an unexpected KKException exceptionjava.util.Calendar getKonakartTimeStamp(java.lang.String storeId)
throws java.rmi.RemoteException
storeId - the storeIdjava.rmi.RemoteException - an unexpected KKException exceptionint writeReview(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_Review review)
throws java.rmi.RemoteException
sessionId.
The obligatory parameters are :
storeId - the storeIdsessionId - The session id of the logged in userreview - The review that will be insertedjava.rmi.RemoteException - an unexpected KKException exceptionint checkSession(java.lang.String storeId,
java.lang.String sessionId)
throws java.rmi.RemoteException
sessionId is checked to see whether it exists and whether it is has
timed out. If it is valid, the expiry attribute is updated. An exception is thrown if it is
not valid.storeId - the storeIdsessionId - The session id of the logged in userjava.rmi.RemoteException - an unexpected KKException exceptionint addToBasket(java.lang.String storeId,
java.lang.String sessionId,
int customerId,
com.konakart.rmi.app.S_Basket item)
throws java.rmi.RemoteException
The Basket object does not have to be fully populated. The compulsory attributes are:
If the customer is logged in to the application, then a valid sessionId is
required and the customerId is ignored. Otherwise, the sessionId
may be set to null and the method will use the customerId, ensuring that the
customer is not a registered customer by checking that the customerId is
negative. All registered customers have positive ids.
storeId - the storeIdsessionId - The session id of the logged in usercustomerId - The numeric id of the customeritem - The basket item to add to the basketjava.rmi.RemoteException - an unexpected KKException exceptionint addToBasketWithOptions(java.lang.String storeId,
java.lang.String sessionId,
int customerId,
com.konakart.rmi.app.S_Basket item,
com.konakart.rmi.app.S_AddToBasketOptions options)
throws java.rmi.RemoteException
options is set to null, this method is identical to
addToBasket(). Otherwise the functionality differs depending on the combination
of options set.
Saves the Basket object in the database for a customer. If the Basket object already exists with exactly the same options etc, then we either just increase the quantity of the existing object or we add a new object. This depends on the options.
The Basket object does not have to be fully populated. The compulsory attributes are:
If the customer is logged in to the application, then a valid sessionId is
required and the customerId is ignored. Otherwise, the sessionId
may be set to null and the method will use the customerId, ensuring that the
customer is not a registered customer by checking that the customerId is
negative. All registered customers have positive ids.
storeId - the storeIdsessionId - The session id of the logged in usercustomerId - The numeric id of the customeritem - The basket item to add to the basketoptions - An object containing options for the method. It may be set to null.java.rmi.RemoteException - an unexpected KKException exceptionvoid mergeBaskets(java.lang.String storeId,
java.lang.String sessionId,
int customerFromId)
throws java.rmi.RemoteException
sessionId. The customer receiving the basket items, must be logged on, which is
why the method parameter is a sessionId and not a customerId. This
method is normally called when a customer logs on, in order to move his temporary basket to
his permanent basket. The items are merged into the target basket. i.e. If a similar item
already exists, then the quantity is increased.storeId - the storeIdsessionId - The session id of the logged in usercustomerFromId - The numeric id of the customer that has the temporary basketjava.rmi.RemoteException - an unexpected KKException exceptionvoid mergeBasketsWithOptions(java.lang.String storeId,
java.lang.String sessionId,
int customerFromId,
com.konakart.rmi.app.S_AddToBasketOptions options)
throws java.rmi.RemoteException
sessionId. The customer receiving the basket items, must be logged on, which is
why the method parameter is a sessionId and not a customerId. This
method is normally called when a customer logs on, in order to move his temporary basket to
his permanent basket. The items are merged into the target basket. i.e. If a similar item
already exists, then the quantity is increased.
If options is set to null then this call is identical to mergeBaskets(). The options may determine from where we read the price and quantity of the basket items.
storeId - the storeIdsessionId - The session id of the logged in usercustomerFromId - The numeric id of the customer that has the temporary basketoptions - An object containing options for the method. It may be set to null.java.rmi.RemoteException - an unexpected KKException exceptionvoid updateBasket(java.lang.String storeId,
java.lang.String sessionId,
int customerId,
com.konakart.rmi.app.S_Basket item)
throws java.rmi.RemoteException
The only attributes that may be changed are:
If the customer is logged in to the application, then a valid sessionId is
required and the customerId is ignored. Otherwise, the sessionId
may be set to null and the method will use the customerId, ensuring that the
customer is not a registered customer by checking that the customerId is
negative. All registered customers have positive ids.
A check is also made to ensure that the basket item being modified, actually belongs to the customer.
storeId - the storeIdsessionId - The session id of the logged in usercustomerId - The numeric id of the customeritem - The basket item to updatejava.rmi.RemoteException - an unexpected KKException exceptionvoid updateBasketWithOptions(java.lang.String storeId,
java.lang.String sessionId,
int customerId,
com.konakart.rmi.app.S_Basket item,
com.konakart.rmi.app.S_AddToBasketOptions options)
throws java.rmi.RemoteException
The only attributes that may be changed are:
If the customer is logged in to the application, then a valid sessionId is
required and the customerId is ignored. Otherwise, the sessionId
may be set to null and the method will use the customerId, ensuring that the
customer is not a registered customer by checking that the customerId is
negative. All registered customers have positive ids.
A check is also made to ensure that the basket item being modified, actually belongs to the customer.
If options is set to null, this method is identical to updateBasket(). Otherwise the functionality differs depending on the combination of options set.
storeId - the storeIdsessionId - The session id of the logged in usercustomerId - The numeric id of the customeritem - The basket item to updateoptions - An object containing options for the method. It may be set to null.java.rmi.RemoteException - an unexpected KKException exceptionvoid removeFromBasket(java.lang.String storeId,
java.lang.String sessionId,
int customerId,
com.konakart.rmi.app.S_Basket item)
throws java.rmi.RemoteException
If the customer is logged in to the application, then a valid sessionId is
required and the customerId is ignored. Otherwise, the sessionId
may be set to null and the method will use the customerId, ensuring that the
customer is not a registered customer by checking that the customerId is
negative. All registered customers have positive ids.
A check is also made to ensure that the basket item being deleted, actually belongs to the customer.
storeId - the storeIdsessionId - The session id of the logged in usercustomerId - The numeric id of the customeritem - The basket item to deletejava.rmi.RemoteException - an unexpected KKException exceptionvoid removeBasketItemsPerCustomer(java.lang.String storeId,
java.lang.String sessionId,
int customerId)
throws java.rmi.RemoteException
If the customer is logged in to the application, then a valid sessionId is
required and the customerId is ignored. Otherwise, the sessionId
may be set to null and the method will use the customerId, ensuring that the
customer is not a registered customer by checking that the customerId is
negative. All registered customers have positive ids.
storeId - the storeIdsessionId - The session id of the logged in usercustomerId - The numeric id of the customerjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Basket[] getBasketItemsPerCustomer(java.lang.String storeId,
java.lang.String sessionId,
int customerId,
int languageId)
throws java.rmi.RemoteException
Each basket item has an instantiated product object.
If the customer is logged in to the application, then a valid sessionId is
required and the customerId is ignored. Otherwise, the sessionId
may be set to null and the method will use the customerId , ensuring that the
customer is not a registered customer by checking that the customerId is
negative. All registered customers have positive ids.
storeId - the storeIdsessionId - The session id of the logged in usercustomerId - The numeric id of the customerlanguageId - The id for the language that will be used. Value of -1 selects the default
language.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Basket[] getBasketItemsPerCustomerWithOptions(java.lang.String storeId,
java.lang.String sessionId,
int customerId,
int languageId,
com.konakart.rmi.app.S_AddToBasketOptions options)
throws java.rmi.RemoteException
If the customer is logged in to the application, then a valid sessionId is
required and the customerId is ignored. Otherwise, the sessionId
may be set to null and the method will use the customerId , ensuring that the
customer is not a registered customer by checking that the customerId is
negative. All registered customers have positive ids.
If in the options object, getStockReservationInfo is set to true, then stock
reservation information is returned. The extra attributes returned are
reservationId - The identifier of the stock reservation.qtyResrvdForResId - The number of reserved items for the basket reservation
id. This is not always equal to the quantity of the basket item.reservationExpiryDate - The date time when the reservation expires.reservationStartDate - The date time when the reservation started.If options is set to null then this call is identical to getBasketItemsPerCustomer(). The options may determine from where we read the price and quantity of the basket items.
storeId - the storeIdsessionId - The session id of the logged in usercustomerId - The numeric id of the customerlanguageId - The id for the language that will be used. Value of -1 selects the default
language.options - An object containing options for the method. It may be set to null.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Currency getDefaultCurrency(java.lang.String storeId)
throws java.rmi.RemoteException
storeId - the storeIdjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Currency[] getAllCurrencies(java.lang.String storeId)
throws java.rmi.RemoteException
storeId - the storeIdjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_KKConfiguration[] getConfigurations(java.lang.String storeId)
throws java.rmi.RemoteException
storeId - the storeIdjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_KKConfiguration getConfiguration(java.lang.String storeId,
java.lang.String key)
throws java.rmi.RemoteException
storeId - the storeIdkey - The key of the configuration objectjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_KKConfiguration getConfigurationNoCache(java.lang.String storeId,
java.lang.String key)
throws java.rmi.RemoteException
storeId - the storeIdkey - The key of the configuration objectjava.rmi.RemoteException - an unexpected KKException exceptionjava.lang.String getConfigurationValue(java.lang.String storeId,
java.lang.String key)
throws java.rmi.RemoteException
storeId - the storeIdkey - The key of the configuration objectjava.rmi.RemoteException - an unexpected KKException exceptionint getConfigurationValueAsInt(java.lang.String storeId,
java.lang.String key)
throws java.rmi.RemoteException
storeId - the storeIdkey - the Configuration Keyjava.rmi.RemoteException - if there is a problem converting the configuration value into an integer.int getConfigurationValueAsIntWithDefault(java.lang.String storeId,
java.lang.String key,
int def)
throws java.rmi.RemoteException
storeId - the storeIdkey - the Configuration Keydef - default value to return if the key isn't found.java.rmi.RemoteException - if there is a problem converting the configuration value into an integer.java.math.BigDecimal getConfigurationValueAsBigDecimal(java.lang.String storeId,
java.lang.String key)
throws java.rmi.RemoteException
storeId - the storeIdkey - the Configuration Keyjava.rmi.RemoteException - if there is a problem converting the configuration value into a BigDecimal.java.math.BigDecimal getConfigurationValueAsBigDecimalWithDefault(java.lang.String storeId,
java.lang.String key,
java.math.BigDecimal def)
throws java.rmi.RemoteException
storeId - the storeIdkey - the Configuration Keydef - default value to use if the key doesn't exist.java.rmi.RemoteException - if there is a problem converting the configuration value into a BigDecimal.java.lang.Boolean getConfigurationValueAsBool(java.lang.String storeId,
java.lang.String key,
java.lang.Boolean def)
throws java.rmi.RemoteException
storeId - the storeIdkey - the Configuration Keydef - the default value to be returned if there's a problemjava.rmi.RemoteException - an unexpected KKException exception@Deprecated
void editConfiguration(java.lang.String storeId,
java.lang.String key,
java.lang.String value)
throws java.rmi.RemoteException
Previously this call allowed the edit of an existing configuration parameter. It threw an exception if the configuration didn't exist.
storeId - the storeIdkey - The key of the configuration objectvalue - The new value for the configurationjava.rmi.RemoteException - in all cases warning that the API call should no longer be used.void changePassword(java.lang.String storeId,
java.lang.String sessionId,
java.lang.String currentPassword,
java.lang.String newPassword)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - The session id of the logged in usercurrentPassword - The current password of the logged in usernewPassword - The new password of the logged in userjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Product[] getProductNotificationsPerCustomer(java.lang.String storeId,
java.lang.String sessionId,
int languageId)
throws java.rmi.RemoteException
sessionId isn't valid.
Only Products with a non zero status and non zero invisible are returned. The description (which can be very long) and the array of options are not set. The specialPrice is null if a special offer doesn't exist for the product.
storeId - the storeIdsessionId - The session id of the logged in userlanguageId - The id for the language that will be used. Value of -1 selects the default
language.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Product[] getProductNotificationsPerCustomerWithOptions(java.lang.String storeId,
java.lang.String sessionId,
int languageId,
com.konakart.rmi.app.S_FetchProductOptions options)
throws java.rmi.RemoteException
Returns all products sorted by name, that the customer has asked to be notified about. An
exception is thrown if the sessionId isn't valid.
Only Products with a non zero status and non zero invisible are returned. The description (which can be very long) and the array of options are not set. The specialPrice is null if a special offer doesn't exist for the product.
storeId - the storeIdsessionId - The session id of the logged in userlanguageId - The id for the language that will be used. Value of -1 selects the default
language.options - An object containing options for the method. It may be set to null.java.rmi.RemoteException - an unexpected KKException exceptionvoid addProductNotificationToCustomer(java.lang.String storeId,
java.lang.String sessionId,
int productId)
throws java.rmi.RemoteException
sessionId isn't valid.storeId - the storeIdsessionId - The session id of the logged in userproductId - The numeric id of the productjava.rmi.RemoteException - an unexpected KKException exceptionvoid deleteProductNotificationFromCustomer(java.lang.String storeId,
java.lang.String sessionId,
int productId)
throws java.rmi.RemoteException
sessionId isn't valid.storeId - the storeIdsessionId - The session id of the logged in userproductId - The numeric id of the productjava.rmi.RemoteException - an unexpected KKException exceptionvoid updateProductViewedCount(java.lang.String storeId,
int productId,
int languageId)
throws java.rmi.RemoteException
productId, has
been viewed. The languageId is required because a separate count is kept for how
many times the product has been viewed in each supported language.storeId - the storeIdproductId - The numeric id of the productlanguageId - The id for the language that will be used. Value of -1 selects the default
language.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Product[] getBestSellers(java.lang.String storeId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
int categoryId,
int languageId)
throws java.rmi.RemoteException
categoryId and its children. The products are returned in the language
referenced by languageId. If the categoryId is equal to 0, then it
is not used as a constraint for the query.
dataDesc defines the ordering of the products and the number of products
returned.
storeId - the storeIddataDesc - Used to control the data offset, limit the number of items returned and set the
sort ordercategoryId - The numeric id of the categorylanguageId - The id for the language that will be used. Value of -1 selects the default
language.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Product[] getBestSellersWithOptions(java.lang.String storeId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
int categoryId,
int languageId,
com.konakart.rmi.app.S_FetchProductOptions options)
throws java.rmi.RemoteException
Returns an array of bestseller products for the category referenced by
categoryId and its children. The products are returned in the language
referenced by languageId. If the categoryId is equal to 0, then it
is not used as a constraint for the query.
dataDesc defines the ordering of the products and the number of products
returned.
storeId - the storeIddataDesc - Used to control the data offset, limit the number of items returned and set the
sort ordercategoryId - The numeric id of the categorylanguageId - The id for the language that will be used. Value of -1 selects the default
language.options - An object containing options for the method. It may be set to null.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Orders getOrdersPerCustomer(java.lang.String storeId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
java.lang.String sessionId,
int languageId)
throws java.rmi.RemoteException
sessionId. The
orders are always returned sorted by date (most recent orders first). dataDesc
is used to retrieve offset and limit information. If null, the offset defaults to 0 and a
default limit is used.storeId - the storeIddataDesc - Used to control the data offset, limit the number of items returned and set the
sort ordersessionId - The session id of the logged in userlanguageId - The id for the language that will be used. Value of -1 selects the default
language.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Orders getOrdersPerCustomerWithOptions(java.lang.String storeId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
java.lang.String sessionId,
int languageId,
com.konakart.rmi.app.S_FetchOrderOptions options)
throws java.rmi.RemoteException
sessionId. The
orders are always returned sorted by date (most recent orders first). dataDesc
is used to retrieve offset and limit information. If null, the offset defaults to 0 and a
default limit is used.
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.
storeId - the storeIddataDesc - Used to control the data offset, limit the number of items returned and set the
sort ordersessionId - The session id of the logged in userlanguageId - The id for the language that will be used. Value of -1 selects the default
language.options - Allows you to define whether the orders may be orders belonging to a customer
within the hierarchy of the customer referenced by the sessionId.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Orders searchForOrdersPerCustomer(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
com.konakart.rmi.app.S_OrderSearch orderSearch,
int languageId)
throws java.rmi.RemoteException
sessionId for the
given language. The OrderSearch class contains the search criteria although it may be null.
dataDesc may be null. In this case, the number of retrieved orders is limited to
a default number, the orders are ordered by the OrderId and the offset is set to zero.
However, by setting the attributes of dataDesc, the following functionality may
be controlled :
storeId - the storeIdsessionId - The session id of the logged in userdataDesc - Used to control the data offset, limit the number of items returned and set the
sort orderorderSearch - Contains information used to add search constraintslanguageId - The id for the language that will be used. Value of -1 selects the default
language.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Order getOrder(java.lang.String storeId,
java.lang.String sessionId,
int orderId,
int languageId)
throws java.rmi.RemoteException
sessionId.storeId - the storeIdsessionId - The session id of the logged in userorderId - The numeric id of the orderlanguageId - The id for the language that will be used. Value of -1 selects the default
language.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Order getOrderWithOptions(java.lang.String storeId,
java.lang.String sessionId,
int orderId,
int languageId,
com.konakart.rmi.app.S_FetchOrderOptions options)
throws java.rmi.RemoteException
sessionId. Options object allows you to define whether the order may be an order
belonging to a customer within the hierarchy of the customer referenced by the
sessionId.storeId - the storeIdsessionId - The session id of the logged in userorderId - The numeric id of the orderlanguageId - The id for the language that will be used. Value of -1 selects the default
language.options - Allows you specify whether the order may be an order belonging to a customer
within the hierarchy of the customer referenced by the sessionId. Also allows you
to specify whether the archiveOrders attribute should be populated.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Currency getCurrency(java.lang.String storeId,
java.lang.String currencyCode)
throws java.rmi.RemoteException
currencyCode.storeId - the storeIdcurrencyCode - The 3 letter currency code (i.e. USD, EUR ..)java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Order createOrder(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_Basket[] basketItemArray,
int languageId)
throws java.rmi.RemoteException
sessionId. The products added to the order are retrieved
from the basketItemArray. Each OrderProduct object attached to the Order has a populated
Product object. The returned object has not been saved in the DB and so an Order Id has not
yet been assigned.
Null is returned if the products and/or product options referenced by the array of basket items are no longer available.
storeId - the storeIdsessionId - The session id of the logged in userbasketItemArray - The array of basket items to add to the orderlanguageId - The id for the language that will be used. Value of -1 selects the default
language.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Order createOrderWithOptions(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_Basket[] basketItemArray,
com.konakart.rmi.app.S_CreateOrderOptions options,
int languageId)
throws java.rmi.RemoteException
options is set to null, this method is identical to
createOrder(). Otherwise the functionality differs depending on the combination
of options set.
An order object is returned with all addresses populated with the default address of the
customer referenced by sessionId. The products added to the order are retrieved
from the basketItemArray. The returned object has not been saved in the DB and so an Order Id
has not yet been assigned.
Null is returned if the products and/or product options referenced by the array of basket items are no longer available.
One available option is to automatically copy all of the basket custom fields to
the orderProduct custom fields which are generated from the basket items.
Another option allows you to leave the sessionId null and to use a default customer. This default customer needs to be setup using the Admin App and is used to create a temporary order even before the customer logs in or registers, so that he can view the order totals in the window that shows him the cart details. These order totals give an indication of the shipping cost and also show any discounts available. The Administrator can create a default customer that matches his typical customer. For example if a store normally ships overseas, then the default customer can be set up with an overseas address so that the shipping costs are calculated at overseas rates.
A further option is to use the shipping address retrieved from a wish list if the wish list id of any one of the basket items is set to a valid wish list. This is useful in the case of gift registries to ship the gifts directly to the owner of the registry.
The options object contains a number of attributes to control whether the
returned order includes an array of available payment modules and shipping quotes and if so
which one to use as the selected module or quote. The population of order total modules may
also be enabled. The Javadoc of CreateOrderOptionsIf provides more details.
storeId - the storeIdsessionId - The session id of the logged in userbasketItemArray - The array of basket items to add to the orderoptions - An object containing options for the method. It may be set to null.languageId - The id for the language that will be used. Value of -1 selects the default
language.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Product[] getOrderHistory(java.lang.String storeId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
java.lang.String sessionId,
int languageId)
throws java.rmi.RemoteException
sessionId. The
number of products returned and the return order is determined by the dataDesc
parameter. The default OrderBy is "ORDER_BY_NAME_ASCENDING".storeId - the storeIddataDesc - Used to control the data offset, limit the number of items returned and set the
sort ordersessionId - The session id of the logged in userlanguageId - The id for the language that will be used. Value of -1 selects the default
language.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Product[] getOrderHistoryWithOptions(java.lang.String storeId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
java.lang.String sessionId,
int languageId,
com.konakart.rmi.app.S_FetchProductOptions options)
throws java.rmi.RemoteException
Get a list of the products ordered by the customer referenced by sessionId. The
number of products returned and the return order is determined by the dataDesc
parameter. The default OrderBy is "ORDER_BY_NAME_ASCENDING".
storeId - the storeIddataDesc - Used to control the data offset, limit the number of items returned and set the
sort ordersessionId - The session id of the logged in userlanguageId - The id for the language that will be used. Value of -1 selects the default
language.options - An object containing options for the method. It may be set to null.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Product[] getAlsoPurchased(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
int productId,
int languageId)
throws java.rmi.RemoteException
productId. The return order of the products is by purchase date.
dataDesc determines the number of products returned.
sessionId may be set to null. If it is valid, then the customer information is
used to calculate the tax. Otherwise the store location is used.
storeId - the storeIdsessionId - The session id of the logged in userdataDesc - Used to control the data offset, limit the number of items returned and set the
sort orderproductId - The numeric id of the productlanguageId - The id for the language that will be used. Value of -1 selects the default
language.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Product[] getAlsoPurchasedWithOptions(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
int productId,
int languageId,
com.konakart.rmi.app.S_FetchProductOptions options)
throws java.rmi.RemoteException
Find products that were in the same order as orders containing the product referenced by
productId. The return order of the products is by purchase date.
dataDesc determines the number of products returned.
sessionId may be set to null. If it is valid, then the customer information is
used to calculate the tax. Otherwise the store location is used.
storeId - the storeIdsessionId - The session id of the logged in userdataDesc - Used to control the data offset, limit the number of items returned and set the
sort orderproductId - The numeric id of the productlanguageId - The id for the language that will be used. Value of -1 selects the default
language.options - An object containing options for the method. It may be set to null.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Products getRelatedProducts(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
int productId,
int relationType,
int languageId)
throws java.rmi.RemoteException
productId parameter.
The relationType defines the relation. Valid values for
relationType are:
When all relationships are returned by setting relationType to 0, the
prodRelationType attribute of the returned products is set, so that the
information about the type of relationship is not lost.
storeId - the storeIdsessionId - The session id of the logged in userdataDesc - Used to control the data offset, limit the number of items returned and set the
sort order. It may be null, in which case the number of retrieved products is
limited to a default number and the offset is set to zero.productId - The numeric id of the productrelationType - The numeric relation type defining up selling, cross selling etc.languageId - The id for the language that will be used. Value of -1 selects the default
language.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Products getRelatedProductsWithOptions(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
int productId,
int relationType,
int languageId,
com.konakart.rmi.app.S_FetchProductOptions options)
throws java.rmi.RemoteException
Find products related to the product defined by the productId parameter. The
relationType defines the relation. Valid values for relationType
are:
When all relationships are returned by setting relationType to 0, the
prodRelationType attribute of the returned products is set, so that the
information about the type of relationship is not lost.
storeId - the storeIdsessionId - The session id of the logged in userdataDesc - Used to control the data offset, limit the number of items returned and set the
sort order. It may be null, in which case the number of retrieved products is
limited to a default number and the offset is set to zero.productId - The numeric id of the productrelationType - The numeric relation type defining up selling, cross selling etc.languageId - The id for the language that will be used. Value of -1 selects the default
language.options - An object containing options for the method. It may be set to null. This object
contains an attribute called invertRelatedProductDirection which If
true, inverts the direction of the related product link. This is especially useful
for bundled products, so rather than discovering the products within a bundle, you
can determine which bundles a product belongs to by setting this attribute to
true.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Country getCountryPerName(java.lang.String storeId,
java.lang.String countryName)
throws java.rmi.RemoteException
countryName, or null if the country doesn't
exist in the DB. If there is more than one country with the same name, we return the first
one that we find.storeId - the storeIdcountryName - The name of the countryjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Country getCountry(java.lang.String storeId,
int countryId)
throws java.rmi.RemoteException
countryId, or null if the country doesn't
exist in the DB.storeId - the storeIdcountryId - The id of the country objectjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_ShippingQuote[] getShippingQuotes(java.lang.String storeId,
com.konakart.rmi.app.S_Order order,
int languageId)
throws java.rmi.RemoteException
storeId - the storeIdorder - The order objectlanguageId - The id for the language that will be used. Value of -1 selects the default
language.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_ShippingQuote getShippingQuote(java.lang.String storeId,
com.konakart.rmi.app.S_Order order,
java.lang.String moduleName,
int languageId)
throws java.rmi.RemoteException
moduleName is called to get a shipping quote for the
order passed in as a parameter. Null is returned if the shipping module isn't available.storeId - the storeIdorder - The order objectmoduleName - e.g. flat or item or table etc.languageId - The id for the language that will be used. Value of -1 selects the default
language.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Order changeDeliveryAddress(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_Order order,
com.konakart.rmi.app.S_Address deliveryAddress)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - The session id of the logged in userorder - The order objectdeliveryAddress - The address object containing the delivery addressjava.rmi.RemoteException - an unexpected KKException exceptionjava.math.BigDecimal getTaxRate(java.lang.String storeId,
int countryId,
int zoneId,
int taxClassId)
throws java.rmi.RemoteException
taxClassId delivered to a country (
countryId) and zone (zoneId). There may be multiple tax rates which
are added and / or compounded as appropriate.storeId - the storeIdcountryId - The numeric id of the countryzoneId - The numeric id of the zonetaxClassId - The numeric id of the taxClassjava.rmi.RemoteException - an unexpected KKException exceptionjava.math.BigDecimal getTax(java.lang.String storeId,
java.math.BigDecimal cost,
int countryId,
int zoneId,
int taxClassId)
throws java.rmi.RemoteException
taxClassId and cost,
delivered to a country (countryId) and zone (zoneId).storeId - the storeIdcost - The cost of the productcountryId - The numeric id of the countryzoneId - The numeric id of the zonetaxClassId - The numeric id of the taxClassjava.rmi.RemoteException - an unexpected KKException exceptionjava.math.BigDecimal addTax(java.lang.String storeId,
java.math.BigDecimal cost,
int countryId,
int zoneId,
int taxClassId)
throws java.rmi.RemoteException
taxClassId and cost, delivered to a country (countryId
) and zone (zoneId).storeId - the storeIdcost - The cost of the productcountryId - The numeric id of the countryzoneId - The numeric id of the zonetaxClassId - The numeric id of the taxClassjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Order getOrderTotals(java.lang.String storeId,
com.konakart.rmi.app.S_Order order,
int languageId)
throws java.rmi.RemoteException
storeId - the storeIdorder - The order objectlanguageId - The id for the language that will be used. Value of -1 selects the default
language.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_PaymentDetails[] getPaymentGateways(java.lang.String storeId,
com.konakart.rmi.app.S_Order order,
int languageId)
throws java.rmi.RemoteException
Based on the zone of the billing address, the module may decide that it cannot process payment for that zone and so not even return a PaymentDetails object.
storeId - the storeIdorder - The order objectlanguageId - The id for the language that will be used. Value of -1 selects the default
language.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_PaymentDetails getPaymentGateway(java.lang.String storeId,
com.konakart.rmi.app.S_Order order,
java.lang.String moduleName,
int languageId)
throws java.rmi.RemoteException
moduleName is called to get a PaymentDetails object
for the order passed in as a parameter. Null is returned if the PaymentDetails object isn't
available.
Based on the zone of the billing address, the module may decide that it cannot process payment for that zone and so in this case, null is returned.
storeId - the storeIdorder - The order objectmoduleName - This is the name of the payment module. The name must match the class name except
that the first letter doesn't have to be in Caps. e.g. CyberSourceSA,
CommideaVanguard, BarclaycardSmartPayApi etc. The moduleName can be
the module name on its own or it can be "moduleName~~moduleSubCode" if the module
has a subCode.languageId - The id for the language that will be used. Value of -1 selects the default
language.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_PaymentDetails getPaymentDetails(java.lang.String storeId,
java.lang.String sessionId,
java.lang.String moduleCode,
int orderId,
java.lang.String hostAndPort,
int languageId)
throws java.rmi.RemoteException
The module matching the moduleCode is called in order to get a fully populated
PaymentDetails object containing all of the required parameters etc. for the payment gateway.
storeId - the storeIdsessionId - The session id of the logged in usermoduleCode - This is the name of the payment module in lower case. Examples are cod, paypal,
usaepay, worldpay etc.orderId - The numeric id of the orderhostAndPort - The host and port in the format "host:port" for the KonaKart servlet engine.languageId - The id for the language that will be used. Value of -1 selects the default
language.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_PaymentDetails getPaymentDetailsPerOrder(java.lang.String storeId,
java.lang.String sessionId,
java.lang.String moduleCode,
com.konakart.rmi.app.S_Order order,
java.lang.String hostAndPort,
int languageId)
throws java.rmi.RemoteException
The module matching the moduleCode is called in order to get a fully populated
PaymentDetails object containing all of the required parameters etc. for the payment gateway.
storeId - the storeIdsessionId - The session id of the logged in usermoduleCode - This is the name of the payment module in lower case. Examples are cod, paypal,
usaepay, worldpay etc.order - The order objecthostAndPort - The host and port in the format "host:port" for the KonaKart servlet engine.languageId - The id for the language that will be used. Value of -1 selects the default
language.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_PaymentDetails getPaymentDetailsCustom(java.lang.String storeId,
java.lang.String sessionId,
java.lang.String moduleCode,
com.konakart.rmi.app.S_NameValue[] parameters)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - The session id of the logged in usermoduleCode - This is the name of the payment module in lower case. Examples are cod, paypal,
usaepay, worldpay etc.parameters - An array of parameters used by the payment module to determine what it needs to
return.java.rmi.RemoteException - an unexpected KKException exceptionint saveOrder(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_Order order,
int languageId)
throws java.rmi.RemoteException
To save an order we have to write into a few DB tables: orders, orders_products, orders_products_attributes, orders_total, orders_status_history. We do this in a single transaction.
storeId - the storeIdsessionId - The session id of the logged in userorder - The order objectlanguageId - The id for the language that will be used. Value of -1 selects the default
language.java.rmi.RemoteException - an unexpected KKException exceptionint saveOrderWithOptions(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_Order order,
int languageId,
com.konakart.rmi.app.S_SaveOrderOptions options)
throws java.rmi.RemoteException
To save an order we have to write into a few DB tables: orders, orders_products, orders_products_attributes, orders_total, orders_status_history. We do this in a single transaction.
The options object allows you to define the id of the order to be archived which is the id of an order that this order is replacing. Both orders will be given the same archiveId. Note that the state of the order to be archived is not changed automatically. You should call updateOrder() to place it in the OrderMgr.ARCHIVED_STATUS state.
storeId - the storeIdsessionId - The session id of the logged in userorder - The order objectlanguageId - The id for the language that will be used. Value of -1 selects the default
language.options - Options object allowing you to specify the id of the order to be archivedjava.rmi.RemoteException - an unexpected KKException exceptionjava.lang.String getStatusText(java.lang.String storeId,
int statusId,
int languageId)
throws java.rmi.RemoteException
storeId - the storeIdstatusId - The numeric id of the OrderStatus objectlanguageId - The id for the language that will be used. Value of -1 selects the default
language.java.rmi.RemoteException - an unexpected KKException exceptionvoid updateOrder(java.lang.String storeId,
java.lang.String sessionId,
int orderId,
int status,
boolean customerNotified,
java.lang.String comments,
com.konakart.rmi.app.S_OrderUpdate updateOrder)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - 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.rmi.RemoteException - an unexpected KKException exceptionvoid updateOrderWithPaymentModuleSubCode(java.lang.String storeId,
java.lang.String sessionId,
int orderId,
int status,
boolean customerNotified,
java.lang.String comments,
java.lang.String paymentModuleSubCode,
com.konakart.rmi.app.S_OrderUpdate updateOrder)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - 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.rmi.RemoteException - an unexpected KKException exception@Deprecated
void changeOrderStatus(java.lang.String storeId,
java.lang.String sessionId,
int orderId,
int status,
boolean customerNotified,
java.lang.String comments)
throws java.rmi.RemoteException
updateOrder(java.lang.String, java.lang.String, int, int, boolean, java.lang.String, com.konakart.rmi.app.S_OrderUpdate) instead.storeId - the storeIdsessionId - 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 recordjava.rmi.RemoteException - an unexpected KKException exceptionvoid updateInventory(java.lang.String storeId,
java.lang.String sessionId,
int orderId)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - The session id of the logged in userorderId - The numeric id of the orderjava.rmi.RemoteException - an unexpected KKException exceptionvoid updateInventoryWithOptions(java.lang.String storeId,
java.lang.String sessionId,
int orderId,
com.konakart.rmi.app.S_CreateOrderOptions options)
throws java.rmi.RemoteException
options is set to null, this method is identical to
updateInventory(). Otherwise the functionality differs depending on the
combination of options set.
If the STOCK_LIMITED configuration variable is set to true, we subtract the products in stock by the product orders. If we hit the STOCK_REORDER_LEVEL, then we instantiate a class defined by the STOCK_REORDER_CLASS and call it. If STOCK_ALLOW_CHECKOUT is set to true, when we hit zero items in stock we don't touch the status, otherwise we disable the product when the quantity reaches zero by setting the status to zero.
storeId - the storeIdsessionId - The session id of the logged in userorderId - The numeric id of the orderoptions - An object containing options for the method. It may be set to null.java.rmi.RemoteException - an unexpected KKException exception@Deprecated
void sendNewPassword(java.lang.String storeId,
java.lang.String emailAddr,
java.lang.String subject,
java.lang.String countryCode)
throws java.rmi.RemoteException
storeId - the storeIdemailAddr - Address of the emailsubject - The email subject line. If null it is retrieved from the first line of the
template.countryCode - Two letter code used to pick correct templatejava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Email sendNewPassword1(java.lang.String storeId,
java.lang.String emailAddr,
com.konakart.rmi.app.S_EmailOptions options)
throws java.rmi.RemoteException
Valid options are:
templateName: The name of the template used to send the mail without the
country code and the .vm extension. e.g. If the name of the template is myTemplate and the
two letter country code is en, then KonaKart will search for a template called
myTemplate_en.vm .countryCode: The two letter (lower case) country code used to search for the
template. e.g. en, de, es etc.customAttrs: An array of name value pairs used to pass custom information to
the Velocity engine. The value can be retrieved from the template using the name preceded by
the $ sign. e.g. If a name value pair contains StoreId and 22, the value 22 will be displayed
in the eMail where the template contains $StoreId.fullAttachmentFilename: The complete filename of an attachment.friendlyAttachmentName: The friendly filename of an attachment that can be
viewed from the eMail.deleteAttachmentAfterSend: When set to true, the attachment is
deleted after being sent. The default value is false.The Velocity context contains the following data:
emailAddr: The email address of the recipientnewPassword: The new passwordcustomerName: The name of the customer in the format firstName lastNamecustomer: The CustomerIf objectstoreOwner: The name of the store owner.storeName: The name of the store.storeOwnerEmailAddr: The email address of the store owner.dateTool: org.apache.velocity.tools.generic.DateTool object used to format
dates.escTool: org.apache.velocity.tools.generic.EscapeTool object used to escape
characters.listTool: org.apache.velocity.tools.generic.ListTool object used to format
lists.mathTool: org.apache.velocity.tools.generic.MathTool object used to do sums.
locale: java.util.Locale objectcurrencyMgr: Used to format pricesstoreId - the storeIdemailAddr - Address of the emailoptions - Options for the emailjava.rmi.RemoteException - an unexpected KKException exception@Deprecated
void sendWelcomeEmail(java.lang.String storeId,
int customerId,
java.lang.String mailSubject,
java.lang.String countryCode)
throws java.rmi.RemoteException
storeId - the storeIdcustomerId - The numeric id of the customermailSubject - The email subject line. If null it is retrieved from the first line of the
template.countryCode - The two letter country code used to select the velocity template that creates the
mailjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Email sendWelcomeEmail1(java.lang.String storeId,
int customerId,
com.konakart.rmi.app.S_EmailOptions options)
throws java.rmi.RemoteException
Valid options are:
templateName: The name of the template used to send the mail without the
country code and the .vm extension. e.g. If the name of the template is myTemplate and the
two letter country code is en, then KonaKart will search for a template called
myTemplate_en.vm .countryCode: The two letter (lower case) country code used to search for the
template. e.g. en, de, es etc.customAttrs: An array of name value pairs used to pass custom information to
the Velocity engine. The value can be retrieved from the template using the name preceded by
the $ sign. e.g. If a name value pair contains StoreId and 22, the value 22 will be displayed
in the eMail where the template contains $StoreId.fullAttachmentFilename: The complete filename of an attachment.friendlyAttachmentName: The friendly filename of an attachment that can be
viewed from the eMail.deleteAttachmentAfterSend: When set to true, the attachment is
deleted after being sent. The default value is false.The Velocity context contains the following data:
customerName: The name of the customer in the format firstName lastNamecustomer: The CustomerIf objectstoreOwner: The name of the store owner.storeName: The name of the store.storeOwnerEmailAddr: The email address of the store owner.dateTool: org.apache.velocity.tools.generic.DateTool object used to format
dates.locale: java.util.Locale objectcurrencyMgr: Used to format pricesstoreId - the storeIdcustomerId - The numeric id of the customeroptions - Options for the emailjava.rmi.RemoteException - an unexpected KKException exception@Deprecated
void sendOrderConfirmationEmail(java.lang.String storeId,
java.lang.String sessionId,
int orderId,
java.lang.String mailSubject,
int languageId)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - The session id of the logged in userorderId - The numeric id of the ordermailSubject - The subject of the emaillanguageId - The id for the language that will be used. Value of -1 selects the default
language.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Email sendOrderConfirmationEmail1(java.lang.String storeId,
java.lang.String sessionId,
int orderId,
int langIdForOrder,
com.konakart.rmi.app.S_EmailOptions options)
throws java.rmi.RemoteException
Valid options are:
templateName: The name of the template used to send the mail without the
country code and the .vm extension. e.g. If the name of the template is myTemplate and the
two letter country code is en, then KonaKart will search for a template called
myTemplate_en.vm .countryCode: The two letter (lower case) country code used to search for the
template. e.g. en, de, es etc.customAttrs: An array of name value pairs used to pass custom information to
the Velocity engine. The value can be retrieved from the template using the name preceded by
the $ sign. e.g. If a name value pair contains StoreId and 22, the value 22 will be displayed
in the eMail where the template contains $StoreId.The Velocity context contains the following data:
order: The OrderIf objectcustomerName: The name of the customer in the format firstName lastNamecustomer: The CustomerIf objectstoreOwner: The name of the store owner.storeName: The name of the store.storeOwnerEmailAddr: The email address of the store owner.dateTool: org.apache.velocity.tools.generic.DateTool object used to format
dates.locale: java.util.Locale objectcurrencyMgr: Used to format pricesstoreId - the storeIdsessionId - The session id of the logged in userorderId - The numeric id of the orderlangIdForOrder - The languageId used for retrieving the order, to translate things such as order
status. Value of -1 selects the default language.options - Options for the emailjava.rmi.RemoteException - an unexpected KKException exceptionjava.lang.String getSecretKeyForOrderId(java.lang.String storeId,
int orderId)
throws java.rmi.RemoteException
storeId - the storeIdorderId - the orderIdjava.rmi.RemoteException - an unexpected KKException exceptionint getOrderIdFromSecretKey(java.lang.String storeId,
java.lang.String secretKey)
throws java.rmi.RemoteException
storeId - the storeIdsecretKey - A string representing the secret keyjava.rmi.RemoteException - an unexpected KKException exceptionvoid deleteOrderIdForSecretKey(java.lang.String storeId,
java.lang.String secretKey)
throws java.rmi.RemoteException
storeId - the storeIdsecretKey - A string representing the secret keyjava.rmi.RemoteException - an unexpected KKException exceptionint saveIpnHistory(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_IpnHistory ipnHistory)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - The session id of the logged in useripnHistory - The IpnHistory object to savejava.rmi.RemoteException - an unexpected KKException exceptionvoid updateManufacturerViewedCount(java.lang.String storeId,
int manufacturerId,
int languageId)
throws java.rmi.RemoteException
manufacturerId, has been clicked on, to view the home page. The
languageId is required because a separate count is kept for how many times the
manufacturer home page has been viewed in each supported language.storeId - the storeIdmanufacturerId - The numeric id of the manufacturerlanguageId - The id for the language that will be used. Value of -1 selects the default
language.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Zone[] getZonesPerCountry(java.lang.String storeId,
int countryId)
throws java.rmi.RemoteException
countryId.storeId - the storeIdcountryId - The numeric id of the countryjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Zone[] searchForZones(java.lang.String storeId,
com.konakart.rmi.app.S_ZoneSearch search)
throws java.rmi.RemoteException
storeId - the storeIdsearch - the searchjava.rmi.RemoteException - an unexpected KKException exceptionvoid updateCachedConfigurations(java.lang.String storeId)
throws java.rmi.RemoteException
storeId - the storeIdjava.rmi.RemoteException - an unexpected KKException exceptionboolean doesCustomerExistForEmail(java.lang.String storeId,
java.lang.String emailAddr)
throws java.rmi.RemoteException
storeId - the storeIdemailAddr - The username in the format of an email addressjava.rmi.RemoteException - an unexpected KKException exceptionboolean isEmailValid(java.lang.String storeId,
java.lang.String emailAddr)
throws java.rmi.RemoteException
storeId - the storeIdemailAddr - A string representing an email addressjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Basket[] updateBasketWithStockInfo(java.lang.String storeId,
com.konakart.rmi.app.S_Basket[] basketItems)
throws java.rmi.RemoteException
If the product or any of the product attributes of a basket item no longer exist, then that basket item is not returned. This means that the size of the returned array may be smaller than the size of the array passed in as a parameter.
storeId - the storeIdbasketItems - An array of basket itemsjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Basket[] updateBasketWithStockInfoWithOptions(java.lang.String storeId,
com.konakart.rmi.app.S_Basket[] basketItems,
com.konakart.rmi.app.S_AddToBasketOptions options)
throws java.rmi.RemoteException
If the product or any of the product attributes of a basket item no longer exist, then that basket item is not returned. This means that the size of the returned array may be smaller than the size of the array passed in as a parameter.
If in the options object, getStockReservationInfo is set to true, then stock
reservation information is returned. As well as the quantityInStock and
dateAvailable attributes, the following attributes are also populated:
quantityReserved - The total number of reserved similar items in the system.
qtyResrvdForResId - The number of reserved items for this basket reservation
id. This is not always equal to the quantity of the basket item.qtyResrvdForResId will be set
to 0 and reservationId will be set to -1 and these changes will be reflected in
the database. Also in this case the stock reservation record is deleted from the database.
If options is set to null, this method is identical to updateBasketWithStockInfo(). Otherwise the functionality differs depending on the combination of options set.
storeId - the storeIdbasketItems - An array of basket itemsoptions - An object containing options for the method. It may be set to null.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_ProductQuantity getProductQuantity(java.lang.String storeId,
java.lang.String encodedProductId)
throws java.rmi.RemoteException
If there are no option / value pairs then we use the stock level from the product object. If there is at least one option / value pair, we attempt to find the quantity in the product quantity table. If we can't find it in the product_quantity table we look for at least one record in the product_quantity table for this product id. If we find something then we assume that the quantity is zero. If we find no records, we use the quantity from the product object.
storeId - the storeIdencodedProductId - The encoded product id which can reference a particular configuration of a
product. i.e. A green shirt rather than a blue shirt.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_ProductQuantity getProductQuantityWithOptions(java.lang.String storeId,
java.lang.String encodedProductId,
com.konakart.rmi.app.S_FetchProductOptions options)
throws java.rmi.RemoteException
If there are no option / value pairs then we use the stock level from the product object. If there is at least one option / value pair, we attempt to find the quantity in the product quantity table. If we can't find it in the product_quantity table we look for at least one record in the product_quantity table for this product id. If we find something then we assume that the quantity is zero. If we find no records, we use the quantity from the product object.
The options object is used to set whether the quantity and available date should be fetched from an external table based on the catalogId.
storeId - the storeIdencodedProductId - The encoded product id which can reference a particular configuration of a
product. i.e. A green shirt rather than a blue shirt.options - An object containing options for the method. It may be set to null.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Order createAndSaveOrder(java.lang.String storeId,
java.lang.String emailAddr,
java.lang.String password,
com.konakart.rmi.app.S_CustomerRegistration custReg,
com.konakart.rmi.app.S_Basket[] basketItemArray,
java.lang.String shippingModule,
java.lang.String paymentModule,
int languageId)
throws java.rmi.RemoteException
The caller supplies the username (email address) and password of the KonaKart user. If the user has not yet been registered, then the caller must also supply a populated CustomerRegistration object, otherwise this can be set to null. The registration is done automatically if the email address doesn't exist in the KonaKart database.
The shipping and payment module names must be names of modules that have been installed in the KonaKart engine.
storeId - the storeIdemailAddr - The username of the customer creating the orderpassword - The password of the customer creating the ordercustReg - Object that contains all necessary details to register a new customer. Can be set
to null if user has already been registered.basketItemArray - Array of basket items to add to the ordershippingModule - Shipping module to use (null if no shipping required). This parameter must contain
the name of the module (i.e. flat or item or table..)paymentModule - Payment module to use. This parameter must contain the name of the module (i.e.
chronopay or cod or worldpay..)languageId - The id for the language that will be used. Value of -1 selects the default
language.java.rmi.RemoteException - an unexpected KKException exception@Deprecated
java.lang.String getSku(java.lang.String storeId,
com.konakart.rmi.app.S_OrderProduct orderProd)
throws java.rmi.RemoteException
storeId - the storeIdorderProd - The OrderProduct object. An order normally contains an array of order product
objects.java.rmi.RemoteException - an unexpected KKException exceptionvoid setEndpoint(java.lang.String storeId,
java.lang.String wsEndpoint)
throws java.rmi.RemoteException
The effect will be to set the web service endpoint for the proxy to the KonaKart engine.
storeId - the storeIdwsEndpoint - A String representing the web service endpointjava.rmi.RemoteException - an unexpected KKException exceptionint insertDigitalDownload(java.lang.String storeId,
java.lang.String sessionId,
int productId)
throws java.rmi.RemoteException
productId and the customer identified by the sessionId. If the
digital download already exists, then we overwrite it with the new one.
The attributes of the digital download product such as the maximum number of days that it is valid and how many times it can be downloaded, are retrieved from configuration variables or from the product directly.
storeId - the storeIdsessionId - The session id of the logged in userproductId - The numeric id of the productjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_DigitalDownload[] getDigitalDownloads(java.lang.String storeId,
java.lang.String sessionId)
throws java.rmi.RemoteException
sessionId parameter. The product attribute of the Digital Download objects is
not populated.
If the DD_DELETE_ON_EXPIRATION configuration variable is set to "true", then the objects read from the database that have expired, are automatically deleted. This avoids having to maintain the database table. Regardless of the setting of DD_DELETE_ON_EXPIRATION, only valid (not expired) objects are ever returned.
storeId - the storeIdsessionId - The session id of the logged in userjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_DigitalDownload[] getDigitalDownloadsWithOptions(java.lang.String storeId,
java.lang.String sessionId,
int languageId,
com.konakart.rmi.app.S_FetchDigitalDownloadOptions ddOptions,
com.konakart.rmi.app.S_FetchProductOptions prodOptions)
throws java.rmi.RemoteException
sessionId parameter. The ddOptions parameter allows you to define
whether the product attribute of the returned Digital Download objects is populated.
If the DD_DELETE_ON_EXPIRATION configuration variable is set to "true", then the objects read from the database that have expired, are automatically deleted. This avoids having to maintain the database table. Regardless of the setting of DD_DELETE_ON_EXPIRATION, only valid (not expired) objects are ever returned.
storeId - the storeIdsessionId - The session id of the logged in userlanguageId - The id for the language that will be used for the digital download products. Value
of -1 selects the default language.ddOptions - Options object that allows you to define whether the product attribute of the
returned Digital Download objects is populated. It may be set to null.prodOptions - An object containing options for the digital download products. It may be set to
null.java.rmi.RemoteException - an unexpected KKException exceptionint updateDigitalDownloadCount(java.lang.String storeId,
java.lang.String sessionId,
int productId)
throws java.rmi.RemoteException
productId and the
customer identified by the sessionId. The count defines how many times it has
been downloaded.storeId - the storeIdsessionId - The session id of the logged in userproductId - The numeric id of the productjava.rmi.RemoteException - an unexpected KKException exceptionint updateDigitalDownloadCountById(java.lang.String storeId,
java.lang.String sessionId,
int digitalDownloadId)
throws java.rmi.RemoteException
digitalDownloadId
and the customer identified by the sessionId. The count defines how many times
it has been downloaded. This is used when there may be many digital downloads for the same
product pointing to different files. i.e. TicketsstoreId - the storeIdsessionId - The session id of the logged in userdigitalDownloadId - The numeric id of the digital download objectjava.rmi.RemoteException - an unexpected KKException exceptionint getTempCustomerId(java.lang.String storeId)
throws java.rmi.RemoteException
storeId - the storeIdjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_CustomerGroup[] getAllCustomerGroups(java.lang.String storeId,
int languageId)
throws java.rmi.RemoteException
storeId - the storeIdlanguageId - The id for the language that will be used to determine the customer group name and
description. Value of -1 selects the default language.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_CustomerGroup getCustomerGroup(java.lang.String storeId,
int customerGroupId,
int languageId)
throws java.rmi.RemoteException
storeId - the storeIdcustomerGroupId - the customerGroupIdlanguageId - The id for the language that will be used to determine the customer group name and
description. Value of -1 selects the default language.java.rmi.RemoteException - an unexpected KKException exception@Deprecated
void sendTemplateEmailToCustomer(java.lang.String storeId,
int customerId,
java.lang.String templateName,
java.lang.String message,
java.lang.String countryCode)
throws java.rmi.RemoteException
We ship an example template called GenericCustEmail_en.vm . Note that the first line of the template is used to generate the subject of the eMail.
storeId - the storeIdcustomerId - The numeric id of the customertemplateName - The name of the template, not including "_countryCode.vm". If the template file
name is CustomEmail_en.vm, the parameter must be set to CustomEmail.message - The information within the message may be used by the template.countryCode - The two letter country code used to select the velocity template that creates the
mail.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Email sendTemplateEmailToCustomer1(java.lang.String storeId,
int customerId,
java.lang.String message,
com.konakart.rmi.app.S_EmailOptions options)
throws java.rmi.RemoteException
emailAddr is set on the options object, the email is sent to the emailAddr
address . Note that in this case the Velocity context will not contain the customer details
since these aren't available.
Valid options are:
templateName: The name of the template used to send the mail without the
country code and the .vm extension. e.g. If the name of the template is myTemplate and the
two letter country code is en, then KonaKart will search for a template called
myTemplate_en.vm .countryCode: The two letter (lower case) country code used to search for the
template. e.g. en, de, es etc.customAttrs: An array of name value pairs used to pass custom information to
the Velocity engine. The value can be retrieved from the template using the name preceded by
the $ sign. e.g. If a name value pair contains StoreId and 22, the value 22 will be displayed
in the eMail where the template contains $StoreId.fullAttachmentFilename: The complete filename of an attachment.friendlyAttachmentName: The friendly filename of an attachment that can be
viewed from the eMail.deleteAttachmentAfterSend: When set to true, the attachment is
deleted after being sent. The default value is false.emailAddr: When the customerId doesn't reference a registered customer and
emailAddr is set, then the email is sent to the emailAddr address . Note that in this case
the Velocity context will not contain the customer details since these aren't available.The Velocity context contains the following data:
customerName: The name of the customer in the format firstName lastNamecustomer: The CustomerIf objectemailAddr: The email address of the customer where the mail has been
sentmessage: The message that may be used by the templatestoreOwner: The name of the store owner.storeName: The name of the store.storeOwnerEmailAddr: The email address of the store owner.dateTool: org.apache.velocity.tools.generic.DateTool object used to format
dates.locale: java.util.Locale objectcurrencyMgr: Used to format pricesstoreId - the storeIdcustomerId - The numeric id of the customermessage - The information within the message may be used by the template.options - Options for the emailjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Email notifySysAdmin(java.lang.String storeId,
java.lang.String message,
com.konakart.rmi.app.S_EmailOptions options)
throws java.rmi.RemoteException
Valid options are:
templateName: The name of the template used to send the mail without the
country code and the .vm extension. e.g. If the name of the template is myTemplate and the
two letter country code is en, then KonaKart will search for a template called
myTemplate_en.vm .countryCode: The two letter (lower case) country code used to search for the
template. e.g. en, de, es etc.customAttrs: An array of name value pairs used to pass custom information to
the Velocity engine. The value can be retrieved from the template using the name preceded by
the $ sign. e.g. If a name value pair contains StoreId and 22, the value 22 will be displayed
in the eMail where the template contains $StoreId.fullAttachmentFilename: The complete filename of an attachment.friendlyAttachmentName: The friendly filename of an attachment that can be
viewed from the eMail.deleteAttachmentAfterSend: When set to true, the attachment is
deleted after being sent. The default value is false.The Velocity context contains the following data:
customerName: The name of the customer in the format firstName lastNamecustomer: The CustomerIf objectmessage: The message that may be used by the templatestoreOwner: The name of the store owner.storeName: The name of the store.storeOwnerEmailAddr: The email address of the store owner.dateTool: org.apache.velocity.tools.generic.DateTool object used to format
dates.locale: java.util.Locale objectcurrencyMgr: Used to format pricesstoreId - the storeIdmessage - The information within the message may be used by the template. Typically this
might be an exception message.options - Options for the emailjava.rmi.RemoteException - an unexpected KKException exceptionjava.lang.String loginByAdmin(java.lang.String storeId,
java.lang.String adminSession,
int customerId)
throws java.rmi.RemoteException
The adminSession must contain the session of a logged in Administrator User. The customerId must contain the Id of the customer to login as.
storeId - the storeIdadminSession - The session of a logged in administrator usercustomerId - The id of the customer to login asjava.rmi.RemoteException - an unexpected KKException exceptionjava.lang.String custom(java.lang.String storeId,
java.lang.String input1,
java.lang.String input2)
throws java.rmi.RemoteException
There are two versions, one that requires a valid sessionId (customSecure) and one that does not (custom).
You are free to use the two input String parameters in any way you choose, for example you may wish to use one to indicate which of your custom functions to run, and the other might contain XML to give you a great deal of flexibility - but it's up to you!
storeId - the storeIdinput1 - The first input String - can be anything you chooseinput2 - The second input String - can be anything you choosejava.rmi.RemoteException - an unexpected KKException exceptionjava.lang.String customSecure(java.lang.String storeId,
java.lang.String sessionId,
java.lang.String input1,
java.lang.String input2)
throws java.rmi.RemoteException
There are two versions, one that requires a valid sessionId (customSecure) and one that does not (custom).
You are free to use the two input String parameters in any way you choose, for example you may wish to use one to indicate which of your custom functions to run, and the other might contain XML to give you a great deal of flexibility - but it's up to you!
storeId - the storeIdsessionId - The session id of the logged in userinput1 - The first input String - can be anything you chooseinput2 - The second input String - can be anything you choosejava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_TagGroup[] getTagGroupsPerCategory(java.lang.String storeId,
int categoryId,
boolean getProdCount,
int languageId)
throws java.rmi.RemoteException
storeId - the storeIdcategoryId - The numeric id of the category. If set to -1 then all TagGroups are returned.getProdCount - If true, the Tag objects are populated with the number of products present for the
taglanguageId - The id for the language that will be used to determine the tag group name and
description. Value of -1 selects the default language.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_TagGroup[] getTagGroupsPerCategoryWithOptions(java.lang.String storeId,
int categoryId,
int languageId,
com.konakart.rmi.app.S_FetchTagGroupOptions options)
throws java.rmi.RemoteException
storeId - the storeIdcategoryId - The numeric id of the category. If set to -1 then all TagGroups are returned.languageId - The id for the language that will be used to determine the tag group name and
description. Value of -1 selects the default language.options - An object containing options for the method.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Tag[] getTagsPerCategory(java.lang.String storeId,
int categoryId,
boolean getProdCount,
int languageId)
throws java.rmi.RemoteException
storeId - the storeIdcategoryId - The numeric id of the category. If set to -1 then all tags are returned.getProdCount - If true, the Tag objects are populated with the number of productslanguageId - The id for the language that will be used to determine the tag name. Value of -1
selects the default language.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_TagGroup getTagGroup(java.lang.String storeId,
int tagGroupId,
boolean getProdCount,
int languageId)
throws java.rmi.RemoteException
storeId - the storeIdtagGroupId - The numeric Id of the tag groupgetProdCount - If true, the Tag objects are populated with the number of productslanguageId - The id for the language that will be used to determine the tag group name and
description. Value of -1 selects the default language.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Tag getTag(java.lang.String storeId,
int tagId,
boolean getProdCount,
int languageId)
throws java.rmi.RemoteException
storeId - the storeIdtagId - The numeric Id of the taggetProdCount - If true, the Tag object is populated with the number of productslanguageId - The id for the language that will be used to determine the tag name. Value of -1
selects the default language.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Customer getDefaultCustomer(java.lang.String storeId)
throws java.rmi.RemoteException
The default customer can be configured in the Admin App. It is a fictitious customer with a real address that is used to create a temporary order even when a customer is not logged in or hasn't registered yet. The order totals of this temporary order are displayed in the cart details screen to give an indication of shipping costs and to display any available discounts.
storeId - the storeIdjava.rmi.RemoteException - an unexpected KKException exceptionjava.lang.String[] getStoreIds(java.lang.String storeId)
throws java.rmi.RemoteException
storeId - the storeIdjava.rmi.RemoteException - an unexpected KKException exceptionvoid setCreditCardDetailsOnOrder(java.lang.String storeId,
java.lang.String sessionId,
int orderId,
com.konakart.rmi.app.S_CreditCard card)
throws java.rmi.RemoteException
No update or insert is done for attributes of the CreditCard object that are set to null. The credit card details are mapped as follows to attributes in the order object:
storeId - the storeIdsessionId - The session id of the logged in userorderId - The numeric id of the ordercard - CreditCard object containing the credit card detailsjava.rmi.RemoteException - an unexpected KKException exceptionint addToWishList(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_WishListItem wishListItem)
throws java.rmi.RemoteException
The compulsory attributes for the WishListItem are:
The WishListItem may also contain an array of options if these are applicable for the chosen product.
storeId - the storeIdsessionId - The session id of the logged in userwishListItem - The wish list item to be added to the wish listjava.rmi.RemoteException - an unexpected KKException exceptionint addToWishListWithOptions(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_WishListItem wishListItem,
com.konakart.rmi.app.S_AddToWishListOptions options)
throws java.rmi.RemoteException
options is set to null, this method is identical to
addToWishList(). Otherwise the functionality differs depending on the
combination of options set.
Add a WishListItem object to the wish list referenced by wishListId. The sessionId may be left null if a temporary customer id (negative number) is added to the options object. If the wish list doesn't belong to the logged in customer or the customer referenced by the customer id, an exception is thrown. If the WishListItem already exists, then it is updated.
The compulsory attributes for the WishListItem are:
The WishListItem may also contain an array of options if these are applicable for the chosen product.
storeId - the storeIdsessionId - The session id of the logged in userwishListItem - The wish list item to be added to the wish listoptions - An object containing options for the method. It may be set to null.java.rmi.RemoteException - an unexpected KKException exceptionint createWishList(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_WishList wishList)
throws java.rmi.RemoteException
addToWishList() can be called to add wish list items to the wish list. The
customer must be logged in with a valid sessionId when this method is called.
The compulsory attributes for the WishListItem are:
storeId - the storeIdsessionId - The session id of the logged in userwishList - The wish list to be createdjava.rmi.RemoteException - an unexpected KKException exceptionint createWishListWithOptions(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_WishList wishList,
com.konakart.rmi.app.S_AddToWishListOptions options)
throws java.rmi.RemoteException
addToWishList() can be called to add wish list items to the wish list. This
method may be called even when a customer isn't logged in. In this case the
customerId attribute of the options object must be set to the id of the
temporary customer which is negative.
The compulsory attributes for the WishListItem are:
storeId - the storeIdsessionId - The session id of the logged in userwishList - The wish list to be createdoptions - An object containing options for the method. It may be set to null.java.rmi.RemoteException - an unexpected KKException exceptionvoid editWishList(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_WishList wishList)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - The session id of the logged in userwishList - The wish list to be editedjava.rmi.RemoteException - an unexpected KKException exceptionvoid editWishListWithOptions(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_WishList wishList,
com.konakart.rmi.app.S_AddToWishListOptions options)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - The session id of the logged in userwishList - The wish list to be editedoptions - An object containing options for the method. It may be set to null.java.rmi.RemoteException - an unexpected KKException exceptionvoid deleteWishList(java.lang.String storeId,
java.lang.String sessionId,
int wishListId)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - The session id of the logged in userwishListId - The numeric id of the wish listjava.rmi.RemoteException - an unexpected KKException exceptionvoid deleteWishListWithOptions(java.lang.String storeId,
java.lang.String sessionId,
int wishListId,
com.konakart.rmi.app.S_AddToWishListOptions options)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - The session id of the logged in userwishListId - The numeric id of the wish listoptions - An object containing options for the method. It may be set to null.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_WishList getWishListWithItems(java.lang.String storeId,
java.lang.String sessionId,
int wishListId,
int languageId)
throws java.rmi.RemoteException
Each WishListItem object will have a populated product attribute and populated
opts attribute if the WishListItem contains options. The items will be ordered
by priority with the highest priority first.
storeId - the storeIdsessionId - The session id of the logged in user. It may be null if the user isn't logged in.wishListId - The numeric id of the wish listlanguageId - The id for the language that will be used. Value of -1 selects the default
language.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_WishList getWishListWithItemsWithOptions(java.lang.String storeId,
java.lang.String sessionId,
int wishListId,
int languageId,
com.konakart.rmi.app.S_AddToWishListOptions options)
throws java.rmi.RemoteException
options is set to null, this method is identical to
getWishListWithItems(). Otherwise the functionality differs depending on the
combination of options set. The sessionId may be left null if a temporary customer id
(negative number) is added to the options object. An exception will be thrown if the wish
list doesn't belong to the logged in customer or customer referenced by customer id, and is
private.
Returns a fully populated WishList object that may contain an array of WishListItem objects. An exception will be thrown if the wish list doesn't belong to the logged in customer and is private.
Each WishListItem object will have a populated product attribute and populated
opts attribute if the WishListItem contains options. The items will be ordered
by priority with the highest priority first.
storeId - the storeIdsessionId - The session id of the logged in user. It may be null if the user isn't logged in.wishListId - The numeric id of the wish listlanguageId - The id for the language that will be used. Value of -1 selects the default
language.options - An object containing options for the method. It may be set to null.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_WishList getWishList(java.lang.String storeId,
java.lang.String sessionId,
int wishListId)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - The session id of the logged in user. It may be null if the user isn't logged in.wishListId - The numeric id of the wish listjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_WishList getWishListWithOptions(java.lang.String storeId,
java.lang.String sessionId,
int wishListId,
com.konakart.rmi.app.S_AddToWishListOptions options)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - The session id of the logged in user. It may be null if the user isn't logged in.wishListId - The numeric id of the wish listoptions - An object containing options for the method. It may be set to null.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_WishListItems getWishListItemsWithOptions(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
int wishListId,
int languageId,
com.konakart.rmi.app.S_AddToWishListOptions options)
throws java.rmi.RemoteException
However, by setting the attributes of dataDesc, the following functionality may
be controlled :
If the onlyShowAvailable attribute of the options object is set, then the wish
list items that have quantity received equal to quantity desired, are not returned.
storeId - the storeIdsessionId - The session id of the logged in user. It may be null if the user isn't logged in.dataDesc - Used to control the data offset, limit the number of items returned and set the
sort orderwishListId - The numeric id of the WishList object that the wish list items belong tolanguageId - The numeric id of the language objectoptions - An object containing options for the method. It may be set to null.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_WishListItems getWishListItems(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
int wishListId,
int languageId)
throws java.rmi.RemoteException
However, by setting the attributes of dataDesc, the following functionality may
be controlled :
storeId - the storeIdsessionId - The session id of the logged in user. It may be null if the user isn't logged in.dataDesc - Used to control the data offset, limit the number of items returned and set the
sort orderwishListId - The numeric id of the WishList object that the wish list items belong tolanguageId - The numeric id of the language objectjava.rmi.RemoteException - an unexpected KKException exceptionvoid removeFromWishList(java.lang.String storeId,
java.lang.String sessionId,
int wishListItemId)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - The session id of the logged in userwishListItemId - The numeric id of the wish list itemjava.rmi.RemoteException - an unexpected KKException exceptionvoid removeFromWishListWithOptions(java.lang.String storeId,
java.lang.String sessionId,
int wishListItemId,
com.konakart.rmi.app.S_AddToWishListOptions options)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - The session id of the logged in userwishListItemId - The numeric id of the wish list itemoptions - An object containing options for the method. It may be set to null.java.rmi.RemoteException - an unexpected KKException exceptionvoid mergeWishListsWithOptions(java.lang.String storeId,
java.lang.String sessionId,
int customerFromId,
int languageId,
com.konakart.rmi.app.S_AddToWishListOptions options)
throws java.rmi.RemoteException
The currently logged in customer may have more than one wish list. The one used is the first one found of listType == 0.
storeId - the storeIdsessionId - the sessionIdcustomerFromId - the customerFromIdlanguageId - the languageIdoptions - the optionsjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_WishLists searchForWishLists(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
com.konakart.rmi.app.S_CustomerSearch customerSearch)
throws java.rmi.RemoteException
getWishListWithItems() method, passing it the id of the wish list. This will
also populate the final price attributes of the wish list.
If customerSearch is null, then only the wish lists of the logged in customer will be returned. If dataDesc is set to null, a default DataDescriptor will be used.
Only the following attributes of the CustomerSearchIf object will be used to search:
The custom fields of the dataDesc object will also be used in the search if not set to null.
storeId - the storeIdsessionId - The session id of the logged in user. It may be null if the user isn't logged in.dataDesc - Used to control the data offset, limit the number of items returned and set the
sort ordercustomerSearch - Used to search for customersjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Store getStore(java.lang.String storeId)
throws java.rmi.RemoteException
storeId - the storeIdjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Store getStoreForId(java.lang.String storeId,
java.lang.String vendorStoreId)
throws java.rmi.RemoteException
storeId - the storeIdvendorStoreId - the vendorStoreIdjava.rmi.RemoteException - an unexpected KKException exceptionvoid addCustomDataToSession(java.lang.String storeId,
java.lang.String sessionId,
java.lang.String data,
int position)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - The sessionIddata - The data to be savedposition - This must be in the range of 1-5 to identify custom1 to custom5java.rmi.RemoteException - an unexpected KKException exceptionjava.lang.String getCustomDataFromSession(java.lang.String storeId,
java.lang.String sessionId,
int position)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - The sessionIdposition - This must be in the range of 1-5 to identify custom1 to custom5java.rmi.RemoteException - an unexpected KKException exceptionvoid setCookie(java.lang.String storeId,
com.konakart.rmi.app.S_KKCookie cookie)
throws java.rmi.RemoteException
The cookie object passed in as a parameter must have the following attributes set:
The unique key for the cookie is the customerUuid together with the attributeId. The customerUuid is the value that should be saved and retrieved from the browser cookie and then used to look up the attributes saved in the KonaKart database. It can be created using the java.util.UUID class.
storeId - the storeIdcookie - A KKCookie object to be persisted in the databasejava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_KKCookie getCookie(java.lang.String storeId,
java.lang.String customerUuid,
java.lang.String attrId)
throws java.rmi.RemoteException
When this method is called, the last_read date of the returned cookie in the database, is updated.
storeId - the storeIdcustomerUuid - A random string used to identify the customer that owns the cookiesattrId - An identifier for the cookiejava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_KKCookie[] getAllCookies(java.lang.String storeId,
java.lang.String customerUuid)
throws java.rmi.RemoteException
When this method is called, the last_read date for each returned cookies in the database, is updated.
storeId - the storeIdcustomerUuid - A random string used to identify the customer that owns the cookiesjava.rmi.RemoteException - an unexpected KKException exceptionvoid deleteCookie(java.lang.String storeId,
java.lang.String customerUuid,
java.lang.String attrId)
throws java.rmi.RemoteException
storeId - the storeIdcustomerUuid - A random string used to identify the customer that owns the cookiesattrId - An identifier for the cookiejava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_GeoZone[] getGeoZonesPerZone(java.lang.String storeId,
com.konakart.rmi.app.S_Zone zone)
throws java.rmi.RemoteException
storeId - the storeIdzone - The physical zonejava.rmi.RemoteException - an unexpected KKException exceptionvoid insertCustomerTag(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_CustomerTag tag)
throws java.rmi.RemoteException
sessionId.
If a tag already exists with this name, then the value is replaced with the new value. The compulsory tag fields are:
Note that a customer tag with name tag.getName() must exist in the database
since it is used to validate tag.getValue().
storeId - the storeIdsessionId - The session id of the logged in usertag - Customer Tagjava.rmi.RemoteException - an unexpected KKException exceptionvoid insertCustomerTagForGuest(java.lang.String storeId,
int customerId,
com.konakart.rmi.app.S_CustomerTag tag)
throws java.rmi.RemoteException
customerId which
must have a negative value.
If a tag already exists with this name, then the value is replaced with the new value. The compulsory tag fields are:
Note that a customer tag with name tag.getName() must exist in the database
since it is used to validate tag.getValue().
storeId - the storeIdcustomerId - The id of the guest customer which has a negative value.tag - Customer Tagjava.rmi.RemoteException - an unexpected KKException exceptionvoid addToCustomerTag(java.lang.String storeId,
java.lang.String sessionId,
java.lang.String tagName,
int tagValue)
throws java.rmi.RemoteException
com.konakart.app.CustomerTag.MULTI_INT_TYPE or
MULTI_INT_PLUS_TIME_TYPE. This customer tag type is used to store a series of
integers and is useful for cases where you want to store information such as the last 5
product ids that a customer looked at.
If the customer tag doesn't yet exist for the customer referenced by the
sessionId, then a new customer tag is added with the value in the
tagValue parameter. Otherwise the new value is added. When the number of
integers stored reaches the maximum value defined for the customer tag, then the new value is
added and the oldest value is removed.
In the case of MULTI_INT_PLUS_TIME_TYPE tags, the timestamp component is added
on the server so does not need to be specified.
storeId - the storeIdsessionId - The session id of the logged in usertagName - Name of the customer tagtagValue - Value of the customer tagjava.rmi.RemoteException - an unexpected KKException exceptionvoid addToCustomerTagForGuest(java.lang.String storeId,
int customerId,
java.lang.String tagName,
int tagValue)
throws java.rmi.RemoteException
com.konakart.app.CustomerTag.MULTI_INT_TYPE or
MULTI_INT_PLUS_TIME_TYPE. This customer tag type is used to store a series of
integers and is useful for cases where you want to store information such as the last 5
product ids that a customer looked at.
If the customer tag doesn't yet exist for the guest customer referenced by the
customerId (negative value), then a new customer tag is added with the value in
the tagValue parameter. Otherwise the new value is added. When the number of
integers stored reaches the maximum value defined for the customer tag, then the new value is
added and the oldest value is removed.
In the case of MULTI_INT_PLUS_TIME_TYPE tags, the timestamp component is added
on the server so does not need to be specified.
storeId - the storeIdcustomerId - The id of the guest customer which has a negative value.tagName - Name of the customer tagtagValue - Value of the customer tagjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_CustomerTag getCustomerTag(java.lang.String storeId,
java.lang.String sessionId,
java.lang.String tagName)
throws java.rmi.RemoteException
tagName is returned. The value
attribute of the tag is populated for the customer referenced by the sessionId.
If sessionId is set to null, then a customer tag object with a null value is
returned.
The CustomerTag object contains utility methods to convert the tag string into its original type (i.e. Date, boolean, int etc.).
storeId - the storeIdsessionId - The session id of the logged in usertagName - Name of the customer tagjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_CustomerTag getCustomerTagForGuest(java.lang.String storeId,
int customerId,
java.lang.String tagName)
throws java.rmi.RemoteException
tagName is returned. The value
attribute of the tag is populated for the guest customer referenced by the negative
customerId.
The CustomerTag object contains utility methods to convert the tag string into its original type (i.e. Date, boolean, int etc.).
storeId - the storeIdcustomerId - The id of the guest customer which has a negative value.tagName - Name of the customer tagjava.rmi.RemoteException - an unexpected KKException exceptionjava.lang.String getCustomerTagValue(java.lang.String storeId,
java.lang.String sessionId,
java.lang.String tagName)
throws java.rmi.RemoteException
tagName and for the customer referenced by the sessionId. This
method is faster than the getCustomerTag method, but the actual CustomerTag
object isn't available to convert the String into a more usable form such as boolean or date.storeId - the storeIdsessionId - The session id of the logged in usertagName - Name of the customer tagjava.rmi.RemoteException - an unexpected KKException exceptionjava.lang.String getCustomerTagValueForGuest(java.lang.String storeId,
int customerId,
java.lang.String tagName)
throws java.rmi.RemoteException
tagName and for the guest customer referenced by the negative
customerId. This method is faster than the getCustomerTag method,
but the actual CustomerTag object isn't available to convert the String into a more usable
form such as boolean or date.storeId - the storeIdcustomerId - The id of the guest customer which has a negative value.tagName - Name of the customer tagjava.rmi.RemoteException - an unexpected KKException exceptionvoid deleteCustomerTag(java.lang.String storeId,
java.lang.String sessionId,
java.lang.String tagName)
throws java.rmi.RemoteException
tagName and for
the customer referenced by the sessionId.storeId - the storeIdsessionId - The session id of the logged in usertagName - Name of the customer tagjava.rmi.RemoteException - an unexpected KKException exceptionvoid deleteCustomerTagForGuest(java.lang.String storeId,
int customerId,
java.lang.String tagName)
throws java.rmi.RemoteException
tagName and for
the guest customer referenced by the negative customerId.storeId - the storeIdcustomerId - The id of the guest customer which has a negative value.tagName - Name of the customer tagjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_CustomerTag[] getCustomerTags(java.lang.String storeId,
java.lang.String sessionId)
throws java.rmi.RemoteException
sessionId.
An empty array is returned if no tags exist.
storeId - the storeIdsessionId - The session id of the logged in userjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_CustomerTag[] getCustomerTagsForGuest(java.lang.String storeId,
int customerId)
throws java.rmi.RemoteException
customerId which must have a negative value.
An empty array is returned if no tags exist.
storeId - the storeIdcustomerId - The id of the guest customer which has a negative value.java.rmi.RemoteException - an unexpected KKException exceptionboolean evaluateExpression(java.lang.String storeId,
java.lang.String sessionId,
int expressionId,
java.lang.String expressionName)
throws java.rmi.RemoteException
sessionId. If the expressionName parameter is not set to
null, then the Expression is searched for by name. Otherwise it is searched for by the id
contained in the expressionId parameter.storeId - the storeIdsessionId - The session id of the logged in userexpressionId - Numeric Id of the expressionexpressionName - Name of expressionjava.rmi.RemoteException - an unexpected KKException exceptionboolean evaluateExpressionForGuest(java.lang.String storeId,
int customerId,
int expressionId,
java.lang.String expressionName)
throws java.rmi.RemoteException
customerId. If the expressionName
parameter is not set to null, then the Expression is searched for by name. Otherwise it is
searched for by the id contained in the expressionId parameter.storeId - the storeIdcustomerId - The id of the guest customer which has a negative value.expressionId - Numeric Id of the expressionexpressionName - Name of expressionjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Expression getExpression(java.lang.String storeId,
java.lang.String sessionId,
int expressionId,
java.lang.String expressionName)
throws java.rmi.RemoteException
expressionName parameter is not set to null, then the Expression is searched
for by name. Otherwise it is searched for by the id contained in the
expressionId parameter.
If the sessionId parameter is null we get the expression variables without any
customer tag values. Otherwise the expression variables will be populated with the customer
tag values for the customer referenced by sessionId. other
storeId - the storeIdsessionId - The session id of the logged in userexpressionId - Numeric Id of the expressionexpressionName - Name of expressionjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Expression getExpressionForGuest(java.lang.String storeId,
int customerId,
int expressionId,
java.lang.String expressionName)
throws java.rmi.RemoteException
expressionName parameter is not set to null, then the Expression is searched
for by name. Otherwise it is searched for by the id contained in the
expressionId parameter.
The expression variables will be populated with the customer tag values for the guest
customer referenced by customerId.
storeId - the storeIdcustomerId - The id of the guest customer which has a negative value.expressionId - Numeric Id of the expressionexpressionName - Name of expressionjava.rmi.RemoteException - an unexpected KKException exceptionint pointsAvailable(java.lang.String storeId,
java.lang.String sessionId)
throws java.rmi.RemoteException
sessionId parameter.storeId - the storeIdsessionId - The session id of the logged in userjava.rmi.RemoteException - an unexpected KKException exceptionint addPoints(java.lang.String storeId,
java.lang.String sessionId,
int points,
java.lang.String code,
java.lang.String description)
throws java.rmi.RemoteException
sessionId parameter.storeId - the storeIdsessionId - The session id of the logged in userpoints - Number of points to addcode - An optional code to categorize the reason for awarding the pointsdescription - An optional description describing why the points were awardedjava.rmi.RemoteException - an unexpected KKException exceptionint deletePoints(java.lang.String storeId,
java.lang.String sessionId,
int points,
java.lang.String code,
java.lang.String description)
throws java.rmi.RemoteException
sessionId parameter.storeId - the storeIdsessionId - The session id of the logged in userpoints - Number of points to deletecode - An optional code to categorize the reason for redeeming the pointsdescription - An optional description describing how the points were redeemedjava.rmi.RemoteException - an unexpected KKException exceptionint reservePoints(java.lang.String storeId,
java.lang.String sessionId,
int points)
throws java.rmi.RemoteException
sessionId parameter. The removed points are not deleted but reserved, so that
they are no longer available for spending but may be deleted once the order has been paid for
or shipped. If the order is never fulfilled, then the reserved points may be freed and
returned to the available total.storeId - the storeIdsessionId - The session id of the logged in userpoints - Number of points to reservejava.rmi.RemoteException - an unexpected KKException exceptionvoid deleteReservedPoints(java.lang.String storeId,
java.lang.String sessionId,
int reservationId,
java.lang.String code,
java.lang.String description)
throws java.rmi.RemoteException
reservationId parameter exists and that it belongs to the
customer identified by the sessionId parameter. The reserved points are normally
deleted once the order has been paid for or shipped. If the order is never fulfilled, then
the reserved points may be freed and returned to the available total. Once deleted. the
points can no longer be returned to the total.storeId - the storeIdsessionId - The session id of the logged in userreservationId - Numeric identifier of the reservationcode - An optional code to categorize the reason for redeeming the pointsdescription - An optional description describing how the points were redeemedjava.rmi.RemoteException - an unexpected KKException exceptionint freeReservedPoints(java.lang.String storeId,
java.lang.String sessionId,
int reservationId)
throws java.rmi.RemoteException
reservationId parameter exists and that it belongs to the
customer identified by the sessionId parameter. The reserved points may be freed
and returned to the available total using this API call. The method checks to see whether
some or all of the points have expired while they were in the reserved state.storeId - the storeIdsessionId - The session id of the logged in userreservationId - Numeric identifier of the reservationjava.rmi.RemoteException - an unexpected KKException exceptionvoid setRewardPointReservationId(java.lang.String storeId,
java.lang.String sessionId,
int orderId,
int reservationId)
throws java.rmi.RemoteException
sessionId
parameter and then updates the reservation id on the order.storeId - the storeIdsessionId - the sessionIdorderId - the orderIdreservationId - the reservationIdjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_RewardPoints getRewardPointsWithOptions(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
com.konakart.rmi.app.S_FetchRewardPointOptions options)
throws java.rmi.RemoteException
sessionId
parameter. The most recent objects are returned first. The options object allows you to
define whether to return expired points.storeId - the storeIdsessionId - The session id of the logged in userdataDesc - Used to control the data offset and limit the number of items returnedoptions - Allows you to define whether to return expired pointsjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_RewardPoints getRewardPoints(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc)
throws java.rmi.RemoteException
sessionId
parameter. The most recent objects are returned first.storeId - the storeIdsessionId - The session id of the logged in userdataDesc - Used to control the data offset and limit the number of items returnedjava.rmi.RemoteException - an unexpected KKException exceptionint insertSubscription(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_Subscription subscription)
throws java.rmi.RemoteException
The methods:
The subscription may have an attached CreditCard object. The data within this object will not be persisted in the database but will be passed to the code that communicates with the payment gateway so that it can be transmitted and stored by the payment gateway.
storeId - the storeIdsessionId - The session id of the logged in usersubscription - The subscription object to be insertedjava.rmi.RemoteException - an unexpected KKException exceptionvoid updateSubscription(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_Subscription subscription)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - The session id of the logged in usersubscription - The subscription object to be updatedjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_PaymentSchedule getPaymentSchedule(java.lang.String storeId,
int id)
throws java.rmi.RemoteException
id parameter, or Null if the payment
schedule object doesn't exist in the DB.storeId - the storeIdid - The id of the payment schedule objectjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Subscription[] getSubscriptionsPerCustomer(java.lang.String storeId,
java.lang.String sessionId)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - The session id of the logged in userjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Subscriptions searchForSubscriptionsPerCustomer(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
com.konakart.rmi.app.S_SubscriptionSearch subscriptionSearch)
throws java.rmi.RemoteException
sessionId.
The SubscriptionSearch class contains the search criteria although it may be null.
dataDesc may be null. In this case, the number of retrieved subscriptions is
limited to a default number, the subscriptions are ordered by the SubscriptionId and the
offset is set to zero. However, by setting the attributes of dataDesc, the
following functionality may be controlled :
storeId - the storeIdsessionId - The session id of the logged in userdataDesc - Used to control the data offset, limit the number of items returned and set the
sortsubscriptionSearch - Contains information used to add search constraintsjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Product getProductPerSkuWithOptions(java.lang.String storeId,
java.lang.String sessionId,
java.lang.String sku,
int languageId,
com.konakart.rmi.app.S_FetchProductOptions options)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - The session id of the logged in user; use null if the customer isn't logged in.sku - The product SKUlanguageId - The id for the language that will be used. Value of -1 selects the default
language.options - An object containing options for the method. It may be set to null.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Product getProductPerSku(java.lang.String storeId,
java.lang.String sessionId,
java.lang.String sku,
int languageId)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - The session id of the logged in user; use null if the customer isn't logged in.sku - The product SKUlanguageId - The id for the language that will be used. Value of -1 selects the default
language.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_IpnHistory[] getIpnHistory(java.lang.String storeId,
java.lang.String sessionId,
int orderId)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - The session id of the logged in userorderId - The numeric id of the orderjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_PdfResult getPdf(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_PdfOptions options)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - The session id of the logged in useroptions - The PdfOptions object that defines the PDF document to createjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_DigitalDownload getDigitalDownloadById(java.lang.String storeId,
java.lang.String sessionId,
int digitalDownloadId)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - The session id of the logged in userdigitalDownloadId - The numeric id of the digital download objectjava.rmi.RemoteException - an unexpected KKException exceptionvoid editDigitalDownload(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DigitalDownload digitalDownload)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - The session id of the logged in userdigitalDownload - The digital download object to be editedjava.rmi.RemoteException - an unexpected KKException exceptionjava.lang.String getMsgValue(java.lang.String storeId,
java.lang.String key,
int type,
java.lang.String locale)
throws java.rmi.RemoteException
storeId - the storeIdkey - the message keytype - the message type (should use KKConstants.MSG_TYP_APPLICATION for application
messages)locale - the message locale (eg. "en_GB"). Default is used if left null.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_NameValue[] getMessages(java.lang.String storeId,
int type,
java.lang.String locale)
throws java.rmi.RemoteException
storeId - the storeIdtype - the message type (should use KKConstants.MSG_TYP_APPLICATION for application
messages)locale - the message locale (eg. "en_GB"). Default is used if left null.java.rmi.RemoteException - an unexpected KKException exceptionvoid postMessageToQueue(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_MqOptions options)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - the sessionIdoptions - the MQ optionsjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_MqResponse readMessageFromQueue(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_MqOptions options)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - the sessionIdoptions - the MQ optionsjava.rmi.RemoteException - an unexpected KKException exceptionvoid insertCustomerEvent(java.lang.String storeId,
com.konakart.rmi.app.S_CustomerEvent event)
throws java.rmi.RemoteException
The DateAdded attribute of the event object is added by the engine if left null. The storeId attribute of the event object is added by the engine.
storeId - the storeIdevent - A customer event objectjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_SuggestedSearchItem[] getSuggestedSearchItems(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_SuggestedSearchOptions options)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - the sessionId which may be left null if the customer isn't logged inoptions - A SuggestedSearchOptions object containing all parameters necessary to configure
the SuggestedSearch operationjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_SuggestedSpellingItem[] getSuggestedSpellingItems(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_SuggestedSpellingOptions options)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - the sessionId which may be left null if the customer isn't logged inoptions - A SuggestedSpellingOptions object containing all parameters necessary to configure
the SuggestedSpelling operationjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Product[] getProductsFromIdsWithOptions(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
int[] prodIdArray,
int languageId,
com.konakart.rmi.app.S_FetchProductOptions options)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - The session id of the logged in user; use null if the customer isn't logged in.dataDesc - Can be used to add sort by information and to set whether to return the
description of the products.prodIdArray - An array of product idslanguageId - The id for the language that will be used. Value of -1 selects the default
language.options - An object containing options for the method. It may be set to null.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Bookings getBookingsPerProduct(java.lang.String storeId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
int productId,
com.konakart.rmi.app.S_BookableProductOptions options)
throws java.rmi.RemoteException
storeId - the storeIddataDesc - Can be used to add sort by information and constraints on the custom fieldsproductId - The numeric id of the productoptions - Not used at the moment. May be left null.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Bookings getBookingsPerCustomer(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
com.konakart.rmi.app.S_BookableProductOptions options)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - The sessionId of the logged in customerdataDesc - Can be used to add sort by information and constraints on the custom fieldsoptions - Not used at the moment. May be left null.java.rmi.RemoteException - an unexpected KKException exceptionint insertBooking(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_Booking booking,
com.konakart.rmi.app.S_BookableProductOptions options)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - The sessionId of the logged in customerbooking - A booking objectoptions - Options allowing an exception to be thrown for exceeding the maximum number of
bookingsjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Product[] getBookableProductConflict(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_Product bookableProd,
com.konakart.rmi.app.S_BookableProductOptions options)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - The sessionId of the logged in customerbookableProd - The bookable product being checkedoptions - Not used at the moment. May be left null.java.rmi.RemoteException - an unexpected KKException exceptionint getOrderStatus(java.lang.String storeId,
java.lang.String sessionId,
int orderId)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - The session id of the logged in userorderId - The numeric id of the orderjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_OrderStatus[] getAllOrderStatuses(java.lang.String storeId,
int languageId)
throws java.rmi.RemoteException
storeId - the storeIdlanguageId - The id for the language that will be used to determine the customer group name and
description. Value of -1 selects the default language.java.rmi.RemoteException - an unexpected KKException exceptionjava.lang.String saveSSOToken(java.lang.String storeId,
com.konakart.rmi.app.S_SSOToken token)
throws java.rmi.RemoteException
storeId - the storeIdtoken - The SSO token to be savedjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_SSOToken getSSOToken(java.lang.String storeId,
java.lang.String secretKey,
boolean deleteToken)
throws java.rmi.RemoteException
deleteToken parameter is set to true, the token is deleted from the
database after having been read.storeId - the storeIdsecretKey - The UUID secretKey used to identify the tokendeleteToken - The token is deleted from the database after being readjava.rmi.RemoteException - an unexpected KKException exceptionvoid enableCustomer(java.lang.String storeId,
java.lang.String secretKey)
throws java.rmi.RemoteException
This method is normally used to verify a customer's email before enabling a customer. i.e. When the customer registers, the registration is made but the customer remains disabled. An SSO token is saved containing the id of the new customer. At this point an eMail is sent to the customer, prompting him to click on a link containing the SSO token secret key. The link calls an application method that uses the secret key to enable the customer by calling this API call.
If the custom1 attribute of the SSO token object is set to true
then the emailVerified attribute of the customer is also set. If the customer is
enabled during registration, this API call may still be used to set the
emailVerified attribute when a customer clicks the link in the email.
storeId - the storeIdsecretKey - the secretKeyjava.rmi.RemoteException - an unexpected KKException exceptionint checkCoupon(java.lang.String storeId,
java.lang.String couponCode)
throws java.rmi.RemoteException
storeId - the storeIdcouponCode - The coupon codejava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Promotion[] getAllPromotions(java.lang.String storeId)
throws java.rmi.RemoteException
storeId - the storeIdjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Product[] getPromotionsPerProducts(java.lang.String storeId,
java.lang.String sessionId,
int customerId,
com.konakart.rmi.app.S_Product[] products,
com.konakart.rmi.app.S_Promotion[] promotions,
java.lang.String[] couponCodes,
com.konakart.rmi.app.S_PromotionOptions options)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - Only used if the customer is logged in. Otherwise set to null.customerId - If the sessionId is set to null then the customerId should contain the id of the
temporary user which is a negative number. The temporary user id can be used for
evaluating expression rules.products - An array of products to be processedpromotions - The promotions which will be applied to the products if all rules are matched.couponCodes - Coupon codes to use. If none of the promotions require coupons, it should be set
to nulloptions - An object containing information to configure the calculation for applying one or
more promotion results to the product price.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_ConfigData[] getConfigData(java.lang.String storeId,
java.lang.String sessionId,
java.lang.String key)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - Session Id of the customer.key - Only return the ConfigData items with this key (if null all ConfigData items are
returned)java.rmi.RemoteException - an unexpected KKException exceptionjava.lang.String getKonaKartVersion(java.lang.String storeId)
throws java.rmi.RemoteException
storeId - the storeIdjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_PunchOutResult getPunchOutMessage(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_Order order,
com.konakart.rmi.app.S_PunchOutOptions options)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - Session Id of the customer.order - Order used to create messageoptions - Options to configure the call by defining things such as the standard used for the
message and the version of the standard.java.rmi.RemoteException - an unexpected KKException exceptionvoid addCustomerNotifications(java.lang.String storeId,
com.konakart.rmi.app.S_NotificationOptions options)
throws java.rmi.RemoteException
storeId - the storeIdoptions - Contains the method parameters.java.rmi.RemoteException - an unexpected KKException exceptionvoid deleteCustomerNotifications(java.lang.String storeId,
com.konakart.rmi.app.S_NotificationOptions options)
throws java.rmi.RemoteException
storeId - the storeIdoptions - Contains the method parameters.java.rmi.RemoteException - an unexpected KKException exceptionjava.lang.String getAddressFormatTemplate(java.lang.String storeId,
int templateId)
throws java.rmi.RemoteException
storeId - the storeIdtemplateId - Numeric id of the templatejava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Products getBundlesThatProductBelongsTo(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
int productId,
int languageId,
com.konakart.rmi.app.S_FetchProductOptions options)
throws java.rmi.RemoteException
productId as one of the bundled products. Each of the returned
products has the bundledProducts attribute populated with all of the bundled
products. The quantity attribute of each bundled product determines the number
of instances of the product within the bundle and the encodedOptionValues
attribute of each bundled product contains a string with the encoded option values
determining the configuration of the product (e.g size, color etc.).createListOfUniqueProducts which
may be used to configure the API call. This method returns an array of products, each of
which has an array of bundled products. The same products may be repeated many times within
the array of bundled products which can affect performance since the amount of data returned
can be very large. When createListOfUniqueProducts is set to true, the bundled
products are only populated with the product id, the quantity and the encodedOptionValues to
make them very much lighter. Also within the Products return object the
uniqueProductArray attribute is created and populated with a unique set of
products that includes just one copy of all of the bundled products.storeId - the storeIdsessionId - The session id of the logged in userdataDesc - Used to control the data offset, limit the number of items returned and set the
sort order. It may be null, in which case, the number of retrieved products is
limited to a default number and the offset is set to zero.productId - The numeric id of the productlanguageId - The id for the language that will be used. Value of -1 selects the default
language.options - An object containing options for the method. It may be set to null.bundledProducts attribute containing the products within the bundle. The
uniqueProductArray attribute may be populated if
createListOfUniqueProducts is set to true in the options object passed
in as a parameter.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Products getBundlesThatProductsBelongTo(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
int[] productIds,
boolean exactMatch,
int languageId,
com.konakart.rmi.app.S_FetchProductOptions options)
throws java.rmi.RemoteException
productIds as one or more of the bundled products. Each of the
returned products has the bundledProducts attribute populated with all of the
bundled products. The quantity attribute of each bundled product determines the
number of instances of the product within the bundle and the encodedOptionValues
attribute of each bundled product contains a string with the encoded option values
determining the configuration of the product (e.g size, color etc.).createListOfUniqueProducts which
may be used to configure the API call. This method returns an array of products, each of
which has an array of bundled products. The same products may be repeated many times within
the array of bundled products which can affect performance since the amount of data returned
can be very large. When createListOfUniqueProducts is set to true, the bundled
products are only populated with the product id, the quantity and the encodedOptionValues to
make them very much lighter. Also within the Products return object the
uniqueProductArray attribute is created and populated with a unique set of
products that includes just one copy of all of the bundled products.storeId - the storeIdsessionId - The session id of the logged in userdataDesc - Used to control the data offset, limit the number of items returned and set the
sort order. It may be null, in which case, the number of retrieved products is
limited to a default number and the offset is set to zero.productIds - The numeric ids of the products that are in the bundleexactMatch - Determines whether the call should return only bundles which contain exactly the
products sent in the array of product IDs, or return all the bundles which contain
at least all the products in the passed product IDs.languageId - The id for the language that will be used. Value of -1 selects the default
language.options - An object containing options for the method. It may be set to null.bundledProducts attribute containing the products within the bundle. The
uniqueProductArray attribute may be populated if
createListOfUniqueProducts is set to true in the options object passed
in as a parameter.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_ProductImages getProductImages(java.lang.String storeId,
com.konakart.rmi.app.S_ProductImagesOptions options)
throws java.rmi.RemoteException
storeId - the storeIdoptions - a ProductImagesOptions object for specifying the criteria used to define which
product images should be returned. Within this search object you can specify
productId and a file name filter (which is a regular expression).java.rmi.RemoteException - if options is null or if no product with the specified productId can be found or
the store is currently unavailable.int insertKKEvent(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_KKEvent event)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - The session id of the logged in userevent - a KKEvent objectjava.rmi.RemoteException - an unexpected exceptioncom.konakart.rmi.app.S_KKEvent[] getKKEvents(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_KKEventSearch search,
com.konakart.rmi.app.S_DataDescriptor desc)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - The session id of the logged in usersearch - KKEventSearchIf search object that defines the records to retrievedesc - DataDescriptorIf generic search object that can be used to set the offset, limit
and order by clauses. Options for order by are:
java.rmi.RemoteException - an unexpected exceptionvoid processKKEvents(java.lang.String storeId,
java.lang.String sessionId)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - the sessionIdjava.rmi.RemoteException - an unexpected exceptionboolean validatePassword(java.lang.String storeId,
java.lang.String sessionId,
java.lang.String password)
throws java.rmi.RemoteException
The method returns true if the password validates against the session. If either the session is invalid or the password and session don't match, then the method returns false.
storeId - the storeIdsessionId - the sessionIdpassword - the passwordjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Coupon[] getCouponsPerCode(java.lang.String storeId,
java.lang.String couponCode,
com.konakart.rmi.app.S_CouponOptions options)
throws java.rmi.RemoteException
The options object allows you to specify that only active coupons should be returned.
storeId - the storeIdcouponCode - The code of the couponoptions - Allows you to specify that only active coupons should be returnedjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Coupon getCouponPerId(java.lang.String storeId,
int couponId,
com.konakart.rmi.app.S_CouponOptions options)
throws java.rmi.RemoteException
The options object allows you to specify that only active coupons should be returned.
storeId - the storeIdcouponId - The unique numeric id of the couponoptions - Allows you to specify that only active coupons should be returnedjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Promotion[] getPromotionsPerCoupon(java.lang.String storeId,
java.lang.String couponCode,
int couponId,
com.konakart.rmi.app.S_PromotionOptions options)
throws java.rmi.RemoteException
The PromotionOptions may be used to control whether or not to use expired coupons and whether or not to return expired promotions. The default is to not check whether coupons or promotions have expired.
If no promotions are found, an empty array is returned.
storeId - the storeIdcouponCode - The code of the couponcouponId - The unique numeric id of the couponoptions - A PromotionOptions object to control whether or not to use expired coupons and
whether or not to return expired promotionsjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Content getContent(java.lang.String storeId,
int contentId,
int languageId)
throws java.rmi.RemoteException
storeId - the storeIdcontentId - the contentIdlanguageId - the languageId of the Content to return (Content Descriptions are
language-specific). If KKConstants.DEFAULT_LANGUAGE_ID is used the default
languageId is used).java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_ContentSearchResult getContents(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_ContentSearch search,
com.konakart.rmi.app.S_DataDescriptor dd)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - the sessionId of the customer. This may be used to look up the customer in order
to evaluate expressions to determine the required content. Set to null if the
customer isn't logged in.search - the content search criteriadd - the data descriptor object. In the DataDescriptor there is an attribute called
limit where you define the maximum number of records to return from the database.
Note that expressions are evaluated after the records are retrieved so fewer
records than the maximum requested may be returned if your content is linked to
expressions, you choose to evaluate them and some evaluate to false.
You can set the OrderBy attribute on the DataDescriptor to define the order that the content records will be returned. Options are:
java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_ContentType getContentType(java.lang.String storeId,
int contentTypeId,
int languageId)
throws java.rmi.RemoteException
storeId - the storeIdcontentTypeId - the ContentTypeIdlanguageId - the languageId of the ContentType to return (Content Type Descriptions are
language-specific). If KKConstants.DEFAULT_LANGUAGE_ID is used the default
languageId is used).java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_ContentType[] getContentTypes(java.lang.String storeId,
int languageId)
throws java.rmi.RemoteException
storeId - the storeIdlanguageId - the languageId of the ContentTypes to return (Content Type Descriptions are
language-specific). If KKConstants.DEFAULT_LANGUAGE_ID is used the default
languageId is used).java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Basket[] reserveStock(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_Basket[] basketItems,
com.konakart.rmi.app.S_StockReservationOptions options)
throws java.rmi.RemoteException
The options allow you to:
quantityInStock attribute. The reservation information is also persisted in the
database.
If any of the Basket items contain products or product variations no longer in the catalog then they are not included in the return array.
storeId - the storeIdsessionId - The session id of the logged in user.basketItems - An array of basket items existing in the database.options - An object containing options for the method. It may be set to null.reservationId,
qtyResrvdForResId and reservationExpiryDate populated. The
reservationId is set to -1 if the reservation could not be made because
the stock was not available or for any other reason.java.rmi.RemoteException - an unexpected KKException exceptionint removeStockReservationsForBasketItems(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_Basket[] basketItems,
com.konakart.rmi.app.S_StockReservationOptions options)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - The session id of the logged in userbasketItems - An array of basket items existing in the database.options - An object containing options for the method. It's not currently used and may be
set to null.java.rmi.RemoteException - an unexpected KKException exceptionint removeStockReservationsForOrderProducts(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_OrderProduct[] orderProducts,
com.konakart.rmi.app.S_StockReservationOptions options)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - The session id of the logged in userorderProducts - An array of OrderProduct items attached to an order.options - An object containing options for the method. It's not currently used and may be
set to null.java.rmi.RemoteException - an unexpected KKException exceptionint removeStockReservationsForIds(java.lang.String storeId,
java.lang.String sessionId,
int[] idArray,
com.konakart.rmi.app.S_StockReservationOptions options)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - The session id of the logged in useridArray - An array of stock reservation idsoptions - An object containing options for the method. It's not currently used and may be
set to null.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_ProductQuantity createProductQuantityEncodedKeyFromEncodedProductId(java.lang.String storeId,
java.lang.String encodedProductId)
throws java.rmi.RemoteException
The format of the encoded product id is 1{2}3{4}5 where the product id = 1, the first optionId / valueId pair have ids of 2,3 and the 2nd optionId / valueId pair have ids of 4,5.
The format of the encoded key for the products_quantitytable is 3{4}4{6} which means product_options of id==3 and product_options_values of id==4 followed by product_options of id==4 and product_options_values of id==6. The order is very important since the product option ids must be in ascending order.
storeId - the storeIdencodedProductId - the encodedProductIdjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_ExternalLoginResult externalLogin(java.lang.String storeId,
com.konakart.rmi.app.S_ExternalLoginInput loginInfo)
throws java.rmi.RemoteException
com.konakart.bl.modules.others.ExternalLoginInterface) must be present in the
system and must have been installed and activated.
The function of this method is to instantiate the module, to call its
externalLogin method and to return the result from the module which should
contain a KonaKart sessionId if the login was successful.
storeId - the storeIdloginInfo - Contains the information required by the module to perform the loginjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Catalog getCatalogPerKey(java.lang.String storeId,
java.lang.String catalogKey)
throws java.rmi.RemoteException
storeId - the storeIdcatalogKey - The key identifying the catalog. Note that this is a semantic key and not the
numeric catalog id.java.rmi.RemoteException - an unexpected KKException exceptionvoid setNewPassword(java.lang.String storeId,
java.lang.String adminSession,
java.lang.String customerEmailAddr,
int customerId,
java.lang.String newPassword)
throws java.rmi.RemoteException
sendNewPassword1(String emailAddr, EmailOptionsIf options) API call generates a
password and sends it the customer in an email. This API call is intended to be used when you
want to allow a customer to change his own password maybe by clicking on a link which expires
after a pre-defined number of minutes.
For security purposes, the session id of a KonaKart administrator must be passed in as a parameter. This session id is checked to ensure that it applies to a logged in administrator.
If customerEmailAddr is set then the customer is looked up from the email
address. Otherwise the customerId is used to look up the customer. If the customer isn't
found, an exception is thrown.
storeId - the storeIdadminSession - The session id of an administratorcustomerEmailAddr - The email address of the customercustomerId - The id of the customer. Only used if customerEmailAddr is nullnewPassword - The new passwordjava.rmi.RemoteException - an unexpected KKException exceptionint addCreditCardToCustomer(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_CreditCard card,
com.konakart.rmi.app.S_CreditCardOptions options)
throws java.rmi.RemoteException
This API call is intended for saving tokenized (or vaulted) cards where the CreditCard object doesn't contain any sensitive card information. It should just contain the token returned from the payment gateway as well as a few digits of the card number and maybe the expiration date in order to detect that the card has expired. No encryption is performed.
storeId - the storeIdsessionId - The session id of the logged in usercard - A CreditCard objectoptions - CreditCardOptions not currently usedjava.rmi.RemoteException - an unexpected exceptioncom.konakart.rmi.app.S_CreditCard[] getCreditCardsPerCustomer(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_CreditCardOptions options)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - The session id of the logged in useroptions - Used to manage whether the returned cards have the formatted address attribute
populatedjava.rmi.RemoteException - an unexpected exceptionvoid deleteCreditCard(java.lang.String storeId,
java.lang.String sessionId,
int cardId)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - The session id of the logged in usercardId - The id of the CreditCard object to deletejava.rmi.RemoteException - an unexpected exceptionvoid editCreditCard(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_CreditCard card,
com.konakart.rmi.app.S_CreditCardOptions options)
throws java.rmi.RemoteException
storeId - the storeIdsessionId - The session id of the logged in usercard - A credit card objectoptions - CreditCardOptions not currently usedjava.rmi.RemoteException - an unexpected exceptioncom.konakart.rmi.app.S_Promotion getPromotion(java.lang.String storeId,
int promotionId,
java.lang.String promotionName,
int languageId,
com.konakart.rmi.app.S_FetchPromotionOptions prmOptions,
com.konakart.rmi.app.S_FetchProductOptions prodOptions)
throws java.rmi.RemoteException
The purpose of this method is mainly to determine what products, manufacturers or categories
are included or excluded from the promotion in order to be able to display this information
on the storefront. However if the FetchPromotionOptions is configured to only
return the promotion if active, then we check the following:
couponCodes attribute of the FetchPromotionOptions
object has been populated and the promotion requires a coupon then we check that at least one
coupon will activate the promotion.storeId - the storeIdpromotionId - The numeric id of the promotion used to identify it. It should be set to a
negative number in order to search for the promotion using the promotion name.promotionName - If not set to null, the promotion name is used to search for the promotion instead
of the numeric id.languageId - The id for the language that will be used when creating the attached products,
categories and manufacturers. Value of -1 selects the default language.prmOptions - A FetchPromotionOptions object used to configure the API call. It may be set to
null for default functionality.prodOptions - A FetchProductOptions used to configure the products (if any) attached to the
promotion. It may be set to null for default functionality.java.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Address[] getAddressesPerVendor(java.lang.String storeId,
com.konakart.rmi.app.S_Vendor vendor)
throws java.rmi.RemoteException
storeId - the storeIdvendor - - Only the vendorId and the defaultAddrId are usedjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Vendors getVendors(java.lang.String storeId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
com.konakart.rmi.app.S_VendorSearch search)
throws java.rmi.RemoteException
dataDesc controls the following functionality:
storeId - the storeIddataDesc - The data descriptor object that defines the sort order, constraints on custom
fields and offset and limit for paging.search - The Vendor search object that defines the search criteriajava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Vendor getVendorForId(java.lang.String storeId,
int vendorId)
throws java.rmi.RemoteException
storeId - the storeIdvendorId - The numeric vendor idjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Reviews getVendorReviews(java.lang.String storeId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
com.konakart.rmi.app.S_ReviewSearch search)
throws java.rmi.RemoteException
The ReviewSearch object also allows you to specify that the return data contains:
dataDesc controls the following functionality:
storeId - the storeIddataDesc - The data descriptor object that defines the sort order, constraints on custom
fields and offset and limit for paging.search - The Review search object that defines the search criteriajava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Review getVendorReview(java.lang.String storeId,
int reviewId)
throws java.rmi.RemoteException
storeId - the storeIdreviewId - the reviewIdjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Reviews getReviewsPerVendor(java.lang.String storeId,
com.konakart.rmi.app.S_DataDescriptor dataDesc,
int vendorId)
throws java.rmi.RemoteException
dataDesc controls the following functionality:
storeId - the storeIddataDesc - The data descriptor object that defines the sort order, constraints on custom
fields and offset and limit for paging.vendorId - The numeric id of the vendorjava.rmi.RemoteException - an unexpected KKException exceptionvoid checkFileAccess(java.lang.String storeId,
java.lang.String fileName)
throws java.rmi.RemoteException
storeId - the storeIdfileName - the file to be accessed (read or written)java.rmi.RemoteException - if access to the filepath isn't permitted an Exception is thrown otherwise the
method returns successfully.boolean isCustomerSubscribedToNewsletter(java.lang.String storeId,
java.lang.String emailAddr)
throws java.rmi.RemoteException
emailAddr parameter is subscribed to receive the newsletter.storeId - the storeIdemailAddr - The email address of the customer we are checkingjava.rmi.RemoteException - an unexpected KKException exceptioncom.konakart.rmi.app.S_Suggestion[] getSuggestions(java.lang.String storeId,
java.lang.String sessionId,
com.konakart.rmi.app.S_Suggestion suggestion,
com.konakart.rmi.app.S_DataDescriptor dataDesc)
throws java.rmi.RemoteException
The where clause for the select will be created by using the values in the suggestion parameter.
storeId - the storeIdsessionId - The session id of the logged in usersuggestion - Used to define the searchdataDesc - data descriptor for defining generic search parameters such as size and offsetjava.rmi.RemoteException - an unexpected exception in the KonaKart Admin enginecom.konakart.rmi.app.S_MiscItem[] getMiscItemsPerType(java.lang.String storeId,
int typeId,
int languageId)
throws java.rmi.RemoteException
storeId - the storeIdtypeId - the typeIdlanguageId - the languageIdjava.rmi.RemoteException - an unexpected exceptioncom.konakart.rmi.app.S_ProductRelationship[] getAllProductRelationships(java.lang.String storeId)
throws java.rmi.RemoteException
storeId - the storeIdjava.rmi.RemoteException - an unexpected exceptioncom.konakart.rmi.app.S_CaptchaResult validateCaptcha(java.lang.String storeId,
com.konakart.rmi.app.S_CaptchaInput captchaInfo)
throws java.rmi.RemoteException
storeId - the storeIdcaptchaInfo - Contains the information required by the module to perform the validationjava.rmi.RemoteException - an unexpected exceptionvoid deleteCustomer(java.lang.String storeId,
int custId)
throws java.rmi.RemoteException
customerId is deleted.storeId - the storeIdcustId - The numeric id of the customer objectjava.rmi.RemoteException - an unexpected KKException exceptionCopyright © 2018 DS Data Systems UK Ltd.