Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.konakart.appif
Interface KKEngIf

All Known Implementing Classes:
KKEng, KKJSONEng, KKRMIEng, KKWSEng
public interface KKEngIf

Describes all of the API calls to the KonaKart server engine.

Method Summary
 int addAddressToCustomer(java.lang.String sessionId, AddressIf addr)
          The Address object is added to the customer defined by the sessionId.
 void addCustomDataToSession(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.
 int addPoints(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 sessionId, int productId)
          Adds a product notification to the list of notifications for the customer.
 java.math.BigDecimal addTax(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 sessionId, int customerId, BasketIf item)
          Saves the Basket object in the database for a customer.
 int addToBasketWithOptions(java.lang.String sessionId, int customerId, BasketIf item, AddToBasketOptionsIf options)
          If options is set to null, this method is identical to addToBasket().
 void addToCustomerTag(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.
 void addToCustomerTagForGuest(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.
 int addToWishList(java.lang.String sessionId, WishListItemIf wishListItem)
          Add a WishListItem object to the wish list referenced by wishListId.
 int addToWishListWithOptions(java.lang.String sessionId, WishListItemIf wishListItem, AddToWishListOptionsIf options)
          If options is set to null, this method is identical to addToWishList().
 OrderIf changeDeliveryAddress(java.lang.String sessionId, OrderIf order, AddressIf 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 sessionId, int orderId, int status, boolean customerNotified, java.lang.String comments)
          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 changePassword(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 couponCode)
          This method is used to verify whether a coupon code actually exists and if it does, whether the coupon is still active.
 int checkSession(java.lang.String sessionId)
          The given sessionId is checked to see whether it exists and whether it is has timed out.
 OrderIf createAndSaveOrder(java.lang.String emailAddr, java.lang.String password, CustomerRegistrationIf custReg, BasketIf[] basketItemArray, java.lang.String shippingModule, java.lang.String paymentModule, int languageId)
          A high level call to simplify the process of creating a KonaKart order.
 OrderIf createOrder(java.lang.String sessionId, BasketIf[] basketItemArray, int languageId)
          An order object is returned with all addresses populated with the default address of the customer referenced by sessionId.
 OrderIf createOrderWithOptions(java.lang.String sessionId, BasketIf[] basketItemArray, CreateOrderOptionsIf options, int languageId)
          If options is set to null, this method is identical to createOrder().
 int createWishList(java.lang.String sessionId, WishListIf wishList)
          Create a wish list from a WishList object.
 int createWishListWithOptions(java.lang.String sessionId, WishListIf wishList, AddToWishListOptionsIf options)
          Create a wish list from a WishList object.
 java.lang.String custom(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 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 sessionId, int addressId)
          The address defined by the sessionId and addressId is deleted.
 void deleteCookie(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 deleteCustomerTag(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(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 secretKey)
          The secret key is removed from the system.
 int deletePoints(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 sessionId, int productId)
          Deletes a product notification from the list of notifications for the customer.
 void deleteReservedPoints(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 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 sessionId, int wishListId, AddToWishListOptionsIf 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 emailAddr)
          Determine whether a customer has already registered with a certain eMail address as their user name.
 void editConfiguration(java.lang.String key, java.lang.String value)
          Edits an existing configuration.
 void editCustomer(java.lang.String sessionId, CustomerIf cust)
          The Customer object will replace the existing customer object in the database.
 void editCustomerAddress(java.lang.String sessionId, AddressIf addr)
          The Address object will replace the existing address object in the database with the same id.
 void editDigitalDownload(java.lang.String sessionId, DigitalDownloadIf digitalDownload)
          Edits the digital download object if it belongs to the customer identified by the sessionId.
 void editWishList(java.lang.String sessionId, WishListIf wishList)
          Edit an existing wish list object.
 void editWishListWithOptions(java.lang.String sessionId, WishListIf wishList, AddToWishListOptionsIf options)
          Edit an existing wish list object.
 void enableCustomer(java.lang.String secretKey)
          This method reads the SSO token using the Secret Key.
 boolean evaluateExpression(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(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.
 int forceRegisterCustomer(CustomerRegistrationIf 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 sessionId, int reservationId)
          Verifies that the reservationId parameter exists and that it belongs to the customer identified by the sessionId parameter.
 AddressIf[] getAddressesPerCustomer(java.lang.String sessionId)
          Returns all of the addresses registered for the given customer.
 AddressIf[] getAddressesPerManufacturer(int manufacturerId)
          Gets an array of Address objects that have been defined for the manufacturer referenced by the manufacturerId.
 AddressIf[] getAddressesPerProduct(int productId)
          Gets an array of Address objects that have been defined for the product referenced by the productId.
 KKCookieIf[] getAllCookies(java.lang.String customerUuid)
          Fetches all of the cookie object from the database that are referenced by the customerUuid parameter.
 CountryIf[] getAllCountries()
          Returns an array of Country objects for all of the countries in the system.
 CurrencyIf[] getAllCurrencies()
          Returns an array of currency objects for all the records in the currencies table.
 CustomerGroupIf[] getAllCustomerGroups(int languageId)
          Returns an array of customer groups for all customer groups that have been defined in the system.
 LanguageIf[] getAllLanguages()
          Returns an array of Language classes containing all of the languages that have been defined within the system.
 ManufacturerIf[] getAllManufacturers()
          Returns an array of Manufacturer objects for all of the manufacturers in the system.
 OrderStatusIf[] getAllOrderStatuses(int languageId)
          Returns an array of order status objects for the language defined by languageId.
 ProductsIf getAllProducts(java.lang.String sessionId, DataDescriptorIf dataDesc, int languageId)
          Returns all products using the given language.
 ProductsIf getAllProductsWithOptions(java.lang.String sessionId, DataDescriptorIf dataDesc, int languageId, FetchProductOptionsIf options)
          An options object is passed in to customize from where some of the product attributes (such as price and quantity) are fetched from.
 PromotionIf[] getAllPromotions()
          Returns an array of all active promotions.
 ReviewsIf getAllReviews(DataDescriptorIf dataDesc)
          An array of review objects is returned.
 ProductsIf getAllSpecials(java.lang.String sessionId, DataDescriptorIf dataDesc, int languageId)
          Returns all specials using the given language.
 ProductIf[] getAlsoPurchased(java.lang.String sessionId, DataDescriptorIf dataDesc, int productId, int languageId)
          Find products that were in the same order as orders containing the product referenced by productId.
 ProductIf[] getAlsoPurchasedWithOptions(java.lang.String sessionId, DataDescriptorIf dataDesc, int productId, int languageId, FetchProductOptionsIf options)
          An options object is passed in to customize from where some of the product attributes (such as price and quantity) are fetched from.
 BasketIf[] getBasketItemsPerCustomer(java.lang.String sessionId, int customerId, int languageId)
          Get the basket items for a customer and language.
 BasketIf[] getBasketItemsPerCustomerWithOptions(java.lang.String sessionId, int customerId, int languageId, AddToBasketOptionsIf options)
          Get the basket items for a customer and language.
 ProductIf[] getBestSellers(DataDescriptorIf dataDesc, int categoryId, int languageId)
          Returns an array of bestseller products for the category referenced by categoryId and its children.
 ProductIf[] getBestSellersWithOptions(DataDescriptorIf dataDesc, int categoryId, int languageId, FetchProductOptionsIf options)
          An options object is passed in to customize from where some of the product attributes (such as price and quantity) are fetched from.
 ProductIf[] getBookableProductConflict(java.lang.String sessionId, ProductIf bookableProd, BookableProductOptionsIf 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.
 BookingsIf getBookingsPerCustomer(java.lang.String sessionId, DataDescriptorIf dataDesc, BookableProductOptionsIf options)
          Get an array of bookings for a logged in customer.
 BookingsIf getBookingsPerProduct(DataDescriptorIf dataDesc, int productId, BookableProductOptionsIf options)
          Get an array of bookings for a bookable product.
 CategoryIf[] getCategoriesPerManufacturer(int manufacturerId, int languageId)
          Returns an array of leaf Category objects for the given manufacturer.
 CategoryIf[] getCategoriesPerProduct(int productId, int languageId)
          Returns an array of Category objects for the given product.
 CategoryIf getCategory(int categoryId, int languageId)
          Returns a complete single Category object for the given categoryId and language.
 CategoryIf[] getCategoryTree(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.
 KKConfigurationIf getConfiguration(java.lang.String key)
          Returns a Configuration object referenced by the key passed in as a parameter
 KKConfigurationIf[] getConfigurations()
          Returns an array of Configuration objects containing all configurations that have been defined in the system.
 java.lang.String getConfigurationValue(java.lang.String key)
          Returns a Configuration Value referenced by the key passed in as a parameter
 java.math.BigDecimal getConfigurationValueAsBigDecimal(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 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 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 key)
          Returns a Configuration Value as an integer for the key passed in as a parameter
 int getConfigurationValueAsIntWithDefault(java.lang.String key, int def)
          Returns a Configuration Value as an integer for the key passed in as a parameter
 KKCookieIf getCookie(java.lang.String customerUuid, java.lang.String attrId)
          Fetches the cookie object from the database that is referenced by the customerUuid and attrId parameters.
 CountryIf getCountry(int countryId)
          Returns the country object for the countryId, or null if the country doesn't exist in the DB.
 CountryIf getCountryPerName(java.lang.String countryName)
          Returns the country object for the countryName, or null if the country doesn't exist in the DB.
 CurrencyIf getCurrency(java.lang.String currencyCode)
          Returns the currency referenced by currencyCode.
 java.lang.String getCustomDataFromSession(java.lang.String sessionId, int position)
          A sessionId is created when a customer logs in to KonaKart using the login() API call.
 CustomerIf getCustomer(java.lang.String sessionId)
          Returns the customer object for the customer defined by the given sessionId.
 CustomerGroupIf getCustomerGroup(int customerGroupId, int languageId)
          Returns a customer group object for the customerGroupId passed in as a parameter.
 CustomerTagIf getCustomerTag(java.lang.String sessionId, java.lang.String tagName)
          A CustomerTag object referenced by the parameter tagName is returned.
 CustomerTagIf getCustomerTagForGuest(int customerId, java.lang.String tagName)
          A CustomerTag object referenced by the parameter tagName is returned.
 CustomerTagIf[] getCustomerTags(java.lang.String sessionId)
          This method fetches all of the customer tags for the customer referenced by the sessionId.
 CustomerTagIf[] getCustomerTagsForGuest(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 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(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.
 AddressIf getDefaultAddressPerCustomer(java.lang.String sessionId)
          Returns the default address for the given customer.
 CurrencyIf getDefaultCurrency()
          The default currency is referenced by a configuration variable called DEFAULT_CURRENCY.
 CustomerIf getDefaultCustomer()
          Returns the customer object for the default customer.
 LanguageIf getDefaultLanguage()
          The default language is referenced by a configuration variable called DEFAULT_LANGUAGE.
 DigitalDownloadIf getDigitalDownloadById(java.lang.String sessionId, int digitalDownloadId)
          Returns a Digital Download object for the digital download id.
 DigitalDownloadIf[] getDigitalDownloads(java.lang.String sessionId)
          Returns an array of Digital Download objects for the customer identified by the sessionId parameter.
 EngineConfigIf getEngConf()
          The EngineConfig is the configuration object passed to the engine at the time of instantiation.
 ExpressionIf getExpression(java.lang.String sessionId, int expressionId, java.lang.String expressionName)
          An Expression object, fully populated with an array of Expression Variables is returned.
 ExpressionIf getExpressionForGuest(int customerId, int expressionId, java.lang.String expressionName)
          An Expression object, fully populated with an array of Expression Variables is returned.
 GeoZoneIf[] getGeoZonesPerZone(ZoneIf zone)
          Returns an array of GeoZone objects (tax areas) for the zone passed in as a parameter.
 IpnHistoryIf[] getIpnHistory(java.lang.String sessionId, int orderId)
          Retrieve an array of IpnHistory objects for an order.
 java.util.Calendar getKonakartTimeStamp()
          Get a Date Time Stamp from the server
 LanguageIf getLanguagePerCode(java.lang.String code)
          Retrieves the language object referenced by the two letter code (i.e.
 LanguageIf getLanguagePerId(int languageId)
          Retrieves the language object referenced by the id.
 ManufacturerIf getManufacturer(int manufacturerId, int languageId)
          Returns a complete Manufacturer object for the given manufacturerId and language.
 ManufacturerIf getManufacturerPerProduct(int productId, int languageId)
          Returns a complete Manufacturer object for the given productId and language.
 ManufacturerIf[] getManufacturersPerCategory(int categoryId)
          Returns an array of Manufacturer objects for the given category.
 NameValueIf[] getMessages(int type, java.lang.String locale)
          Used to fetch a message catalog for a locale and message type.
 java.lang.String getMsgValue(java.lang.String key, int type, java.lang.String locale)
          Get an Application Message Value.
 OrderIf getOrder(java.lang.String sessionId, int orderId, int languageId)
          Gets on order with the specified order Id, for the customer referenced by the sessionId.
 ProductIf[] getOrderHistory(DataDescriptorIf dataDesc, java.lang.String sessionId, int languageId)
          Get a list of the products ordered by the customer referenced by sessionId.
 ProductIf[] getOrderHistoryWithOptions(DataDescriptorIf dataDesc, java.lang.String sessionId, int languageId, FetchProductOptionsIf 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 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.
 OrdersIf getOrdersPerCustomer(DataDescriptorIf dataDesc, java.lang.String sessionId, int languageId)
          Retrieve a number of orders for the customer referenced by the sessionId.
 int getOrderStatus(java.lang.String sessionId, int orderId)
          Get the order status for an order.
 OrderIf getOrderTotals(OrderIf order, int languageId)
          The order object is populated with an array of order totals.
 PaymentDetailsIf getPaymentDetails(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.
 PaymentDetailsIf getPaymentDetailsPerOrder(java.lang.String sessionId, java.lang.String moduleCode, OrderIf 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.
 PaymentDetailsIf getPaymentGateway(OrderIf 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.
 PaymentDetailsIf[] getPaymentGateways(OrderIf order, int languageId)
          Each payment module is called and asked to return a PaymentDetails object.
 PaymentScheduleIf getPaymentSchedule(int id)
          Returns the payment schedule object for the id parameter, or Null if the payment schedule object doesn't exist in the DB.
 PdfResultIf getPdf(java.lang.String sessionId, PdfOptionsIf options)
          Creates a PDF document.
 ProductIf getProduct(java.lang.String sessionId, int productId, int languageId)
          Returns a complete Product object for the given productId and language.
 ProductIf[] getProductNotificationsPerCustomer(java.lang.String sessionId, int languageId)
          Returns all products sorted by name, that the customer has asked to be notified about.
 ProductIf[] getProductNotificationsPerCustomerWithOptions(java.lang.String sessionId, int languageId, FetchProductOptionsIf options)
          An options object is passed in to customize from where some of the product attributes (such as price and quantity) are fetched from.
 ProductIf getProductPerSku(java.lang.String sessionId, java.lang.String sku, int languageId)
          Get a product from its SKU.
 ProductIf getProductPerSkuWithOptions(java.lang.String sessionId, java.lang.String sku, int languageId, FetchProductOptionsIf options)
          Get a product from its SKU.
 ProductQuantityIf getProductQuantity(java.lang.String encodedProductId)
          The stock level of the product and the date available are returned within a ProductQuantity object.
 ProductQuantityIf getProductQuantityWithOptions(java.lang.String encodedProductId, FetchProductOptionsIf options)
          The stock level of the product and the date available are returned within a ProductQuantity object.
 ProductIf[] getProductsFromIdsWithOptions(java.lang.String sessionId, DataDescriptorIf dataDesc, int[] prodIdArray, int languageId, FetchProductOptionsIf options)
          An array of products is returned that corresponds to an array of productIds passed in as a parameter.
 ProductsIf getProductsPerCategory(java.lang.String sessionId, DataDescriptorIf dataDesc, int categoryId, boolean searchInSubCats, int languageId)
          Returns a Products object for the given category and language.
 ProductsIf getProductsPerCategoryPerManufacturer(java.lang.String sessionId, DataDescriptorIf dataDesc, int categoryId, int manufacturerId, int languageId)
          Returns a Products object for the given category, language and manufacturer.
 ProductsIf getProductsPerCategoryPerManufacturerWithOptions(java.lang.String sessionId, DataDescriptorIf dataDesc, int categoryId, int manufacturerId, int languageId, FetchProductOptionsIf options)
          An options object is passed in to customize from where some of the product attributes (such as price and quantity) are fetched from.
 ProductsIf getProductsPerCategoryWithOptions(java.lang.String sessionId, DataDescriptorIf dataDesc, int categoryId, boolean searchInSubCats, int languageId, FetchProductOptionsIf options)
          An options object is passed in to customize from where some of the product attributes (such as price and quantity) are fetched from.
 ProductsIf getProductsPerManufacturer(java.lang.String sessionId, DataDescriptorIf dataDesc, int manufacturerId, int languageId)
          Returns a Products object for the given manufacturer and language.
 ProductsIf getProductsPerManufacturerWithOptions(java.lang.String sessionId, DataDescriptorIf dataDesc, int manufacturerId, int languageId, FetchProductOptionsIf options)
          An options object is passed in to customize from where some of the product attributes (such as price and quantity) are fetched from.
 ProductIf getProductWithOptions(java.lang.String sessionId, int productId, int languageId, FetchProductOptionsIf options)
          An options object is passed in to customize from where some of the product attributes (such as price and quantity) are fetched from.
 ProductIf[] getPromotionsPerProducts(java.lang.String sessionId, int customerId, ProductIf[] products, PromotionIf[] promotions, java.lang.String[] couponCodes, PromotionOptionsIf 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.
 ProductsIf getRelatedProducts(java.lang.String sessionId, DataDescriptorIf dataDesc, int productId, int relationType, int languageId)
          Find products related to the product defined by the productId parameter.
 ProductsIf getRelatedProductsWithOptions(java.lang.String sessionId, DataDescriptorIf dataDesc, int productId, int relationType, int languageId, FetchProductOptionsIf options)
          An options object is passed in to customize from where some of the product attributes (such as price and quantity) are fetched from.
 ReviewIf getReview(int reviewId)
          An review object is returned for the given reviewId.
 ReviewsIf getReviewsPerProduct(DataDescriptorIf dataDesc, int productId)
          An array of review objects is returned for the given productId.
 RewardPointsIf getRewardPoints(java.lang.String sessionId, DataDescriptorIf dataDesc)
          Gets an array of reward point objects for a customer identified by the sessionId parameter.
 java.lang.String getSecretKeyForOrderId(int orderId)
          A secret key is generated and stored in the database for the orderId passed as a parameter.
 ShippingQuoteIf getShippingQuote(OrderIf 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.
 ShippingQuoteIf[] getShippingQuotes(OrderIf order, int languageId)
          All active installed shipping modules are called in order to get an array of shipping quotes.
 java.lang.String getSku(OrderProductIf orderProd)
          Deprecated.  
 ProductsIf getSpecialsPerCategory(java.lang.String sessionId, DataDescriptorIf dataDesc, int categoryId, boolean searchInSubCats, int languageId)
          Returns all specials for the given categoryId and language.
 SSOTokenIf getSSOToken(java.lang.String secretKey, boolean deleteToken)
          Returns an SSOToken object for the secretKey (UUID).
 java.lang.String getStatusText(int statusId, int languageId)
          Returns the text of a status from the orders_status table.
 StoreIf getStore()
          Returns the store that this KonaKart engine is connected to.
 java.lang.String[] getStoreIds()
          Returns an array of strings containing the store ids for the stores being used in a multi-store / multi-database environment.
 SubscriptionIf[] getSubscriptionsPerCustomer(java.lang.String sessionId)
          Returns an array of Subscription objects for a customer referred to by the sessionId parameter.
 SuggestedSearchItemIf[] getSuggestedSearchItems(java.lang.String sessionId, SuggestedSearchOptionsIf options)
          An array of SuggestedSearchItems is returned for search text within the options parameter.
 TagIf getTag(int tagId, boolean getProdCount, int languageId)
          Returns a Tag object for the id passed in as a parameter.
 TagGroupIf getTagGroup(int tagGroupId, boolean getProdCount, int languageId)
          Returns a TagGroup object for the id passed in as a parameter.
 TagGroupIf[] getTagGroupsPerCategory(int categoryId, boolean getProdCount, int languageId)
          Return an array of TagGroup objects for a category.
 TagIf[] getTagsPerCategory(int categoryId, boolean getProdCount, int languageId)
          Return an array of Tag objects for a category.
 java.math.BigDecimal getTax(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(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()
          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.
 WishListIf getWishList(java.lang.String sessionId, int wishListId)
          Returns a WishList object not populated with an array of WishListItem objects.
 WishListItemsIf getWishListItems(java.lang.String sessionId, DataDescriptorIf dataDesc, int wishListId, int languageId)
          Returns a WishListItems object containing an array of items and the number of items returned.
 WishListItemsIf getWishListItemsWithOptions(java.lang.String sessionId, DataDescriptorIf dataDesc, int wishListId, int languageId, AddToWishListOptionsIf options)
          Returns a WishListItems object containing an array of items and the number of items returned.
 WishListIf getWishListWithItems(java.lang.String sessionId, int wishListId, int languageId)
          Returns a fully populated WishList object that may contain an array of WishListItem objects.
 WishListIf getWishListWithItemsWithOptions(java.lang.String sessionId, int wishListId, int languageId, AddToWishListOptionsIf options)
          If options is set to null, this method is identical to getWishListWithItems().
 WishListIf getWishListWithOptions(java.lang.String sessionId, int wishListId, AddToWishListOptionsIf options)
          Returns a WishList object not populated with an array of WishListItem objects.
 ZoneIf[] getZonesPerCountry(int countryId)
          Returns an array of Zone objects for the country referenced by the countryId.
 int insertBooking(java.lang.String sessionId, BookingIf booking, BookableProductOptionsIf options)
          Inserts a Booking object into the database.
 void insertCustomerEvent(CustomerEventIf event)
          The customer event is written to a queue and control is immediately returned to the caller.
 void insertCustomerTag(java.lang.String sessionId, CustomerTagIf tag)
          Assigns a customer tag to the customer referenced by the sessionId.
 void insertCustomerTagForGuest(int customerId, CustomerTagIf tag)
          Assigns a customer tag to the guest customer referenced by the customerId which must have a negative value.
 int insertDigitalDownload(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 insertSubscription(java.lang.String sessionId, SubscriptionIf subscription)
          A Subscription object is inserted into the database.
 boolean isEmailValid(java.lang.String emailAddr)
          Determines whether the eMail address is valid
 java.lang.String login(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 adminSession, int customerId)
          Used to log in to the application as a customer by an Administrator.
 void logout(java.lang.String sessionId)
          Logs out the user with the specified session Id.
 void mergeBaskets(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 sessionId, int customerFromId, AddToBasketOptionsIf options)
          Add all items from the basket of customerFrom to the basket of the customer associated to the sessionId.
 void mergeWishListsWithOptions(java.lang.String sessionId, int customerFromId, int languageId, AddToWishListOptionsIf options)
          Add all items from the wish list of customerFrom to the wish list of customerTo which is retrieved from the sessionId.
 int pointsAvailable(java.lang.String sessionId)
          Calculates the number of reward points available for the customer identified by the sessionId parameter.
 void postMessageToQueue(java.lang.String sessionId, MqOptionsIf options)
          Post a message to a specified queue.
 MqResponseIf readMessageFromQueue(java.lang.String sessionId, MqOptionsIf options)
          Read a single message from a specified queue.
 int registerCustomer(CustomerRegistrationIf 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 sessionId, int customerId)
          All Basket objects that exist for this customer are deleted.
 void removeFromBasket(java.lang.String sessionId, int customerId, BasketIf item)
          The Basket object is deleted.
 void removeFromWishList(java.lang.String sessionId, int wishListItemId)
          Remove the WishListItem object referenced by wishListItemId.
 void removeFromWishListWithOptions(java.lang.String sessionId, int wishListItemId, AddToWishListOptionsIf options)
          Remove the WishListItem object referenced by wishListItemId.
 int reservePoints(java.lang.String sessionId, int points)
          Removes a number of reward points from the total for the customer identified by the sessionId parameter.
 int saveIpnHistory(java.lang.String sessionId, IpnHistoryIf ipnHistory)
          A new IpnHistory (Instant Product Notification) record is created in the database.
 int saveOrder(java.lang.String sessionId, OrderIf order, int languageId)
          A new order is created in the DB.
 java.lang.String saveSSOToken(SSOTokenIf token)
          Saves the SSOToken in the database and returns a UUID secret key identifier.
 OrdersIf searchForOrdersPerCustomer(java.lang.String sessionId, DataDescriptorIf dataDesc, OrderSearchIf orderSearch, int languageId)
          Retrieve a number of orders for the customer referenced by the sessionId for the given language.
 ProductsIf searchForProducts(java.lang.String sessionId, DataDescriptorIf dataDesc, ProductSearchIf prodSearch, int languageId)
          Returns all products using the given language.
 ProductsIf searchForProductsWithOptions(java.lang.String sessionId, DataDescriptorIf dataDesc, ProductSearchIf prodSearch, int languageId, FetchProductOptionsIf options)
          An options object is passed in to customize from where some of the product attributes (such as price and quantity) are fetched from.
 WishListsIf searchForWishLists(java.lang.String sessionId, DataDescriptorIf dataDesc, CustomerSearchIf customerSearch)
          All wish lists matching the search criteria will be returned.
 ZoneIf[] searchForZones(ZoneSearchIf search)
          Search for zones using various search criteria
 void sendNewPassword(java.lang.String emailAddr, java.lang.String subject, java.lang.String countryCode)
          Deprecated.  
 EmailIf sendNewPassword1(java.lang.String emailAddr, EmailOptionsIf options)
          A mail is sent to emailAddr containing a new password.
 void sendOrderConfirmationEmail(java.lang.String sessionId, int orderId, java.lang.String mailSubject, int languageId)
          Deprecated.  
 EmailIf sendOrderConfirmationEmail1(java.lang.String sessionId, int orderId, int langIdForOrder, EmailOptionsIf options)
          A confirmation mail is sent after submitting an order.
 void sendTemplateEmailToCustomer(int customerId, java.lang.String templateName, java.lang.String message, java.lang.String countryCode)
          Deprecated.  
 EmailIf sendTemplateEmailToCustomer1(int customerId, java.lang.String message, EmailOptionsIf options)
          This method is used to send a template based eMail to a customer identified by the customerId.
 void sendWelcomeEmail(int customerId, java.lang.String mailSubject, java.lang.String countryCode)
          Deprecated.  
 EmailIf sendWelcomeEmail1(int customerId, EmailOptionsIf options)
          A welcome email is sent after registration of a new customer.
 void setCookie(KKCookieIf cookie)
          Saves the cookie in the database.
 void setCreditCardDetailsOnOrder(java.lang.String sessionId, int orderId, CreditCardIf card)
          The credit card details in the CreditCard object passed in as a parameter, are saved in the database for an existing order.
 void setDefaultAddressPerCustomer(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 wsEndpoint)
          Set the Web Service endpoint for the engine.
 void setRewardPointReservationId(java.lang.String sessionId, int orderId, int reservationId)
          Verifies that the order belongs to the customer identified by the sessionId parameter and then updates the reservation id on the order.
 void updateBasket(java.lang.String sessionId, int customerId, BasketIf item)
          Updates the Basket object in the database.
 void updateBasketWithOptions(java.lang.String sessionId, int customerId, BasketIf item, AddToBasketOptionsIf options)
          Updates the Basket object in the database.
 BasketIf[] updateBasketWithStockInfo(BasketIf[] basketItems)
          Receives an array of basket items and updates each one with the current stock level.
 BasketIf[] updateBasketWithStockInfoWithOptions(BasketIf[] basketItems, AddToBasketOptionsIf options)
          Receives an array of basket items and updates each one with the current stock level.
 void updateCachedConfigurations()
          Wherever in the engine any configurations have been cached, they are refreshed when this method is called.
 int updateDigitalDownloadCount(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 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 sessionId, int orderId)
          If the STOCK_LIMITED configuration variable is set to true, we subtract the products in stock by the product orders.
 void updateInventoryWithOptions(java.lang.String sessionId, int orderId, CreateOrderOptionsIf options)
          If options is set to null, this method is identical to updateInventory().
 void updateManufacturerViewedCount(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 updateProductViewedCount(int productId, int languageId)
          It updates the number of times that the product referenced by productId, has been viewed.
 int writeReview(java.lang.String sessionId, ReviewIf review)
          Receives all of the necessary parameters from the Review object to create a new review in the database.
 

Method Detail

getAllLanguages

LanguageIf[] getAllLanguages()
                             throws KKException
Returns an array of Language classes containing all of the languages that have been defined within the system.

Returns:
Array of Language objects
Throws:
KKException

getDefaultLanguage

LanguageIf getDefaultLanguage()
                              throws KKException
The default language is referenced by a configuration variable called DEFAULT_LANGUAGE. If this variable isn't set, then the method returns the language with the lowest sort order value. We assume that this language is the default language and will be used when no other language is specified.

Returns:
Returns a language object
Throws:
KKException

getLanguagePerCode

LanguageIf getLanguagePerCode(java.lang.String code)
                              throws KKException
Retrieves the language object referenced by the two letter code (i.e. en, de, es)

Parameters:
code - The two letter language code such as en, de, es etc.
Returns:
Returns a language object
Throws:
KKException

getLanguagePerId

LanguageIf getLanguagePerId(int languageId)
                            throws KKException
Retrieves the language object referenced by the id.

Parameters:
languageId - The numeric id of the language object
Returns:
Returns a language object
Throws:
KKException

getCategoryTree

CategoryIf[] getCategoryTree(int languageId,
                             boolean getNumProducts)
                             throws KKException
Returns a category tree structure consisting of an array of top level categories, each of which may contain an array of child categories.

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.

Parameters:
languageId - 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.
Returns:
Array of Category objects
Throws:
KKException

getProductsPerCategory

ProductsIf getProductsPerCategory(java.lang.String sessionId,
                                  DataDescriptorIf dataDesc,
                                  int categoryId,
                                  boolean searchInSubCats,
                                  int languageId)
                                  throws KKException
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 :

Parameters:
sessionId - The session id of the logged in user
dataDesc - Used to control the data offset, limit the number of items returned and set the sort order
categoryId - The numeric id of the category
searchInSubCats - Determines whether products are searched for in the sub-categories of the specified category
languageId - The id for the language that will be used. Value of -1 selects the default language.
Returns:
Returns a Products object
Throws:
KKException

getProductsPerCategoryWithOptions

ProductsIf getProductsPerCategoryWithOptions(java.lang.String sessionId,
                                             DataDescriptorIf dataDesc,
                                             int categoryId,
                                             boolean searchInSubCats,
                                             int languageId,
                                             FetchProductOptionsIf options)
                                             throws KKException
An options object is passed in to customize from where some of the product attributes (such as price and quantity) are fetched from. If options is set to null, then this call is identical to getProductsPerCategory().

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 :

Parameters:
sessionId - The session id of the logged in user
dataDesc - Used to control the data offset, limit the number of items returned and set the sort order
categoryId - The numeric id of the category
searchInSubCats - Determines whether products are searched for in the sub-categories of the specified category
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.
Returns:
Returns a Products object
Throws:
KKException

getProductsPerCategoryPerManufacturer

ProductsIf getProductsPerCategoryPerManufacturer(java.lang.String sessionId,
                                                 DataDescriptorIf dataDesc,
                                                 int categoryId,
                                                 int manufacturerId,
                                                 int languageId)
                                                 throws KKException
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 :

Parameters:
sessionId - The session id of the logged in user
dataDesc - Used to control the data offset, limit the number of items returned and set the sort order
categoryId - The numeric id of the category
languageId - The id for the language that will be used. Value of -1 selects the default language.
manufacturerId - The numeric id of the manufacturer
Returns:
Returns a Products object
Throws:
KKException

getProductsPerCategoryPerManufacturerWithOptions

ProductsIf getProductsPerCategoryPerManufacturerWithOptions(java.lang.String sessionId,
                                                            DataDescriptorIf dataDesc,
                                                            int categoryId,
                                                            int manufacturerId,
                                                            int languageId,
                                                            FetchProductOptionsIf options)
                                                            throws KKException
An options object is passed in to customize from where some of the product attributes (such as price and quantity) are fetched from. If options is set to null, then this call is identical to getProductsPerCategoryPerManufacture().

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 :

Parameters:
sessionId - The session id of the logged in user
dataDesc - Used to control the data offset, limit the number of items returned and set the sort order
categoryId - The numeric id of the category
languageId - The id for the language that will be used. Value of -1 selects the default language.
manufacturerId - The numeric id of the manufacturer
options - An object containing options for the method. It may be set to null.
Returns:
Returns a Products object
Throws:
KKException

getProductsPerManufacturer

ProductsIf getProductsPerManufacturer(java.lang.String sessionId,
                                      DataDescriptorIf dataDesc,
                                      int manufacturerId,
                                      int languageId)
                                      throws KKException
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 :

Parameters:
sessionId - The session id of the logged in user
dataDesc - Used to control the data offset, limit the number of items returned and set the sort order
manufacturerId - The numeric id of the manufacturer
languageId - The id for the language that will be used. Value of -1 selects the default language.
Returns:
Returns a Products object
Throws:
KKException

getProductsPerManufacturerWithOptions

ProductsIf getProductsPerManufacturerWithOptions(java.lang.String sessionId,
                                                 DataDescriptorIf dataDesc,
                                                 int manufacturerId,
                                                 int languageId,
                                                 FetchProductOptionsIf options)
                                                 throws KKException
An options object is passed in to customize from where some of the product attributes (such as price and quantity) are fetched from. If options is set to null, then this call is identical to getProductsPerManufacturer().

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 :

Parameters:
sessionId - The session id of the logged in user
dataDesc - Used to control the data offset, limit the number of items returned and set the sort order
manufacturerId - The numeric id of the manufacturer
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.
Returns:
Returns a Products object
Throws:
KKException

getProduct

ProductIf getProduct(java.lang.String sessionId,
                     int productId,
                     int languageId)
                     throws KKException
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.

Parameters:
sessionId - The session id of the logged in user
productId - The numeric id of the product
languageId - The id for the language that will be used. Value of -1 selects the default language.
Returns:
A Product object
Throws:
KKException

getProductWithOptions

ProductIf getProductWithOptions(java.lang.String sessionId,
                                int productId,
                                int languageId,
                                FetchProductOptionsIf options)
                                throws KKException
An options object is passed in to customize from where some of the product attributes (such as price and quantity) are fetched from. If options is set to null, then this call is identical to getProduct().

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.

Parameters:
sessionId - The session id of the logged in user
productId - The numeric id of the product
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.
Returns:
A Product object
Throws:
KKException

getCategoriesPerManufacturer

CategoryIf[] getCategoriesPerManufacturer(int manufacturerId,
                                          int languageId)
                                          throws KKException
Returns an array of leaf Category objects for the given manufacturer.

Parameters:
manufacturerId - The numeric id of the manufacturer
languageId - The id for the language that will be used. Value of -1 selects the default language.
Returns:
Array of Category objects
Throws:
KKException

getCategoriesPerProduct

CategoryIf[] getCategoriesPerProduct(int productId,
                                     int languageId)
                                     throws KKException
Returns an array of Category objects for the given product.

Parameters:
productId - The numeric id of the product
languageId - The id for the language that will be used. Value of -1 selects the default language.
Returns:
Array of Category objects
Throws:
KKException

getManufacturersPerCategory

ManufacturerIf[] getManufacturersPerCategory(int categoryId)
                                             throws KKException
Returns an array of Manufacturer objects for the given category. They are sorted by name.

The Manufacturer objects are not complete. Only the name and the image are returned and these are language independent.

Parameters:
categoryId - The numeric id of the category
Returns:
Array of Manufacturer objects
Throws:
KKException

getAllManufacturers

ManufacturerIf[] getAllManufacturers()
                                     throws KKException
Returns an array of Manufacturer objects for all of the manufacturers in the system. They are sorted by name.

The Manufacturer objects are not complete. Only the name and the image and custom fields 1 and 2 are returned, and these are language independent.

Returns:
Array of Manufacturer objects
Throws:
KKException

getManufacturerPerProduct

ManufacturerIf getManufacturerPerProduct(int productId,
                                         int languageId)
                                         throws KKException
Returns a complete Manufacturer object for the given productId and language.

Parameters:
productId - The numeric id of the product
languageId - The id for the language that will be used. Value of -1 selects the default language.
Returns:
Manufacturer object
Throws:
KKException

getManufacturer

ManufacturerIf getManufacturer(int manufacturerId,
                               int languageId)
                               throws KKException
Returns a complete Manufacturer object for the given manufacturerId and language.

Parameters:
manufacturerId - The numeric id of the manufacturer
languageId - The id for the language that will be used. Value of -1 selects the default language.
Returns:
Manufacturer object
Throws:
KKException

getCategory

CategoryIf getCategory(int categoryId,
                       int languageId)
                       throws KKException
Returns a complete single Category object for the given categoryId and language. It does not populate the children even if they exist. It does populate the MiscItem array.

Parameters:
categoryId - The numeric id of the category
languageId - The id for the language that will be used. Value of -1 selects the default language.
Returns:
Category object
Throws:
KKException

getSpecialsPerCategory

ProductsIf getSpecialsPerCategory(java.lang.String sessionId,
                                  DataDescriptorIf dataDesc,
                                  int categoryId,
                                  boolean searchInSubCats,
                                  int languageId)
                                  throws KKException
Returns all specials for the given 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 :

Parameters:
sessionId - The session id of the logged in user
dataDesc - Used to control the data offset, limit the number of items returned and set the sort order
categoryId - The numeric id of the category
searchInSubCats - Determines whether products are searched for in the sub-categories of the specified category
languageId - The id for the language that will be used. Value of -1 selects the default language.
Returns:
Returns a Products object
Throws:
KKException

getAllSpecials

ProductsIf getAllSpecials(java.lang.String sessionId,
                          DataDescriptorIf dataDesc,
                          int languageId)
                          throws KKException
Returns all specials 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 :

Parameters:
sessionId - The session id of the logged in user
dataDesc - Used to control the data offset, limit the number of items returned and set the sort order
languageId - The id for the language that will be used. Value of -1 selects the default language.
Returns:
Returns a Products object
Throws:
KKException

getAllProducts

ProductsIf getAllProducts(java.lang.String sessionId,
                          DataDescriptorIf dataDesc,
                          int languageId)
                          throws KKException
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 :

Parameters:
sessionId - The session id of the logged in user
dataDesc - Used to control the data offset, limit the number of items returned and set the sort order
languageId - The id for the language that will be used. Value of -1 selects the default language.
Returns:
Returns a Products object
Throws:
KKException

getAllProductsWithOptions

ProductsIf getAllProductsWithOptions(java.lang.String sessionId,
                                     DataDescriptorIf dataDesc,
                                     int languageId,
                                     FetchProductOptionsIf options)
                                     throws KKException
An options object is passed in to customize from where some of the product attributes (such as price and quantity) are fetched from. If options is set to null, then this call is identical to getAllProducts().

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 :

Parameters:
sessionId - The session id of the logged in user
dataDesc - Used to control the data offset, limit the number of items returned and set the sort order
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.
Returns:
Returns a Products object
Throws:
KKException

getReviewsPerProduct

ReviewsIf getReviewsPerProduct(DataDescriptorIf dataDesc,
                               int productId)
                               throws KKException
An array of review objects is returned for the given 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 :

Parameters:
dataDesc - Used to control the data offset, limit the number of items returned and set the sort order
productId - The numeric id of the product
Returns:
Return a Reviews object
Throws:
KKException

getReview

ReviewIf getReview(int reviewId)
                   throws KKException
An review object is returned for the given reviewId. The averageRating attribute of the review is calculated and set by the method.

Parameters:
reviewId - The numeric id of the review
Returns:
Return a Review object
Throws:
KKException

getAllReviews

ReviewsIf getAllReviews(DataDescriptorIf dataDesc)
                        throws KKException
An array of review objects is returned. 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 :

Parameters:
dataDesc - Used to control the data offset, limit the number of items returned and set the sort order
Returns:
Return a Reviews object
Throws:
KKException

searchForProducts

ProductsIf searchForProducts(java.lang.String sessionId,
                             DataDescriptorIf dataDesc,
                             ProductSearchIf prodSearch,
                             int languageId)
                             throws KKException
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 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 :

Parameters:
sessionId - The session id of the logged in user
dataDesc - Used to control the data offset, limit the number of items returned and set the sort order
prodSearch - Contains information used to search the catalog for a product
languageId - The id for the language that will be used. Value of -1 selects the default language.
Returns:
Returns a Products object
Throws:
KKException

searchForProductsWithOptions

ProductsIf searchForProductsWithOptions(java.lang.String sessionId,
                                        DataDescriptorIf dataDesc,
                                        ProductSearchIf prodSearch,
                                        int languageId,
                                        FetchProductOptionsIf options)
                                        throws KKException
An options object is passed in to customize from where some of the product attributes (such as price and quantity) are fetched from. If options is set to null, then this call is identical to searchForProducts().

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 :

Parameters:
sessionId - The session id of the logged in user
dataDesc - Used to control the data offset, limit the number of items returned and set the sort order
prodSearch - Contains information used to search the catalog for a product
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.
Returns:
Returns a Products object
Throws:
KKException

registerCustomer

int registerCustomer(CustomerRegistrationIf custReg)
                     throws KKException
Receives all of the necessary parameters from the Customer Registration object to create a new customer in the database. If the customer has already registered, an exception is thrown

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.

Parameters:
custReg - Contains all the required data in order to register a new customer
Returns:
Id of the customer that was created.
Throws:
KKException

forceRegisterCustomer

int forceRegisterCustomer(CustomerRegistrationIf custReg)
                          throws KKException
This API Call is used rather than 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 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.

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.

Parameters:
custReg - Contains all the required data in order to register a new customer
Returns:
Id of the customer that was created.
Throws:
KKException

getAllCountries

CountryIf[] getAllCountries()
                            throws KKException
Returns an array of Country objects for all of the countries in the system. They are sorted by name. This method is used to create the drop list of countries during the customer registration process.

Returns:
Array of Country objects
Throws:
KKException

login

java.lang.String login(java.lang.String emailAddr,
                       java.lang.String password)
                       throws KKException
Returns a 16 byte long session key is the login is successful, otherwise it returns null.

Parameters:
emailAddr - The user name required to log in
password - The log in password
Returns:
sessionId The sessionId which must be used in subsequent API calls to identify the user
Throws:
KKException

logout

void logout(java.lang.String sessionId)
            throws KKException
Logs out the user with the specified session Id.

Parameters:
sessionId - The session Id of the logged in user
Throws:
KKException

getAddressesPerCustomer

AddressIf[] getAddressesPerCustomer(java.lang.String sessionId)
                                    throws KKException
Returns all of the addresses registered for the given customer. An exception is thrown if the sessionId isn't valid.

Parameters:
sessionId - The session id of the logged in user
Returns:
An array of address objects where the first one is the primary address. Returns an empty array if no addresses exist.
Throws:
KKException

getAddressesPerManufacturer

AddressIf[] getAddressesPerManufacturer(int manufacturerId)
                                        throws KKException
Gets an array of Address objects that have been defined for the manufacturer referenced by the manufacturerId.

Parameters:
manufacturerId -
Returns:
Returns an array of Address objects. Returns an empty array if no addresses exist.
Throws:
KKException

getAddressesPerProduct

AddressIf[] getAddressesPerProduct(int productId)
                                   throws KKException
Gets an array of Address objects that have been defined for the product referenced by the productId. The primary address(es) are first in the list.

Parameters:
productId -
Returns:
Returns an array of Address objects. Returns an empty array if no addresses exist.
Throws:
KKException

getDefaultAddressPerCustomer

AddressIf getDefaultAddressPerCustomer(java.lang.String sessionId)
                                       throws KKException
Returns the default address for the given customer. An exception is thrown if the sessionId isn't valid.

Parameters:
sessionId - The session id of the logged in user
Returns:
An address object or null if it doesn't exist.
Throws:
KKException

setDefaultAddressPerCustomer

void setDefaultAddressPerCustomer(java.lang.String sessionId,
                                  int addressId)
                                  throws KKException
Sets the default address for this customer to be the address identified by 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.

Parameters:
sessionId - The session id of the logged in user
addressId - The numeric id of the address object
Throws:
KKException

addAddressToCustomer

int addAddressToCustomer(java.lang.String sessionId,
                         AddressIf addr)
                         throws KKException
The Address object is added to the customer defined by the 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.

Parameters:
sessionId - The session id of the logged in user
addr - The address object which will be added to the customer
Returns:
Id of the new address object. A negative return value indicates an error.
Throws:
KKException

deleteAddressFromCustomer

void deleteAddressFromCustomer(java.lang.String sessionId,
                               int addressId)
                               throws KKException
The address defined by the 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.

Parameters:
sessionId - The session id of the logged in user
addressId - The numeric id of the address object
Throws:
KKException

editCustomerAddress

void editCustomerAddress(java.lang.String sessionId,
                         AddressIf addr)
                         throws KKException
The Address object will replace the existing address object in the database with the same id. A check is made to verify that the address object belongs to the customer logged in with the 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.

Parameters:
sessionId - The session id of the logged in user
addr - The address object to edit
Throws:
KKException

getCustomer

CustomerIf getCustomer(java.lang.String sessionId)
                       throws KKException
Returns the customer object for the customer defined by the given sessionId. Throws an exception if the session has expired.

Parameters:
sessionId - The session id of the logged in user
Returns:
Customer Object or Null if the customer doesn't exist.
Throws:
KKException

editCustomer

void editCustomer(java.lang.String sessionId,
                  CustomerIf cust)
                  throws KKException
The Customer object will replace the existing customer object in the database. 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 :

Parameters:
sessionId - The session id of the logged in user
cust - The customer object to edit
Throws:
KKException

getKonakartTimeStamp

java.util.Calendar getKonakartTimeStamp()
                                        throws KKException
Get a Date Time Stamp from the server

Returns:
Calendar
Throws:
KKException

writeReview

int writeReview(java.lang.String sessionId,
                ReviewIf review)
                throws KKException
Receives all of the necessary parameters from the Review object to create a new review in the database. The new review is associated to the customer logged in with sessionId.

The obligatory parameters are :

Parameters:
sessionId - The session id of the logged in user
review - The review that will be inserted
Returns:
Id of the review that was created.
Throws:
KKException

checkSession

int checkSession(java.lang.String sessionId)
                 throws KKException
The given 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.

Parameters:
sessionId - The session id of the logged in user
Returns:
Returns customerId of customer pointed to by session
Throws:
KKException

addToBasket

int addToBasket(java.lang.String sessionId,
                int customerId,
                BasketIf item)
                throws KKException
Saves the Basket object in the database for a customer. If the Basket object already exists with exactly the same options etc, then we just increase the quantity of the existing object.

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.

Parameters:
sessionId - The session id of the logged in user
customerId - The numeric id of the customer
item - The basket item to add to the basket
Returns:
Returns the id of the newly created Basket object
Throws:
KKException

addToBasketWithOptions

int addToBasketWithOptions(java.lang.String sessionId,
                           int customerId,
                           BasketIf item,
                           AddToBasketOptionsIf options)
                           throws KKException
If 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.

Parameters:
sessionId - The session id of the logged in user
customerId - The numeric id of the customer
item - The basket item to add to the basket
options - An object containing options for the method. It may be set to null.
Returns:
Returns the id of the newly created Basket object
Throws:
KKException

mergeBaskets

void mergeBaskets(java.lang.String sessionId,
                  int customerFromId)
                  throws KKException
Add all items from the basket of customerFrom to the basket of the customer associated to the 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.

Parameters:
sessionId - The session id of the logged in user
customerFromId - The numeric id of the customer that has the temporary basket
Throws:
KKException

mergeBasketsWithOptions

void mergeBasketsWithOptions(java.lang.String sessionId,
                             int customerFromId,
                             AddToBasketOptionsIf options)
                             throws KKException
Add all items from the basket of customerFrom to the basket of the customer associated to the 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.

Parameters:
sessionId - The session id of the logged in user
customerFromId - The numeric id of the customer that has the temporary basket
options - An object containing options for the method. It may be set to null.
Throws:
KKException

updateBasket

void updateBasket(java.lang.String sessionId,
                  int customerId,
                  BasketIf item)
                  throws KKException
Updates the Basket object in the database.

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.

Parameters:
sessionId - The session id of the logged in user
customerId - The numeric id of the customer
item - The basket item to update
Throws:
KKException

updateBasketWithOptions

void updateBasketWithOptions(java.lang.String sessionId,
                             int customerId,
                             BasketIf item,
                             AddToBasketOptionsIf options)
                             throws KKException
Updates the Basket object in the database.

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.

Parameters:
sessionId - The session id of the logged in user
customerId - The numeric id of the customer
item - The basket item to update
options - An object containing options for the method. It may be set to null.
Throws:
KKException

removeFromBasket

void removeFromBasket(java.lang.String sessionId,
                      int customerId,
                      BasketIf item)
                      throws KKException
The Basket object is deleted.

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.

Parameters:
sessionId - The session id of the logged in user
customerId - The numeric id of the customer
item - The basket item to delete
Throws:
KKException

removeBasketItemsPerCustomer

void removeBasketItemsPerCustomer(java.lang.String sessionId,
                                  int customerId)
                                  throws KKException
All Basket objects that exist for this customer are deleted.

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.

Parameters:
sessionId - The session id of the logged in user
customerId - The numeric id of the customer
Throws:
KKException

getBasketItemsPerCustomer

BasketIf[] getBasketItemsPerCustomer(java.lang.String sessionId,
                                     int customerId,
                                     int languageId)
                                     throws KKException
Get the basket items for a customer and language.

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.

Parameters:
sessionId - The session id of the logged in user
customerId - The numeric id of the customer
languageId - The id for the language that will be used. Value of -1 selects the default language.
Returns:
Returns an array of Basket objects
Throws:
KKException

getBasketItemsPerCustomerWithOptions

BasketIf[] getBasketItemsPerCustomerWithOptions(java.lang.String sessionId,
                                                int customerId,
                                                int languageId,
                                                AddToBasketOptionsIf options)
                                                throws KKException
Get the basket items for a customer and language. 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.

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.

Parameters:
sessionId - The session id of the logged in user
customerId - The numeric id of the customer
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.
Returns:
Returns an array of Basket objects
Throws:
KKException

getDefaultCurrency

CurrencyIf getDefaultCurrency()
                              throws KKException
The default currency is referenced by a configuration variable called DEFAULT_CURRENCY. If this isn't found then we return the currency in the currency table with the lowest id.

Returns:
Returns a currency object
Throws:
KKException

getAllCurrencies

CurrencyIf[] getAllCurrencies()
                              throws KKException
Returns an array of currency objects for all the records in the currencies table.

Returns:
Returns an array of currency objects
Throws:
KKException

getConfigurations

KKConfigurationIf[] getConfigurations()
                                      throws KKException
Returns an array of Configuration objects containing all configurations that have been defined in the system.

Returns:
An array of Configuration objects.
Throws:
KKException

getConfiguration

KKConfigurationIf getConfiguration(java.lang.String key)
                                   throws KKException
Returns a Configuration object referenced by the key passed in as a parameter

Parameters:
key - The key of the configuration object
Returns:
A Configuration object
Throws:
KKException

getConfigurationValue

java.lang.String getConfigurationValue(java.lang.String key)
                                       throws KKException
Returns a Configuration Value referenced by the key passed in as a parameter

Parameters:
key - The key of the configuration object
Returns:
A Configuration Value or null if the key does not exist
Throws:
KKException

getConfigurationValueAsInt

int getConfigurationValueAsInt(java.lang.String key)
                               throws KKException
Returns a Configuration Value as an integer for the key passed in as a parameter

Parameters:
key - the Configuration Key
Returns:
A Configuration Value as an integer or KKConstants.NOT_SET if the key isn't found.
Throws:
KKException - if there is a problem converting the configuration value into an integer.

getConfigurationValueAsIntWithDefault

int getConfigurationValueAsIntWithDefault(java.lang.String key,
                                          int def)
                                          throws KKException
Returns a Configuration Value as an integer for the key passed in as a parameter

Parameters:
key - the Configuration Key
def - default value to return if the key isn't found.
Returns:
A Configuration Value as an integer or the default value if the key isn't found.
Throws:
KKException - if there is a problem converting the configuration value into an integer.

getConfigurationValueAsBigDecimal

java.math.BigDecimal getConfigurationValueAsBigDecimal(java.lang.String key)
                                                       throws KKException
Returns a Configuration Value as a BigDecimal for the key passed in as a parameter

Parameters:
key - the Configuration Key
Returns:
A Configuration Value as a BigDecimal or null if the key isn't found.
Throws:
KKException - if there is a problem converting the configuration value into a BigDecimal.

getConfigurationValueAsBigDecimalWithDefault

java.math.BigDecimal getConfigurationValueAsBigDecimalWithDefault(java.lang.String key,
                                                                  java.math.BigDecimal def)
                                                                  throws KKException
Returns a Configuration Value as a BigDecimal for the key passed in as a parameter

Parameters:
key - the Configuration Key
def - default value to use if the key doesn't exist.
Returns:
A Configuration Value as a BigDecimal or the default value if the key isn't found.
Throws:
KKException - if there is a problem converting the configuration value into a BigDecimal.

getConfigurationValueAsBool

java.lang.Boolean getConfigurationValueAsBool(java.lang.String key,
                                              java.lang.Boolean def)
                                              throws KKException
Returns a Configuration Value as a Boolean for the key passed in as a parameter

Parameters:
key - the Configuration Key
def - the default value to be returned if there's a problem
Returns:
A Configuration Value as a Boolean or the default value if the key isn't found.
Throws:
KKException

editConfiguration

void editConfiguration(java.lang.String key,
                       java.lang.String value)
                       throws KKException
Edits an existing configuration. Throws an exception if the configuration doesn't exist.

Parameters:
key - The key of the configuration object
value - The new value for the configuration
Throws:
KKException

changePassword

void changePassword(java.lang.String sessionId,
                    java.lang.String currentPassword,
                    java.lang.String newPassword)
                    throws KKException
Ensures that the current password is correct, and then changes it to the new password. It allows any password length and relies on the application to ensure that a minimum length is guaranteed. Throws an exception if the currentPassword doesn't match.

Parameters:
sessionId - The session id of the logged in user
currentPassword - The current password of the logged in user
newPassword - The new password of the logged in user
Throws:
KKException

getProductNotificationsPerCustomer

ProductIf[] getProductNotificationsPerCustomer(java.lang.String sessionId,
                                               int languageId)
                                               throws KKException
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.

Parameters:
sessionId - The session id of the logged in user
languageId - The id for the language that will be used. Value of -1 selects the default language.
Returns:
Returns a Product array
Throws:
KKException

getProductNotificationsPerCustomerWithOptions

ProductIf[] getProductNotificationsPerCustomerWithOptions(java.lang.String sessionId,
                                                          int languageId,
                                                          FetchProductOptionsIf options)
                                                          throws KKException
An options object is passed in to customize from where some of the product attributes (such as price and quantity) are fetched from. If options is set to null, then this call is identical to getProductNotificationsPerCustomer().

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.

Parameters:
sessionId - The session id of the logged in user
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.
Returns:
Returns a Product array
Throws:
KKException

addProductNotificationToCustomer

void addProductNotificationToCustomer(java.lang.String sessionId,
                                      int productId)
                                      throws KKException
Adds a product notification to the list of notifications for the customer. An exception is thrown if the sessionId isn't valid.

Parameters:
sessionId - The session id of the logged in user
productId - The numeric id of the product
Throws:
KKException

deleteProductNotificationFromCustomer

void deleteProductNotificationFromCustomer(java.lang.String sessionId,
                                           int productId)
                                           throws KKException
Deletes a product notification from the list of notifications for the customer. An exception is thrown if the sessionId isn't valid.

Parameters:
sessionId - The session id of the logged in user
productId - The numeric id of the product
Throws:
KKException

updateProductViewedCount

void updateProductViewedCount(int productId,
                              int languageId)
                              throws KKException
It updates the number of times that the product referenced by 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.

Parameters:
productId - The numeric id of the product
languageId - The id for the language that will be used. Value of -1 selects the default language.
Throws:
KKException

getBestSellers

ProductIf[] getBestSellers(DataDescriptorIf dataDesc,
                           int categoryId,
                           int languageId)
                           throws KKException
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.

Parameters:
dataDesc - Used to control the data offset, limit the number of items returned and set the sort order
categoryId - The numeric id of the category
languageId - The id for the language that will be used. Value of -1 selects the default language.
Returns:
An array of products
Throws:
KKException

getBestSellersWithOptions

ProductIf[] getBestSellersWithOptions(DataDescriptorIf dataDesc,
                                      int categoryId,
                                      int languageId,
                                      FetchProductOptionsIf options)
                                      throws KKException
An options object is passed in to customize from where some of the product attributes (such as price and quantity) are fetched from. If options is set to null, then this call is identical to getBestSellers().

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.

Parameters:
dataDesc - Used to control the data offset, limit the number of items returned and set the sort order
categoryId - The numeric id of the category
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.
Returns:
An array of products
Throws:
KKException

getOrdersPerCustomer

OrdersIf getOrdersPerCustomer(DataDescriptorIf dataDesc,
                              java.lang.String sessionId,
                              int languageId)
                              throws KKException
Retrieve a number of orders for the customer referenced by the 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.

Parameters:
dataDesc - Used to control the data offset, limit the number of items returned and set the sort order
sessionId - The session id of the logged in user
languageId - The id for the language that will be used. Value of -1 selects the default language.
Returns:
An Orders object
Throws:
KKException

searchForOrdersPerCustomer

OrdersIf searchForOrdersPerCustomer(java.lang.String sessionId,
                                    DataDescriptorIf dataDesc,
                                    OrderSearchIf orderSearch,
                                    int languageId)
                                    throws KKException
Retrieve a number of orders for the customer referenced by the 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 :

Parameters:
sessionId - The session id of the logged in user
dataDesc - Used to control the data offset, limit the number of items returned and set the sort order
orderSearch - Contains information used to add serach constraints
languageId - The id for the language that will be used. Value of -1 selects the default language.
Returns:
An Orders object
Throws:
KKException

getOrder

OrderIf getOrder(java.lang.String sessionId,
                 int orderId,
                 int languageId)
                 throws KKException
Gets on order with the specified order Id, for the customer referenced by the sessionId.

Parameters:
sessionId - The session id of the logged in user
orderId - The numeric id of the order
languageId - The id for the language that will be used. Value of -1 selects the default language.
Returns:
An order object
Throws:
KKException

getCurrency

CurrencyIf getCurrency(java.lang.String currencyCode)
                       throws KKException
Returns the currency referenced by currencyCode.

Parameters:
currencyCode - The 3 letter currency code (i.e. USD, EUR ..)
Returns:
Returns a currency object
Throws:
KKException

createOrder

OrderIf createOrder(java.lang.String sessionId,
                    BasketIf[] basketItemArray,
                    int languageId)
                    throws KKException
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.

Parameters:
sessionId - The session id of the logged in user
basketItemArray - The array of basket items to add to the order
languageId - The id for the language that will be used. Value of -1 selects the default language.
Returns:
Order object
Throws:
KKException

createOrderWithOptions

OrderIf createOrderWithOptions(java.lang.String sessionId,
                               BasketIf[] basketItemArray,
                               CreateOrderOptionsIf options,
                               int languageId)
                               throws KKException
If 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 seesionId 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.

Parameters:
sessionId - The session id of the logged in user
basketItemArray - The array of basket items to add to the order
options - 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.
Returns:
Order object
Throws:
KKException

getOrderHistory

ProductIf[] getOrderHistory(DataDescriptorIf dataDesc,
                            java.lang.String sessionId,
                            int languageId)
                            throws KKException
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".

Parameters:
dataDesc - Used to control the data offset, limit the number of items returned and set the sort order
sessionId - The session id of the logged in user
languageId - The id for the language that will be used. Value of -1 selects the default language.
Returns:
Returns an array of products
Throws:
KKException

getOrderHistoryWithOptions

ProductIf[] getOrderHistoryWithOptions(DataDescriptorIf dataDesc,
                                       java.lang.String sessionId,
                                       int languageId,
                                       FetchProductOptionsIf options)
                                       throws KKException
An options object is passed in to customize from where some of the product attributes (such as price and quantity) are fetched from. If options is set to null, then this call is identical to getOrderHistory().

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".

Parameters:
dataDesc - Used to control the data offset, limit the number of items returned and set the sort order
sessionId - The session id of the logged in user
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.
Returns:
Returns an array of products
Throws:
KKException

getAlsoPurchased

ProductIf[] getAlsoPurchased(java.lang.String sessionId,
                             DataDescriptorIf dataDesc,
                             int productId,
                             int languageId)
                             throws KKException
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.

Parameters:
sessionId - The session id of the logged in user
dataDesc - Used to control the data offset, limit the number of items returned and set the sort order
productId - The numeric id of the product
languageId - The id for the language that will be used. Value of -1 selects the default language.
Returns:
Returns an array of products
Throws:
KKException

getAlsoPurchasedWithOptions

ProductIf[] getAlsoPurchasedWithOptions(java.lang.String sessionId,
                                        DataDescriptorIf dataDesc,
                                        int productId,
                                        int languageId,
                                        FetchProductOptionsIf options)
                                        throws KKException
An options object is passed in to customize from where some of the product attributes (such as price and quantity) are fetched from. If options is set to null, then this call is identical to getAlsoPurchased().

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.

Parameters:
sessionId - The session id of the logged in user
dataDesc - Used to control the data offset, limit the number of items returned and set the sort order
productId - The numeric id of the product
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.
Returns:
Returns an array of products
Throws:
KKException

getRelatedProducts

ProductsIf getRelatedProducts(java.lang.String sessionId,
                              DataDescriptorIf dataDesc,
                              int productId,
                              int relationType,
                              int languageId)
                              throws KKException
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.

Parameters:
sessionId - The session id of the logged in user
dataDesc - 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, the products are ordered by the ProductId and the offset is set to zero.
productId - The numeric id of the product
relationType - 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.
Returns:
Array of products
Throws:
KKException

getRelatedProductsWithOptions

ProductsIf getRelatedProductsWithOptions(java.lang.String sessionId,
                                         DataDescriptorIf dataDesc,
                                         int productId,
                                         int relationType,
                                         int languageId,
                                         FetchProductOptionsIf options)
                                         throws KKException
An options object is passed in to customize from where some of the product attributes (such as price and quantity) are fetched from. If options is set to null, then this call is identical to getRelatedProducts().

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.

Parameters:
sessionId - The session id of the logged in user
dataDesc - 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, the products are ordered by the ProductId and the offset is set to zero.
productId - The numeric id of the product
relationType - 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.
Returns:
Array of products
Throws:
KKException

getCountryPerName

CountryIf getCountryPerName(java.lang.String countryName)
                            throws KKException
Returns the country object for the 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.

Parameters:
countryName - The name of the country
Returns:
Returns a country object
Throws:
KKException

getCountry

CountryIf getCountry(int countryId)
                     throws KKException
Returns the country object for the countryId, or null if the country doesn't exist in the DB.

Parameters:
countryId - The id of the country object
Returns:
Returns a country object
Throws:
KKException

getShippingQuotes

ShippingQuoteIf[] getShippingQuotes(OrderIf order,
                                    int languageId)
                                    throws KKException
All active installed shipping modules are called in order to get an array of shipping quotes. This is normally called to display a selection of quotes to the customer during the checkout process.

Parameters:
order - The order object
languageId - The id for the language that will be used. Value of -1 selects the default language.
Returns:
Returns an array of shipping quotes
Throws:
KKException

getShippingQuote

ShippingQuoteIf getShippingQuote(OrderIf order,
                                 java.lang.String moduleName,
                                 int languageId)
                                 throws KKException
The shipping module called 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.

Parameters:
order - The order object
moduleName - 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.
Returns:
Return a shipping quote
Throws:
KKException

changeDeliveryAddress

OrderIf changeDeliveryAddress(java.lang.String sessionId,
                              OrderIf order,
                              AddressIf deliveryAddress)
                              throws KKException
The delivery address of the order is changed and the tax rates for the various products within the order are re-calculated.

Parameters:
sessionId - The session id of the logged in user
order - The order object
deliveryAddress - The address object containing the delivery address
Returns:
Returns an order with modified delivery address
Throws:
KKException

getTaxRate

java.math.BigDecimal getTaxRate(int countryId,
                                int zoneId,
                                int taxClassId)
                                throws KKException
Calculates the tax rate for a product with a taxClassId delivered to a country ( countryId) and zone (zoneId). There may be multiple tax rates which are added and / or compounded as appropriate.

Parameters:
countryId - The numeric id of the country
zoneId - The numeric id of the zone
taxClassId - The numeric id of the taxClass
Returns:
Returns the tax rate
Throws:
KKException

getTax

java.math.BigDecimal getTax(java.math.BigDecimal cost,
                            int countryId,
                            int zoneId,
                            int taxClassId)
                            throws KKException
Calculates the tax for a product with a taxClassId and cost, delivered to a country (countryId) and zone (zoneId).

Parameters:
cost - The cost of the product
countryId - The numeric id of the country
zoneId - The numeric id of the zone
taxClassId - The numeric id of the taxClass
Returns:
Returns the tax amount
Throws:
KKException

addTax

java.math.BigDecimal addTax(java.math.BigDecimal cost,
                            int countryId,
                            int zoneId,
                            int taxClassId)
                            throws KKException
Calculates the final cost (including tax) for a product with a certain taxClassId and cost, delivered to a country (countryId ) and zone (zoneId).

Parameters:
cost - The cost of the product
countryId - The numeric id of the country
zoneId - The numeric id of the zone
taxClassId - The numeric id of the taxClass
Returns:
Returns the cost inclusive of tax
Throws:
KKException

getOrderTotals

OrderIf getOrderTotals(OrderIf order,
                       int languageId)
                       throws KKException
The order object is populated with an array of order totals. The order totals depend on the order total modules installed.

Parameters:
order - The order object
languageId - The id for the language that will be used. Value of -1 selects the default language.
Returns:
An order object
Throws:
KKException

getPaymentGateways

PaymentDetailsIf[] getPaymentGateways(OrderIf order,
                                      int languageId)
                                      throws KKException
Each payment module is called and asked to return a PaymentDetails object. This method is called during the checkout process before the order has been saved and confirmed by the user. Therefore it does not compile the exact details for the payment (i.e. the parameters passed to a payment gateway) since this will be done later for the selected payment module. The returned PaymentDetails object contains the information required for the user to select it.

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.

Parameters:
order - The order object
languageId - The id for the language that will be used. Value of -1 selects the default language.
Returns:
Return an array of PaymentDetail objects
Throws:
KKException

getPaymentGateway

PaymentDetailsIf getPaymentGateway(OrderIf order,
                                   java.lang.String moduleName,
                                   int languageId)
                                   throws KKException
The payment module called 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.

Parameters:
order - The order object
moduleName - This is the name of the payment module in lower case. Examples are cod, paypal, usaepay, worldpay etc.
languageId - The id for the language that will be used. Value of -1 selects the default language.
Returns:
Return a PaymentDetail object
Throws:
KKException

getPaymentDetails

PaymentDetailsIf getPaymentDetails(java.lang.String sessionId,
                                   java.lang.String moduleCode,
                                   int orderId,
                                   java.lang.String hostAndPort,
                                   int languageId)
                                   throws KKException
This method is called once a payment gateway has been selected and an order has been saved in the database. The order is read from the database and the details of the payment are retrieved from the order. This ensures that the payment request matches the order exactly.

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.

Parameters:
sessionId - The session id of the logged in user
moduleCode - This is the name of the payment module in lower case. Examples are cod, paypal, usaepay, worldpay etc.
orderId - The numeric id of the order
hostAndPort - 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.
Returns:
Return an array of PaymentDetail objects
Throws:
KKException

getPaymentDetailsPerOrder

PaymentDetailsIf getPaymentDetailsPerOrder(java.lang.String sessionId,
                                           java.lang.String moduleCode,
                                           OrderIf order,
                                           java.lang.String hostAndPort,
                                           int languageId)
                                           throws KKException
This method is called once a payment gateway has been selected even if the order has not been saved in the database. The details of the payment are retrieved from the order.

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.

Parameters:
sessionId - The session id of the logged in user
moduleCode - This is the name of the payment module in lower case. Examples are cod, paypal, usaepay, worldpay etc.
order - The order object
hostAndPort - 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.
Returns:
Return an array of PaymentDetail objects
Throws:
KKException

saveOrder

int saveOrder(java.lang.String sessionId,
              OrderIf order,
              int languageId)
              throws KKException
A new order is created in the DB. The Order object parameter should have all addresses populated (customer, billing and delivery). The status of the newly created order is taken from the order itself. A check is made to determine whether the status exists within the orders_status table.

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.

Parameters:
sessionId - The session id of the logged in user
order - The order object
languageId - The id for the language that will be used. Value of -1 selects the default language.
Returns:
Returns the order id
Throws:
KKException

getStatusText

java.lang.String getStatusText(int statusId,
                               int languageId)
                               throws KKException
Returns the text of a status from the orders_status table. This table contains order status descriptions in different languages.

Parameters:
statusId - The numeric id of the OrderStatus object
languageId - The id for the language that will be used. Value of -1 selects the default language.
Returns:
Returns the text of the status. Returns Null if not found.
Throws:
KKException

changeOrderStatus

void changeOrderStatus(java.lang.String sessionId,
                       int orderId,
                       int status,
                       boolean customerNotified,
                       java.lang.String comments)
                       throws KKException
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.

Parameters:
sessionId - The session id of the logged in user
orderId - The numeric id of the order
status - 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 sent
comments - These comments are written into the orders_status_history record
Throws:
KKException

updateInventory

void updateInventory(java.lang.String sessionId,
                     int orderId)
                     throws KKException
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.

Parameters:
sessionId - The session id of the logged in user
orderId - The numeric id of the order
Throws:
KKException

updateInventoryWithOptions

void updateInventoryWithOptions(java.lang.String sessionId,
                                int orderId,
                                CreateOrderOptionsIf options)
                                throws KKException
If 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.

Parameters:
sessionId - The session id of the logged in user
orderId - The numeric id of the order
options - An object containing options for the method. It may be set to null.
Throws:
KKException

sendNewPassword

void sendNewPassword(java.lang.String emailAddr,
                     java.lang.String subject,
                     java.lang.String countryCode)
                     throws KKException
Deprecated. 

A mail is sent to emailAddr containing a new password. The language of the email depends on the two letter country code which is used to choose the correct template for creating the mail.

Parameters:
emailAddr - Address of the email
subject - Subject of the email
countryCode - Two letter code used to pick correct template
Throws:
KKException

sendNewPassword1

EmailIf sendNewPassword1(java.lang.String emailAddr,
                         EmailOptionsIf options)
                         throws KKException
A mail is sent to emailAddr containing a new password.

Valid options are:

The Velocity context contains the following data:

Parameters:
emailAddr - Address of the email
options - Options for the email
Returns:
Returns an Email object containing the content of the email
Throws:
KKException

sendWelcomeEmail

void sendWelcomeEmail(int customerId,
                      java.lang.String mailSubject,
                      java.lang.String countryCode)
                      throws KKException
Deprecated. 

A welcome email is sent after registration of a new customer. The language of the email depends on the two letter country code which is used to choose the correct template for creating the mail.

Parameters:
customerId - The numeric id of the customer
mailSubject - The subject of the email
countryCode - The two letter country code used to select the velocity template that creates the mail
Throws:
KKException

sendWelcomeEmail1

EmailIf sendWelcomeEmail1(int customerId,
                          EmailOptionsIf options)
                          throws KKException
A welcome email is sent after registration of a new customer.

Valid options are:

The Velocity context contains the following data:

Parameters:
customerId - The numeric id of the customer
options - Options for the email
Returns:
Returns an Email object containing the content of the email
Throws:
KKException

sendOrderConfirmationEmail

void sendOrderConfirmationEmail(java.lang.String sessionId,
                                int orderId,
                                java.lang.String mailSubject,
                                int languageId)
                                throws KKException
Deprecated. 

A confirmation mail is sent after submitting an order. The language of the email depends on the languageId which is used to choose the correct template for creating the mail.

Parameters:
sessionId - The session id of the logged in user
orderId - The numeric id of the order
mailSubject - The subject of the email
languageId - The id for the language that will be used. Value of -1 selects the default language.
Throws:
KKException

sendOrderConfirmationEmail1

EmailIf sendOrderConfirmationEmail1(java.lang.String sessionId,
                                    int orderId,
                                    int langIdForOrder,
                                    EmailOptionsIf options)
                                    throws KKException
A confirmation mail is sent after submitting an order.

Valid options are:

The Velocity context contains the following data:

Parameters:
sessionId - The session id of the logged in user
orderId - The numeric id of the order
langIdForOrder - 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 email
Returns:
Returns an Email object containing the content of the email
Throws:
KKException

getSecretKeyForOrderId

java.lang.String getSecretKeyForOrderId(int orderId)
                                        throws KKException
A secret key is generated and stored in the database for the orderId passed as a parameter.

Parameters:
orderId -
Returns:
Returns the secret key
Throws:
KKException

getOrderIdFromSecretKey

int getOrderIdFromSecretKey(java.lang.String secretKey)
                            throws KKException
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. The payment gateway should re-send the secret key as a parameter of the callback so that we can look up the order referenced by the key. The secret key is unique for each order.

Parameters:
secretKey - A string representing the secret key
Returns:
Returns the orderId referenced to by the secretKey. A negative number is returned if no order is found.
Throws:
KKException

deleteOrderIdForSecretKey

void deleteOrderIdForSecretKey(java.lang.String secretKey)
                               throws KKException
The secret key is removed from the system. This should be done once payment has been received and no other callbacks are expected from the payment gateway.

Parameters:
secretKey - A string representing the secret key
Throws:
KKException

saveIpnHistory

int saveIpnHistory(java.lang.String sessionId,
                   IpnHistoryIf ipnHistory)
                   throws KKException
A new IpnHistory (Instant Product Notification) record is created in the database. This should be called every time a payment gateway does a callback with information about the payment. The saved record contains data received from the payment gateway, the exact format of which is normally defined by the code that is called when the callback is received.

Parameters:
sessionId - The session id of the logged in user
ipnHistory - The IpnHistory object to save
Returns:
Returns the id of the new ipnHistory object
Throws:
KKException

updateManufacturerViewedCount

void updateManufacturerViewedCount(int manufacturerId,
                                   int languageId)
                                   throws KKException
It updates the number of times that the manufacturer referenced by 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.

Parameters:
manufacturerId - The numeric id of the manufacturer
languageId - The id for the language that will be used. Value of -1 selects the default language.
Throws:
KKException

getZonesPerCountry

ZoneIf[] getZonesPerCountry(int countryId)
                            throws KKException
Returns an array of Zone objects for the country referenced by the countryId.

Parameters:
countryId - The numeric id of the country
Returns:
Return an array of Zone objects
Throws:
KKException

searchForZones

ZoneIf[] searchForZones(ZoneSearchIf search)
                        throws KKException
Search for zones using various search criteria

Parameters:
search -
Returns:
Returns an array of Zone objects
Throws:
KKException

updateCachedConfigurations

void updateCachedConfigurations()
                                throws KKException
Wherever in the engine any configurations have been cached, they are refreshed when this method is called.

Throws:
KKException

doesCustomerExistForEmail

boolean doesCustomerExistForEmail(java.lang.String emailAddr)
                                  throws KKException
Determine whether a customer has already registered with a certain eMail address as their user name.

Parameters:
emailAddr - The user name in the format of an email address
Returns:
Returns true if a customer is registered with the eMail address passed in as a parameter. Otherwise it returns false.
Throws:
KKException

isEmailValid

boolean isEmailValid(java.lang.String emailAddr)
                     throws KKException
Determines whether the eMail address is valid

Parameters:
emailAddr - A string representing an email address
Returns:
Returns true if the email address is valid. Otherwise returns false.
Throws:
KKException

updateBasketWithStockInfo

BasketIf[] updateBasketWithStockInfo(BasketIf[] basketItems)
                                     throws KKException
Receives an array of basket items and updates each one with the current stock level. This is a useful check to make before checking out, to see whether the stock level is sufficient. The Date Available is also set to return information as to when the products will be available if they aren't in stock.

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.

Parameters:
basketItems - An array of basket items
Returns:
Returns an array of basket items with updated stock level
Throws:
KKException

updateBasketWithStockInfoWithOptions

BasketIf[] updateBasketWithStockInfoWithOptions(BasketIf[] basketItems,
                                                AddToBasketOptionsIf options)
                                                throws KKException
Receives an array of basket items and updates each one with the current stock level. This is a useful check to make before checking out, to see whether the stock level is sufficient. The Date Available is also set to return information as to when the products will be available if they aren't in stock.

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 options is set to null, this method is identical to updateBasketWithStockInfo(). Otherwise the functionality differs depending on the combination of options set.

Parameters:
basketItems - An array of basket items
options - An object containing options for the method. It may be set to null.
Returns:
Returns an array of basket items with updated stock level
Throws:
KKException

getProductQuantity

ProductQuantityIf getProductQuantity(java.lang.String encodedProductId)
                                     throws KKException
The stock level of the product and the date available are returned within a ProductQuantity object. An exception is thrown if the product doesn't exist or if the encoded product id has an invalid format. 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. If the product has no attributes then the encodedProductId should be just the productId in String format.

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.

Parameters:
encodedProductId - The encoded product id which can reference a particular configuration of a product. i.e. A green shirt rather than a blue shirt.
Returns:
A ProductQuantity object containing the stock level of the product and the date available.
Throws:
KKException

getProductQuantityWithOptions

ProductQuantityIf getProductQuantityWithOptions(java.lang.String encodedProductId,
                                                FetchProductOptionsIf options)
                                                throws KKException
The stock level of the product and the date available are returned within a ProductQuantity object. An exception is thrown if the product doesn't exist or if the encoded product id has an invalid format. 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. If the product has no attributes then the encodedProductId should be just the productId in String format.

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.

Parameters:
encodedProductId - 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.
Returns:
A ProductQuantity object containing the stock level of the product and the date available.
Throws:
KKException

createAndSaveOrder

OrderIf createAndSaveOrder(java.lang.String emailAddr,
                           java.lang.String password,
                           CustomerRegistrationIf custReg,
                           BasketIf[] basketItemArray,
                           java.lang.String shippingModule,
                           java.lang.String paymentModule,
                           int languageId)
                           throws KKException
A high level call to simplify the process of creating a KonaKart order. It is convenient to use this call especially when KonaKart is integrated within another application such as a Content Management System.

The caller supplies the user name (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.

Parameters:
emailAddr - The user name of the customer creating the order
password - The password of the customer creating the order
custReg - 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 order
shippingModule - 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.
Returns:
Returns an Order object with payment details so that the calling application can call the payment gateway.
Throws:
KKException

getSku

java.lang.String getSku(OrderProductIf orderProd)
                        throws KKException
Deprecated. 

This method is deprecated since release 4.0.0.0 because an SKU attribute was added to the OrderProduct.

Parameters:
orderProd - The OrderProduct object. An order normally contains an array of order product objects.
Returns:
Returns the SKU for the OrderProduct
Throws:
KKException

setEndpoint

void setEndpoint(java.lang.String wsEndpoint)
                 throws KKException
Set the Web Service endpoint for the engine. This is only applicable when calling a KonaKart engine via web services.

The effect will be to set the web service endpoint for the proxy to the KonaKart engine.

Parameters:
wsEndpoint - A String representing the web service endpoint
Throws:
KKException

insertDigitalDownload

int insertDigitalDownload(java.lang.String sessionId,
                          int productId)
                          throws KKException
Create and insert a digital download record for the product identified by the 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.

Parameters:
sessionId - The session id of the logged in user
productId - The numeric id of the product
Returns:
Returns the id of the inserted Digital Download
Throws:
KKException

getDigitalDownloads

DigitalDownloadIf[] getDigitalDownloads(java.lang.String sessionId)
                                        throws KKException
Returns an array of Digital Download objects for the customer identified by the sessionId parameter.

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.

Parameters:
sessionId - The session id of the logged in user
Returns:
Returns an array of DigitalDownload objects
Throws:
KKException

updateDigitalDownloadCount

int updateDigitalDownloadCount(java.lang.String sessionId,
                               int productId)
                               throws KKException
Updates the count of the Digital Download identified by the productId and the customer identified by the sessionId. The count defines how many times it has been downloaded.

Parameters:
sessionId - The session id of the logged in user
productId - The numeric id of the product
Returns:
Returns the new count
Throws:
KKException

updateDigitalDownloadCountById

int updateDigitalDownloadCountById(java.lang.String sessionId,
                                   int digitalDownloadId)
                                   throws KKException
Updates the count of the Digital Download identified by the 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. Tickets

Parameters:
sessionId - The session id of the logged in user
digitalDownloadId - The numeric id of the digital download object
Returns:
Returns the new count
Throws:
KKException

getTempCustomerId

int getTempCustomerId()
                      throws KKException
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. This is the engine call used to get the unique negative id.

Returns:
The latest temporaryId
Throws:
KKException

getAllCustomerGroups

CustomerGroupIf[] getAllCustomerGroups(int languageId)
                                       throws KKException
Returns an array of customer groups for all customer groups that have been defined in the system. The groups returned are those for the language defined by languageId.

Parameters:
languageId - The id for the language that will be used to determine the customer group name and description. Value of -1 selects the default language.
Returns:
An array of customer group objects.
Throws:
KKException

getCustomerGroup

CustomerGroupIf getCustomerGroup(int customerGroupId,
                                 int languageId)
                                 throws KKException
Returns a customer group object for the customerGroupId passed in as a parameter.

Parameters:
customerGroupId -
languageId - The id for the language that will be used to determine the customer group name and description. Value of -1 selects the default language.
Returns:
A customer group object.
Throws:
KKException

sendTemplateEmailToCustomer

void sendTemplateEmailToCustomer(int customerId,
                                 java.lang.String templateName,
                                 java.lang.String message,
                                 java.lang.String countryCode)
                                 throws KKException
Deprecated. 

This method is used to send a template based eMail to a customer identified by the customerId. The attributes that the velocity template has access to are:

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.

Parameters:
customerId - The numeric id of the customer
templateName - 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.
Throws:
KKException

sendTemplateEmailToCustomer1

EmailIf sendTemplateEmailToCustomer1(int customerId,
                                     java.lang.String message,
                                     EmailOptionsIf options)
                                     throws KKException
This method is used to send a template based eMail to a customer identified by the customerId.

Valid options are:

The Velocity context contains the following data:

Parameters:
customerId - The numeric id of the customer
message - The information within the message may be used by the template.
options - Options for the email
Returns:
Returns an Email object containing the content of the email
Throws:
KKException

loginByAdmin

java.lang.String loginByAdmin(java.lang.String adminSession,
                              int customerId)
                              throws KKException
Used to log in to the application as a customer by an Administrator. This is useful for Call Center type applications where the Call Center person can log into the application as the customer without requiring the customer's credentials, in order to perform some action on behalf of the customer.

The adminSession must contain the session of a logged in Administrator User. The customerId must contain the Id of the customer to login as.

Parameters:
adminSession - The session of a logged in administrator user
customerId - The id of the customer to login as
Returns:
Returns the sessionId for the customer's session
Throws:
KKException

custom

java.lang.String custom(java.lang.String input1,
                        java.lang.String input2)
                        throws KKException
A custom interface that you have to provide an implementation for. The default implementation will simply return a null.

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!

Parameters:
input1 - The first input String - can be anything you choose
input2 - The second input String - can be anything you choose
Returns:
Returns a String
Throws:
KKException

customSecure

java.lang.String customSecure(java.lang.String sessionId,
                              java.lang.String input1,
                              java.lang.String input2)
                              throws KKException
A custom interface that you have to provide an implementation for. The default implementation will throw an exception for an invalid sessionId or return a null.

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!

Parameters:
sessionId - The session id of the logged in user
input1 - The first input String - can be anything you choose
input2 - The second input String - can be anything you choose
Returns:
Returns a String
Throws:
KKException

getTagGroupsPerCategory

TagGroupIf[] getTagGroupsPerCategory(int categoryId,
                                     boolean getProdCount,
                                     int languageId)
                                     throws KKException
Return an array of TagGroup objects for a category. Each TagGroup is populated with an array of Tags which are sorted first by sort order and then by name. An empty array is returned if no TagGroup objects exist.

Parameters:
categoryId - The numeric id of the category
getProdCount - If true, the Tag objects are populated with the number of products
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.
Returns:
Returns an array of TagGroup objects
Throws:
KKException

getTagsPerCategory

TagIf[] getTagsPerCategory(int categoryId,
                           boolean getProdCount,
                           int languageId)
                           throws KKException
Return an array of Tag objects for a category. An empty array is returned if no Tag objects exist. The Tags are sorted first by sort order and then by name.

Parameters:
categoryId - The numeric id of the category
getProdCount - If true, the Tag objects are populated with the number of products
languageId - The id for the language that will be used to determine the tag name. Value of -1 selects the default language.
Returns:
Returns an array of Tag objects
Throws:
KKException

getTagGroup

TagGroupIf getTagGroup(int tagGroupId,
                       boolean getProdCount,
                       int languageId)
                       throws KKException
Returns a TagGroup object for the id passed in as a parameter. The TagGroup is populated with an array of Tags which are sorted first by sort order and then by name. Null is returned if the TagGroup object doesn't exist.

Parameters:
tagGroupId - The numeric Id of the tag group
getProdCount - If true, the Tag objects are populated with the number of products
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.
Returns:
Returns a TagGroup object
Throws:
KKException

getTag

TagIf getTag(int tagId,
             boolean getProdCount,
             int languageId)
             throws KKException
Returns a Tag object for the id passed in as a parameter.

Parameters:
tagId - The numeric Id of the tag
getProdCount - If true, the Tag object is populated with the number of products
languageId - The id for the language that will be used to determine the tag name. Value of -1 selects the default language.
Returns:
Returns a Tag object
Throws:
KKException

getDefaultCustomer

CustomerIf getDefaultCustomer()
                              throws KKException
Returns the customer object for the default customer. If more than one default customer exists (which shouldn't be the case), it returns one of the customers found. If no default customer is found, it returns null.

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.

Returns:
Customer Object or Null if the default customer doesn't exist.
Throws:
KKException

getEngConf

EngineConfigIf getEngConf()
The EngineConfig is the configuration object passed to the engine at the time of instantiation.

Returns:
Returns the EngineConfig object.

getStoreIds

java.lang.String[] getStoreIds()
                               throws KKException
Returns an array of strings containing the store ids for the stores being used in a multi-store / multi-database environment. It may return null or an empty array if not applicable. In a multi-store / multi-database environment, each KonaKart database instance may only be configured to connect to a number of stores and so it is necessary to know which stores the engine will connect to. In a multi-store / single-database environment, the method isn't applicable since each engine instance can connect to all stores.

Returns:
Returns an array of strings containing the store ids for the stores being used in a multi-store / multi-database environment.
Throws:
KKException

setCreditCardDetailsOnOrder

void setCreditCardDetailsOnOrder(java.lang.String sessionId,
                                 int orderId,
                                 CreditCardIf card)
                                 throws KKException
The credit card details in the CreditCard object passed in as a parameter, are saved in the database for an existing order. Before being saved, this sensitive information is encrypted.

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:

Parameters:
sessionId - The session id of the logged in user
orderId - The numeric id of the order
card - CreditCard object containing the credit card details
Throws:
KKException

addToWishList

int addToWishList(java.lang.String sessionId,
                  WishListItemIf wishListItem)
                  throws KKException
Add a WishListItem object to the wish list referenced by wishListId. If the wish list doesn't belong to the logged in customer, an exception is thrown. If the WishListItem already exists, then it is updated. The customer must be logged in with a valid sessionId when this method is called.

The compulsory attributes for the WishListItem are:

The WishListItem may also contain an array of options if these are applicable for the chosen product.

Parameters:
sessionId - The session id of the logged in user
wishListItem - The wish list item to be added to the wish list
Returns:
Returns the id of the new wishListItem object
Throws:
KKException

addToWishListWithOptions

int addToWishListWithOptions(java.lang.String sessionId,
                             WishListItemIf wishListItem,
                             AddToWishListOptionsIf options)
                             throws KKException
If 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.

Parameters:
sessionId - The session id of the logged in user
wishListItem - The wish list item to be added to the wish list
options - An object containing options for the method. It may be set to null.
Returns:
Returns the id of the new wishListItem object
Throws:
KKException

createWishList

int createWishList(java.lang.String sessionId,
                   WishListIf wishList)
                   throws KKException
Create a wish list from a WishList object. Once created, the method 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:

Parameters:
sessionId - The session id of the logged in user
wishList - The wish list to be created
Returns:
Returns the id of the new WishList object
Throws:
KKException

createWishListWithOptions

int createWishListWithOptions(java.lang.String sessionId,
                              WishListIf wishList,
                              AddToWishListOptionsIf options)
                              throws KKException
Create a wish list from a WishList object. Once created, the method 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:

Parameters:
sessionId - The session id of the logged in user
wishList - The wish list to be created
options - An object containing options for the method. It may be set to null.
Returns:
Returns the id of the new WishList object
Throws:
KKException

editWishList

void editWishList(java.lang.String sessionId,
                  WishListIf wishList)
                  throws KKException
Edit an existing wish list object. A check is made that the wish list actually belongs to the user referenced by the session id. The customer must be logged in with a valid sessionId when this method is called.

Parameters:
sessionId - The session id of the logged in user
wishList - The wish list to be edited
Throws:
KKException

editWishListWithOptions

void editWishListWithOptions(java.lang.String sessionId,
                             WishListIf wishList,
                             AddToWishListOptionsIf options)
                             throws KKException
Edit an existing wish list object. The sessionId may be left null if a temporary customer id (negative number) is added to the options object. A check is made that the wish list actually belongs to the user referenced by the session id or customer id.

Parameters:
sessionId - The session id of the logged in user
wishList - The wish list to be edited
options - An object containing options for the method. It may be set to null.
Throws:
KKException

deleteWishList

void deleteWishList(java.lang.String sessionId,
                    int wishListId)
                    throws KKException
The wish list referenced by wishListId and all of the items contained by the wish list, will be deleted. An exception will be thrown if the wish list does not belong to the logged in customer. The customer must be logged in with a valid sessionId when this method is called.

Parameters:
sessionId - The session id of the logged in user
wishListId - The numeric id of the wish list
Throws:
KKException

deleteWishListWithOptions

void deleteWishListWithOptions(java.lang.String sessionId,
                               int wishListId,
                               AddToWishListOptionsIf options)
                               throws KKException
The wish list referenced by wishListId and all of the items contained by the wish list, will be deleted. The sessionId may be left null if a temporary customer id (negative number) is added to the options object. The WishListItem will only be deleted if the wish list belongs to the logged in customer or the customer referenced by the customer id. An exception will be thrown if the wish list does not belong to the logged in customer or customer referenced by customerId.

Parameters:
sessionId - The session id of the logged in user
wishListId - The numeric id of the wish list
options - An object containing options for the method. It may be set to null.
Throws:
KKException

getWishListWithItems

WishListIf getWishListWithItems(java.lang.String sessionId,
                                int wishListId,
                                int languageId)
                                throws KKException
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. The customer must be logged in with a valid sessionId when this method is called.

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.

Parameters:
sessionId - 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 list
languageId - The id for the language that will be used. Value of -1 selects the default language.
Returns:
Returns an array of WishListItem objects
Throws:
KKException

getWishListWithItemsWithOptions

WishListIf getWishListWithItemsWithOptions(java.lang.String sessionId,
                                           int wishListId,
                                           int languageId,
                                           AddToWishListOptionsIf options)
                                           throws KKException
If 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.

Parameters:
sessionId - 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 list
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.
Returns:
Returns an array of WishListItem objects
Throws:
KKException

getWishList

WishListIf getWishList(java.lang.String sessionId,
                       int wishListId)
                       throws KKException
Returns a WishList object not populated with an array of WishListItem objects. An exception is thrown if the wish list doesn't belong to the logged in customer and is private. Null is returned if the wish list doesn't exist. The customer must be logged in with a valid sessionId when this method is called.

Parameters:
sessionId - 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 list
Returns:
Returns a Wish List object
Throws:
KKException

getWishListWithOptions

WishListIf getWishListWithOptions(java.lang.String sessionId,
                                  int wishListId,
                                  AddToWishListOptionsIf options)
                                  throws KKException
Returns a WishList object not populated with an array of WishListItem objects. 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. Null is returned if the wish list doesn't exist. The customer must be logged in with a valid sessionId when this method is called.

Parameters:
sessionId - 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 list
options - An object containing options for the method. It may be set to null.
Returns:
Returns a Wish List object
Throws:
KKException

getWishListItemsWithOptions

WishListItemsIf getWishListItemsWithOptions(java.lang.String sessionId,
                                            DataDescriptorIf dataDesc,
                                            int wishListId,
                                            int languageId,
                                            AddToWishListOptionsIf options)
                                            throws KKException
Returns a WishListItems object containing an array of items and the number of items returned. The DataDescriptor object can be user to sort and page the returned items. 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.

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.

Parameters:
sessionId - 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 order
wishListId - The numeric id of the WishList object that the wish list items belong to
languageId - The numeric id of the language object
options - An object containing options for the method. It may be set to null.
Returns:
Returns a WishListItems objects
Throws:
KKException

getWishListItems

WishListItemsIf getWishListItems(java.lang.String sessionId,
                                 DataDescriptorIf dataDesc,
                                 int wishListId,
                                 int languageId)
                                 throws KKException
Returns a WishListItems object containing an array of items and the number of items returned. The DataDescriptor object can be user to sort and page the returned items. An exception will be thrown if the wish list doesn't belong to the logged in customer and is private.

However, by setting the attributes of dataDesc, the following functionality may be controlled :

Parameters:
sessionId - 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 order
wishListId - The numeric id of the WishList object that the wish list items belong to
languageId - The numeric id of the language object
Returns:
Returns a WishListItems objects
Throws:
KKException

removeFromWishList

void removeFromWishList(java.lang.String sessionId,
                        int wishListItemId)
                        throws KKException
Remove the WishListItem object referenced by wishListItemId. The WishListItem will only be deleted if the wish list belongs to the logged in customer. If the wish list does not belong to the customer referenced by the sessionId, an exception will be thrown. The customer must be logged in with a valid sessionId when this method is called.

Parameters:
sessionId - The session id of the logged in user
wishListItemId - The numeric id of the wish list item
Throws:
KKException

removeFromWishListWithOptions

void removeFromWishListWithOptions(java.lang.String sessionId,
                                   int wishListItemId,
                                   AddToWishListOptionsIf options)
                                   throws KKException
Remove the WishListItem object referenced by wishListItemId. The sessionId may be left null if a temporary customer id (negative number) is added to the options object. The WishListItem will only be deleted if the wish list belongs to the logged in customer or the customer referenced by the customer id. If the wish list does not belong to the customer referenced by the sessionId or customer id, an exception will be thrown.

Parameters:
sessionId - The session id of the logged in user
wishListItemId - The numeric id of the wish list item
options - An object containing options for the method. It may be set to null.
Throws:
KKException

mergeWishListsWithOptions

void mergeWishListsWithOptions(java.lang.String sessionId,
                               int customerFromId,
                               int languageId,
                               AddToWishListOptionsIf options)
                               throws KKException
Add all items from the wish list of customerFrom to the wish list of customerTo which is retrieved from the sessionId. This is done when a customer logs in, to move his temporary wish list to his permanent wish list.

The currently logged in customer may have more than one wish list. The one used is the first one found of listType == 0.

Parameters:
sessionId -
customerFromId -
languageId -
options -
Throws:
KKException

searchForWishLists

WishListsIf searchForWishLists(java.lang.String sessionId,
                               DataDescriptorIf dataDesc,
                               CustomerSearchIf customerSearch)
                               throws KKException
All wish lists matching the search criteria will be returned. They will be grouped by customerId. Note that in order to retrieve the wish list items, you must call the 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.

Parameters:
sessionId - 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 order
customerSearch - Used to search for customers
Returns:
Returns a WishListsIf object containing an array of wishList objects and paging information.
Throws:
KKException

getStore

StoreIf getStore()
                 throws KKException
Returns the store that this KonaKart engine is connected to.

Returns:
Returns a Store object or null if the store isn't found
Throws:
KKException

addCustomDataToSession

void addCustomDataToSession(java.lang.String sessionId,
                            java.lang.String data,
                            int position)
                            throws KKException
A sessionId is created when a customer logs in to KonaKart using the login() API call. This sessionId is persisted in the database in a table which has 5 custom fields. This method allows you to store data in these custom fields which can later be retrieved by using the sessionId as the key.

Parameters:
sessionId - The sessionId
data - The data to be saved
position - This must be in the range of 1-5 to identify custom1 to custom5
Throws:
KKException

getCustomDataFromSession

java.lang.String getCustomDataFromSession(java.lang.String sessionId,
                                          int position)
                                          throws KKException
A sessionId is created when a customer logs in to KonaKart using the login() API call. This sessionId is persisted in the database in a table which has 5 custom fields. This method allows you to retrieve the data in these custom fields by passing the sessionId as the key and a pointer to identify the custom field to be used.

Parameters:
sessionId - The sessionId
position - This must be in the range of 1-5 to identify custom1 to custom5
Returns:
Returns the custom data
Throws:
KKException

setCookie

void setCookie(KKCookieIf cookie)
               throws KKException
Saves the cookie in the database. If it already exists, it is edited.

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.

Parameters:
cookie - A KKCookie object to be persisted in the database
Throws:
KKException

getCookie

KKCookieIf getCookie(java.lang.String customerUuid,
                     java.lang.String attrId)
                     throws KKException
Fetches the cookie object from the database that is referenced by the customerUuid and attrId parameters. If the cookie object doesn't exist, null is returned.

When this method is called, the last_read date of the returned cookie in the database, is updated.

Parameters:
customerUuid - A random string used to identify the customer that owns the cookies
attrId - An identifier for the cookie
Returns:
Returns a KKCookie object
Throws:
KKException

getAllCookies

KKCookieIf[] getAllCookies(java.lang.String customerUuid)
                           throws KKException
Fetches all of the cookie object from the database that are referenced by the customerUuid parameter. If no cookies exist, an empty array is returned.

When this method is called, the last_read date for each returned cookies in the database, is updated.

Parameters:
customerUuid - A random string used to identify the customer that owns the cookies
Returns:
Returns an array of KKCookie objects
Throws:
KKException

deleteCookie

void deleteCookie(java.lang.String customerUuid,
                  java.lang.String attrId)
                  throws KKException
Deletes the cookie object from the database that is referenced by the customerUuid and attrId parameters.

Parameters:
customerUuid - A random string used to identify the customer that owns the cookies
attrId - An identifier for the cookie
Throws:
KKException

getGeoZonesPerZone

GeoZoneIf[] getGeoZonesPerZone(ZoneIf zone)
                               throws KKException
Returns an array of GeoZone objects (tax areas) for the zone passed in as a parameter. There may be multiple tax areas for a physical zone, which is why an array of GeoZone objects is returned. An example of this is state tax and federal tax.

Parameters:
zone - The physical zone
Returns:
Return an array of GeoZone objects
Throws:
KKException

insertCustomerTag

void insertCustomerTag(java.lang.String sessionId,
                       CustomerTagIf tag)
                       throws KKException
Assigns a customer tag to the customer referenced by the 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().

Parameters:
sessionId - The session id of the logged in user
tag - Customer Tag
Throws:
KKException

insertCustomerTagForGuest

void insertCustomerTagForGuest(int customerId,
                               CustomerTagIf tag)
                               throws KKException
Assigns a customer tag to the guest customer referenced by the 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().

Parameters:
customerId - The id of the guest customer which has a negative value.
tag - Customer Tag
Throws:
KKException

addToCustomerTag

void addToCustomerTag(java.lang.String sessionId,
                      java.lang.String tagName,
                      int tagValue)
                      throws KKException
This method is used for customer tags where the value is of type com.konakart.app.CustomerTag.MULTI_INT_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.

Parameters:
sessionId - The session id of the logged in user
tagName - Name of the customer tag
tagValue - Value of the customer tag
Throws:
KKException

addToCustomerTagForGuest

void addToCustomerTagForGuest(int customerId,
                              java.lang.String tagName,
                              int tagValue)
                              throws KKException
This method is used for customer tags where the value is of type com.konakart.app.CustomerTag.MULTI_INT_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.

Parameters:
customerId - The id of the guest customer which has a negative value.
tagName - Name of the customer tag
tagValue - Value of the customer tag
Throws:
KKException

getCustomerTag

CustomerTagIf getCustomerTag(java.lang.String sessionId,
                             java.lang.String tagName)
                             throws KKException
A CustomerTag object referenced by the parameter 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.).

Parameters:
sessionId - The session id of the logged in user
tagName - Name of the customer tag
Returns:
Returns a CustomerTag object, populated with the value.
Throws:
KKException

getCustomerTagForGuest

CustomerTagIf getCustomerTagForGuest(int customerId,
                                     java.lang.String tagName)
                                     throws KKException
A CustomerTag object referenced by the parameter 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.).

Parameters:
customerId - The id of the guest customer which has a negative value.
tagName - Name of the customer tag
Returns:
Returns a CustomerTag object, populated with the value.
Throws:
KKException

getCustomerTagValue

java.lang.String getCustomerTagValue(java.lang.String sessionId,
                                     java.lang.String tagName)
                                     throws KKException
A string is returned containing the value of the customer tag referenced by the parameter 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.

Parameters:
sessionId - The session id of the logged in user
tagName - Name of the customer tag
Returns:
Returns a string containing the tag value
Throws:
KKException

getCustomerTagValueForGuest

java.lang.String getCustomerTagValueForGuest(int customerId,
                                             java.lang.String tagName)
                                             throws KKException
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. 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.

Parameters:
customerId - The id of the guest customer which has a negative value.
tagName - Name of the customer tag
Returns:
Returns a string containing the tag value
Throws:
KKException

deleteCustomerTag

void deleteCustomerTag(java.lang.String sessionId,
                       java.lang.String tagName)
                       throws KKException
This method deletes the customer tag referenced by the parameter tagName and for the customer referenced by the sessionId.

Parameters:
sessionId - The session id of the logged in user
tagName - Name of the customer tag
Throws:
KKException

deleteCustomerTagForGuest

void deleteCustomerTagForGuest(int customerId,
                               java.lang.String tagName)
                               throws KKException
This method deletes the customer tag referenced by the parameter tagName and for the guest customer referenced by the negative customerId.

Parameters:
customerId - The id of the guest customer which has a negative value.
tagName - Name of the customer tag
Throws:
KKException

getCustomerTags

CustomerTagIf[] getCustomerTags(java.lang.String sessionId)
                                throws KKException
This method fetches all of the customer tags for the customer referenced by the sessionId.

An empty array is returned if no tags exist.

Parameters:
sessionId - The session id of the logged in user
Returns:
Returns an array of CustomerTag objects
Throws:
KKException

getCustomerTagsForGuest

CustomerTagIf[] getCustomerTagsForGuest(int customerId)
                                        throws KKException
This method fetches all of the customer tags for the guest customer referenced by the customerId which must have a negative value.

An empty array is returned if no tags exist.

Parameters:
customerId - The id of the guest customer which has a negative value.
Returns:
Returns an array of CustomerTag objects
Throws:
KKException

evaluateExpression

boolean evaluateExpression(java.lang.String sessionId,
                           int expressionId,
                           java.lang.String expressionName)
                           throws KKException
An expression object is retrieved from the database and evaluated for the customer referenced by the 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.

Parameters:
sessionId - The session id of the logged in user
expressionId - Numeric Id of the expression
expressionName - Name of expression
Returns:
Returns true or false
Throws:
KKException

evaluateExpressionForGuest

boolean evaluateExpressionForGuest(int customerId,
                                   int expressionId,
                                   java.lang.String expressionName)
                                   throws KKException
An expression object is retrieved from the database and evaluated for the guest customer referenced by the negative 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.

Parameters:
customerId - The id of the guest customer which has a negative value.
expressionId - Numeric Id of the expression
expressionName - Name of expression
Returns:
Returns true or false
Throws:
KKException

getExpression

ExpressionIf getExpression(java.lang.String sessionId,
                           int expressionId,
                           java.lang.String expressionName)
                           throws KKException
An Expression object, fully populated with an array of Expression Variables is returned. 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.

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

Parameters:
sessionId - The session id of the logged in user
expressionId - Numeric Id of the expression
expressionName - Name of expression
Returns:
Returns a fully populated Expression object
Throws:
KKException

getExpressionForGuest

ExpressionIf getExpressionForGuest(int customerId,
                                   int expressionId,
                                   java.lang.String expressionName)
                                   throws KKException
An Expression object, fully populated with an array of Expression Variables is returned. 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.

The expression variables will be populated with the customer tag values for the guest customer referenced by customerId.

Parameters:
customerId - The id of the guest customer which has a negative value.
expressionId - Numeric Id of the expression
expressionName - Name of expression
Returns:
Returns a fully populated Expression object
Throws:
KKException

pointsAvailable

int pointsAvailable(java.lang.String sessionId)
                    throws KKException
Calculates the number of reward points available for the customer identified by the sessionId parameter.

Parameters:
sessionId - The session id of the logged in user
Returns:
Returns the number of points available for spending
Throws:
KKException

addPoints

int addPoints(java.lang.String sessionId,
              int points,
              java.lang.String code,
              java.lang.String description)
              throws KKException
Adds a number of reward points to the total for customer identified by the sessionId parameter.

Parameters:
sessionId - The session id of the logged in user
points - Number of points to add
code - An optional code to categorize the reason for awarding the points
description - An optional description describing why the points were awarded
Returns:
Returns the new number of points available for spending
Throws:
KKException

deletePoints

int deletePoints(java.lang.String sessionId,
                 int points,
                 java.lang.String code,
                 java.lang.String description)
                 throws KKException
Deletes a number of reward points from the total for the customer identified by the sessionId parameter.

Parameters:
sessionId - The session id of the logged in user
points - Number of points to delete
code - An optional code to categorize the reason for redeeming the points
description - An optional description describing how the points were redeemed
Returns:
Returns the new number of points available for spending
Throws:
KKException

reservePoints

int reservePoints(java.lang.String sessionId,
                  int points)
                  throws KKException
Removes a number of reward points from the total for the customer identified by the 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.

Parameters:
sessionId - The session id of the logged in user
points - Number of points to reserve
Returns:
Returns the reservation id of the reserved points
Throws:
KKException

deleteReservedPoints

void deleteReservedPoints(java.lang.String sessionId,
                          int reservationId,
                          java.lang.String code,
                          java.lang.String description)
                          throws KKException
Verifies that the 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.

Parameters:
sessionId - The session id of the logged in user
reservationId - Numeric identifier of the reservation
code - An optional code to categorize the reason for redeeming the points
description - An optional description describing how the points were redeemed
Throws:
KKException

freeReservedPoints

int freeReservedPoints(java.lang.String sessionId,
                       int reservationId)
                       throws KKException
Verifies that the 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.

Parameters:
sessionId - The session id of the logged in user
reservationId - Numeric identifier of the reservation
Returns:
Returns the number of points available for spending
Throws:
KKException

setRewardPointReservationId

void setRewardPointReservationId(java.lang.String sessionId,
                                 int orderId,
                                 int reservationId)
                                 throws KKException
Verifies that the order belongs to the customer identified by the sessionId parameter and then updates the reservation id on the order.

Parameters:
sessionId -
orderId -
reservationId -
Throws:
KKException

getRewardPoints

RewardPointsIf getRewardPoints(java.lang.String sessionId,
                               DataDescriptorIf dataDesc)
                               throws KKException
Gets an array of reward point objects for a customer identified by the sessionId parameter. The most recent objects are returned first.

Parameters:
sessionId - The session id of the logged in user
dataDesc - Used to control the data offset and limit the number of items returned
Returns:
Returns a RewardPoints object
Throws:
KKException

insertSubscription

int insertSubscription(java.lang.String sessionId,
                       SubscriptionIf subscription)
                       throws KKException
A Subscription object is inserted into the database. The following subscription attributes are compulsory: The customer id of the Subscription object is fetched from the sessionId. The id of the new object is returned.

Parameters:
sessionId - The session id of the logged in user
subscription - The subscription object to be inserted
Returns:
Returns the id of the Subscription object
Throws:
KKException

getPaymentSchedule

PaymentScheduleIf getPaymentSchedule(int id)
                                     throws KKException
Returns the payment schedule object for the id parameter, or Null if the payment schedule object doesn't exist in the DB.

Parameters:
id - The id of the payment schedule object
Returns:
Returns a payment schedule object
Throws:
KKException

getSubscriptionsPerCustomer

SubscriptionIf[] getSubscriptionsPerCustomer(java.lang.String sessionId)
                                             throws KKException
Returns an array of Subscription objects for a customer referred to by the sessionId parameter.

Parameters:
sessionId - The session id of the logged in user
Returns:
Returns an array of Subscription objects
Throws:
KKException

getProductPerSkuWithOptions

ProductIf getProductPerSkuWithOptions(java.lang.String sessionId,
                                      java.lang.String sku,
                                      int languageId,
                                      FetchProductOptionsIf options)
                                      throws KKException
Get a product from its SKU. If the SKU refers to a particular configuration of the product (i.e. Blue shirt, size small) then the product object is only populated with the options that match the SKU and with the ProductQuantity object that matches the SKU. When a product is retrieved based on its id or when the SKU is for a product without attributes, then all of the options and product quantities are populated.

Parameters:
sessionId - The session id of the logged in user
sku - The product SKU
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.
Returns:
Returns the product matching the SKU or null if no product is found
Throws:
KKException

getProductPerSku

ProductIf getProductPerSku(java.lang.String sessionId,
                           java.lang.String sku,
                           int languageId)
                           throws KKException
Get a product from its SKU. If the SKU refers to a particular configuration of the product (i.e. Blue shirt, size small) then the product object is only populated with the options that match the SKU and with the ProductQuantity object that matches the SKU. When a product is retrieved based on its id or when the SKU is for a product without attributes, then all of the options and product quantities are populated.

Parameters:
sessionId - The session id of the logged in user
sku - The product SKU
languageId - The id for the language that will be used. Value of -1 selects the default language.
Returns:
Returns the product matching the SKU or null if no product is found
Throws:
KKException

getIpnHistory

IpnHistoryIf[] getIpnHistory(java.lang.String sessionId,
                             int orderId)
                             throws KKException
Retrieve an array of IpnHistory objects for an order. The order must belong to the customer referenced by the sessionId.

Parameters:
sessionId - The session id of the logged in user
orderId - The numeric id of the order
Returns:
Returns an array of IpnHistory objects for the order
Throws:
KKException

getPdf

PdfResultIf getPdf(java.lang.String sessionId,
                   PdfOptionsIf options)
                   throws KKException
Creates a PDF document. For the case where the options object points to an order, the method ensures that the order belongs to the customer referenced by the sessionId.

Parameters:
sessionId - The session id of the logged in user
options - The PdfOptions object that defines the PDF document to create
Returns:
Returns a PdfResult object
Throws:
KKException

getDigitalDownloadById

DigitalDownloadIf getDigitalDownloadById(java.lang.String sessionId,
                                         int digitalDownloadId)
                                         throws KKException
Returns a Digital Download object for the digital download id. Returns null if no object exists. A check is made to verify that the digital download object belongs to the customer identified by the sessionId.

Parameters:
sessionId - The session id of the logged in user
digitalDownloadId - The numeric id of the digital download object
Returns:
Returns a DigitalDownload object
Throws:
KKException

editDigitalDownload

void editDigitalDownload(java.lang.String sessionId,
                         DigitalDownloadIf digitalDownload)
                         throws KKException
Edits the digital download object if it belongs to the customer identified by the sessionId. Otherwise an exception is thrown.

Parameters:
sessionId - The session id of the logged in user
digitalDownload - The digital download object to be edited
Throws:
KKException

getMsgValue

java.lang.String getMsgValue(java.lang.String key,
                             int type,
                             java.lang.String locale)
                             throws KKException
Get an Application Message Value. If locale is null, the default locale is used.

Parameters:
key - the message key
type - 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.
Returns:
The message for the key, type and locale. If the message isn't found the String "[key:type:locale]" is returned.
Throws:
KKException

getMessages

NameValueIf[] getMessages(int type,
                          java.lang.String locale)
                          throws KKException
Used to fetch a message catalog for a locale and message type. If locale is null, the default locale is used.

Parameters:
type - 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.
Returns:
Returns and array of NameValue objects containing the message catalog
Throws:
KKException

postMessageToQueue

void postMessageToQueue(java.lang.String sessionId,
                        MqOptionsIf options)
                        throws KKException
Post a message to a specified queue. Use the options parameter to define the message text, credentials and the destination queue.

Parameters:
sessionId - the sessionId
options - the MQ options
Throws:
KKException

readMessageFromQueue

MqResponseIf readMessageFromQueue(java.lang.String sessionId,
                                  MqOptionsIf options)
                                  throws KKException
Read a single message from a specified queue. Use the options parameter to define credentials, a timeout value and the name of the queue to read.

Parameters:
sessionId - the sessionId
options - the MQ options
Returns:
an object describing the response from this call. Usually it will contain the text of the message that was read, but if there was a timeout the message will be null and the timedout attribute will be true.
Throws:
KKException

insertCustomerEvent

void insertCustomerEvent(CustomerEventIf event)
                         throws KKException
The customer event is written to a queue and control is immediately returned to the caller. The queue is emptied by a thread that persists the event to the database. The database where the event is stored is defined in the properties file and for performance reasons may be different to the database containing the standard KonaKart tables.

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.

Parameters:
event - A customer event object
Throws:
KKException

getSuggestedSearchItems

SuggestedSearchItemIf[] getSuggestedSearchItems(java.lang.String sessionId,
                                                SuggestedSearchOptionsIf options)
                                                throws KKException
An array of SuggestedSearchItems is returned for search text within the options parameter. This method is useful for creating a dynamic search entry field that shows a list of suggested search items every time a character is entered in the search entry field.

Parameters:
sessionId - the sessionId which may be left null if the customer isn't logged in
options - A SuggestedSearchOptions object containing all parameters necessary to configure the SuggestedSearch operation
Returns:
Returns an array of SuggestedSearchItems
Throws:
KKException

getProductsFromIdsWithOptions

ProductIf[] getProductsFromIdsWithOptions(java.lang.String sessionId,
                                          DataDescriptorIf dataDesc,
                                          int[] prodIdArray,
                                          int languageId,
                                          FetchProductOptionsIf options)
                                          throws KKException
An array of products is returned that corresponds to an array of productIds passed in as a parameter. The dataDesc parameter may be used to sort the products and to determine whether to return the description and the options parameter may be used for advanced functionality such as determining where to read the price and quantity information from.

Parameters:
sessionId - the sessionId which may be left 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 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.
Returns:
Returns an array of products
Throws:
KKException

getBookingsPerProduct

BookingsIf getBookingsPerProduct(DataDescriptorIf dataDesc,
                                 int productId,
                                 BookableProductOptionsIf options)
                                 throws KKException
Get an array of bookings for a bookable product. The DatDescriptor object may be used to add constraints on the custom fields and to add order by criteria. The following OrderBy criteria are implemented:

Parameters:
dataDesc - Can be used to add sort by information and constraints on the custom fields
productId - The numeric id of the product
options - Not used at the moment. May be left null.
Returns:
Returns a Bookings object containing the bookings
Throws:
KKException

getBookingsPerCustomer

BookingsIf getBookingsPerCustomer(java.lang.String sessionId,
                                  DataDescriptorIf dataDesc,
                                  BookableProductOptionsIf options)
                                  throws KKException
Get an array of bookings for a logged in customer. The DataDescriptor object may be used to add constraints on the custom fields and to add order by criteria. The following OrderBy criteria are implemented:

Parameters:
sessionId - The sessionId of the logged in customer
dataDesc - Can be used to add sort by information and constraints on the custom fields
options - Not used at the moment. May be left null.
Returns:
Returns a Bookings object
Throws:
KKException

insertBooking

int insertBooking(java.lang.String sessionId,
                  BookingIf booking,
                  BookableProductOptionsIf options)
                  throws KKException
Inserts a Booking object into the database. The customer must be logged in with a valid session id. The id of the logged in customer is written into the customerId attribute of the Booking object before it is saved. The Booking must be associated with an existing product through the productId attribute.

Parameters:
sessionId - The sessionId of the logged in customer
booking - A booking object
options - Options allowing an exception to be thrown for exceeding the maximum number of bookings
Returns:
Returns the id of the inserted object
Throws:
KKException

getBookableProductConflict

ProductIf[] getBookableProductConflict(java.lang.String sessionId,
                                       ProductIf bookableProd,
                                       BookableProductOptionsIf options)
                                       throws KKException
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. If a conflict is found then an array of conflicting bookable products is returned.

Parameters:
sessionId - The sessionId of the logged in customer
bookableProd - The bookable product being checked
options - Not used at the moment. May be left null.
Returns:
Returns null for no conflict. Otherwise an array of conflicting products is returned.
Throws:
KKException

getOrderStatus

int getOrderStatus(java.lang.String sessionId,
                   int orderId)
                   throws KKException
Get the order status for an order. The order doesn't have to belong to the logged in customer.

Parameters:
sessionId - The session id of the logged in user
orderId - The numeric id of the order
Returns:
Returns the order status. Returns -1 if the order doesn't exist.
Throws:
KKException

getAllOrderStatuses

OrderStatusIf[] getAllOrderStatuses(int languageId)
                                    throws KKException
Returns an array of order status objects for the language defined by languageId.

Parameters:
languageId - The id for the language that will be used to determine the customer group name and description. Value of -1 selects the default language.
Returns:
An array of order status objects.
Throws:
KKException

saveSSOToken

java.lang.String saveSSOToken(SSOTokenIf token)
                              throws KKException
Saves the SSOToken in the database and returns a UUID secret key identifier.

Parameters:
token - The SSO token to be saved
Returns:
Returns a UUID secret key identifier for the token
Throws:
KKException

getSSOToken

SSOTokenIf getSSOToken(java.lang.String secretKey,
                       boolean deleteToken)
                       throws KKException
Returns an SSOToken object for the secretKey (UUID). Null is returned if no token is found. If the deleteToken parameter is set to true, the token is deleted from the database after having been read.

Parameters:
secretKey - The UUID secretKey used to identify the token
deleteToken - The token is deleted from the database after being read
Returns:
Returns an SSOToken
Throws:
KKException

enableCustomer

void enableCustomer(java.lang.String secretKey)
                    throws KKException
This method reads the SSO token using the Secret Key. Once read, the token is deleted. The customer id read from the token is used to identify and enable the customer. An exception is thrown if a customer doesn't exist for the customer id found in the token.
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.

Parameters:
secretKey -
Throws:
KKException

checkCoupon

int checkCoupon(java.lang.String couponCode)
                throws KKException
This method is used to verify whether a coupon code actually exists and if it does, whether the coupon is still active. Valid return values for this method are: Even if the coupon exists and is active, it won't actually do anything if it isn't connected to a valid promotion and any rules associated with the promotion are also satisfied. However, this method may still be used to at least warn a customer that he may have mistyped the coupon code or that it is no longer valid.

Parameters:
couponCode - The coupon code
Returns:
Returns an integer
Throws:
KKException

getAllPromotions

PromotionIf[] getAllPromotions()
                               throws KKException
Returns an array of all active promotions. If a promotion is disabled or the current date is not within the start and end dates of the promotion, then it is not returned. Also if an OrderTotal module is not installed, then none of the promotions for that OrderTotal module are returned.

Returns:
Returns an array of all active promotions
Throws:
KKException

getPromotionsPerProducts

ProductIf[] getPromotionsPerProducts(java.lang.String sessionId,
                                     int customerId,
                                     ProductIf[] products,
                                     PromotionIf[] promotions,
                                     java.lang.String[] couponCodes,
                                     PromotionOptionsIf options)
                                     throws KKException
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. The PromotionResult contains the value of the discount, whether it is an amount or a percentage discount and also information regarding the promotion it applies to. If a product has an array of ProductQuantity objects (one for each SKU) each one of these may have an array of PromotionResult objects since a promotion may only apply to one product configuration and not to another (i.e. blue shirt and not red shirt).
The PromotionOptions object can be configured so that the values of the promotions for a product are subtracted from the product price. The options allow you to set rules that determine whether in this case the promotions need to be cumulative or whether the largest or smallest should be chosen. The calculation is only made for products with a single array of PromotionResult objects. It is not calculated for products that have an array of PromotionResult objects for each ProductQuantity.

Parameters:
sessionId - 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 processed
promotions - 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 null
options - An object containing information to configure the calculation for applying one or more promotion results to the product price.
Returns:
Returns the same array of products passed in as a parameter with attached PromotionResult objects if applicable
Throws:
KKException
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES