KKAdminIf (KonaKartAdmin API Documentation)

Method Summary
`void`	`addApiCallsToRole(java.lang.String sessionId, AdminApiCall[] apiCalls, int roleId)` Adds the array of AdminApiCall objects to the role identified by the roleId parameter.
`void`	`addCategoriesToPromotion(java.lang.String sessionId, AdminCategory[] categories, int promotionId, int rule)` Add the array of categories to the promotion identified by promotionId.
`void`	`addCouponsToPromotion(java.lang.String sessionId, AdminCoupon[] coupons, int promotionId)` Add the array of coupons to the promotion identified by promotionId.
`void`	`addCustomerGroupsToPromotion(java.lang.String sessionId, int[] groupIds, int promotionId, int rule)` Add the array of customer groups (identified by the group ids) to the promotion identified by promotionId.
`void`	`addCustomersToPromotion(java.lang.String sessionId, AdminCustomer[] customers, int promotionId, int rule, int maxUse)` Add the array of customers to the promotion identified by promotionId.
`void`	`addCustomersToPromotionPerOrdersMade(java.lang.String sessionId, java.util.Calendar lastOrderDate, boolean havePlacedOrder, int promotionId, int rule, int maxUse)` Add to the promotion identified by promotionId, the customers who have or haven't placed an order since the lastOrderDate passed in as a parameter.
`void`	`addManufacturersToPromotion(java.lang.String sessionId, AdminManufacturer[] manufacturers, int promotionId, int rule)` Add the array of manufacturers to the promotion identified by promotionId.
`void`	`addPanelsToRole(java.lang.String sessionId, AdminPanel[] panels, int roleId)` Adds the array of AdminPanel objects to the role identified by the roleId parameter.
`void`	`addProductsToPromotion(java.lang.String sessionId, AdminProduct[] products, int promotionId, int rule)` Add the array of products to the promotion.
`void`	`addPromotionsToCoupon(java.lang.String sessionId, AdminPromotion[] promotions, int couponId)` Add the array of promotions to the coupon identified by couponId.
`void`	`addRelatedProducts(java.lang.String sessionId, AdminProduct[] products, int productId, int relationType)` Add the array of products to the product defined by productId.
`void`	`addRolesToUser(java.lang.String sessionId, AdminRole[] roles, int userId)` Adds the array of AdminRole objects to the user identified by the userId parameter.
`void`	`addTagGroupsToCategory(java.lang.String sessionId, AdminTagGroup[] tagGroups, int categoryId)` Add the array of AdminTagGroups to the category identified by categoryId.
`void`	`addTagsToProduct(java.lang.String sessionId, AdminTag[] tags, int productId)` Add the array of AdminTags to the product identified by productId.
`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`	`checkSession(java.lang.String sessionId)` The given sessionId is checked to see whether it exists and whether it is has timed out.
`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.
`int`	`deleteAddressFormat(java.lang.String sessionId, int id)` Delete an AdminAddressFormat object referenced by it's id.
`void`	`deleteApiCall(java.lang.String sessionId, int apiCallId)` Deletes the apiCall identified by the apiCallId parameter.
`void`	`deleteAuditData(java.lang.String sessionId, AdminAuditSearch delSearch)` Delete audit data from the database.
`void`	`deleteCategoryTree(java.lang.String sessionId, int categoryId, int options)` Delete the category referenced to by categoryId.
`int`	`deleteCountry(java.lang.String sessionId, int id)` Delete a Country
`void`	`deleteCoupon(java.lang.String sessionId, int couponId)` Delete the coupon referenced by couponId.
`int`	`deleteCurrency(java.lang.String sessionId, int currId)` Delete a Currency
`int`	`deleteCustomer(java.lang.String sessionId, int custId)` Delete a Customer
`int`	`deleteCustomerGroup(java.lang.String sessionId, int custGroupId)` Delete a Customer Group.
`int`	`deleteExpiredSessions(java.lang.String sessionId)` Deletes all sessions that have expired.
`boolean`	`deleteFile(java.lang.String sessionId, java.lang.String fileName)` Delete the file.
`int`	`deleteGeoZone(java.lang.String sessionId, int id)` Delete a GeoZone
`int`	`deleteLanguage(java.lang.String sessionId, int langId)` Delete a Language
`void`	`deleteManufacturer(java.lang.String sessionId, int manufacturerId, boolean deleteProducts)` Delete the manufacturer and manufacturer info records.
`int`	`deleteOrder(java.lang.String sessionId, int ordId)` Deletes an order and all associated records (String sessionId, eg addreses, status history etc)
`void`	`deleteOrderReturn(java.lang.String sessionId, int orderRetId)` Delete the AdminOrderReturn object and any associated AdminOrderReturnProduct objects.
`int`	`deleteOrderStatusName(java.lang.String sessionId, int id)` Delete an OrderStatusName object
`void`	`deletePanel(java.lang.String sessionId, int panelId)` Deletes the panel identified by the panelId parameter.
`void`	`deleteProduct(java.lang.String sessionId, int productId)` Delete the product referenced by the productId parameter.
`void`	`deleteProductAttribute(java.lang.String sessionId, int productAttributeId)` Delete the productAttribute
`void`	`deleteProductAttributesPerProduct(java.lang.String sessionId, int productId)` Delete the productAttributes Per product
`void`	`deleteProductNotification(java.lang.String sessionId, AdminProductNotification apn)` Delete a Product Notification record for the specified customer and product if it's found.
`void`	`deleteProductOptions(java.lang.String sessionId, int productOptionId)` Delete a product option record for all languages and all of its records in the options values to options table and all of its values.
`void`	`deleteProductOptionValues(java.lang.String sessionId, int productOptionValueId)` Delete a product option value record for all languages and all of its records in the options values to options table
`void`	`deletePromotion(java.lang.String sessionId, int promotionId)` Delete the promotion referenced by promotionId.
`void`	`deleteReview(java.lang.String sessionId, int reviewId)` Delete the review and all entries in the reviews description table.
`void`	`deleteRole(java.lang.String sessionId, int roleId)` Deletes the role identified by the roleId parameter.
`void`	`deleteSingleCategory(java.lang.String sessionId, int categoryId)` Delete a single category and its descriptions.
`void`	`deleteSpecial(java.lang.String sessionId, int specialId)` Deletes the special referenced by the special id
`int`	`deleteSubZone(java.lang.String sessionId, int id)` Delete a SubZone
`void`	`deleteTag(java.lang.String sessionId, int id)` Delete a Tag object.
`void`	`deleteTagGroup(java.lang.String sessionId, int id)` Delete a TagGroup object
`int`	`deleteTaxClass(java.lang.String sessionId, int id)` Delete an AdminTaxClass object referenced by it's id.
`int`	`deleteTaxRate(java.lang.String sessionId, int id)` Delete an AdminTaxRate object referenced by it's id.
`int`	`deleteZone(java.lang.String sessionId, int id)` Delete an AdminZone object referenced by it's id.
`boolean`	`doesCustomerExistForEmail(java.lang.String sessionId, java.lang.String emailAddr)` Checks to see whether a customer already exists with this email address.
`void`	`editApiCall(java.lang.String sessionId, AdminApiCall apiCall)` Edit an ApiCall.
`void`	`editCategory(java.lang.String sessionId, AdminCategory cat)` The category is edited.
`void`	`editCoupon(java.lang.String sessionId, AdminCoupon coupon)` Edits the coupon, replacing existing data with data in the coupon parameter.
`void`	`editManufacturer(java.lang.String sessionId, AdminManufacturer manu)` Edits the manufacturer, replacing existing data with data in the manu parameter.
`void`	`editOrder(java.lang.String sessionId, AdminOrder order)` Edit an existing order.
`void`	`editOrderReturn(java.lang.String sessionId, AdminOrderReturn orderRet)` Edits the orderReturn, replacing existing data with data in the orderRet parameter.
`void`	`editPanel(java.lang.String sessionId, AdminPanel panel)` Edit a Panel.
`void`	`editProduct(java.lang.String sessionId, AdminProduct product)` Edits the product, replacing existing data with data in the product parameter.
`void`	`editProductAttribute(java.lang.String sessionId, AdminProductAttribute prodAttr)` Edits the product attribute, replacing existing data with data in the prodAttr parameter.
`void`	`editProductOption(java.lang.String sessionId, AdminProductOption productOption)` Edits the product option, replacing existing data with data in the productOption parameter.
`void`	`editProductOptionValue(java.lang.String sessionId, AdminProductOptionValue productOptionValue)` Edits the product option value, replacing existing data with data in the productOptionValue parameter.
`void`	`editPromotion(java.lang.String sessionId, AdminPromotion promotion)` Edits the promotion, replacing existing data with data in the promotion parameter.
`void`	`editReview(java.lang.String sessionId, AdminReview review)` Edits the review, replacing existing data with data in the review parameter.
`void`	`editRole(java.lang.String sessionId, AdminRole role)` Edit a Role.
`void`	`editSpecial(java.lang.String sessionId, AdminSpecial special)` Edits the special, replacing existing data with data in the special parameter.
`AdminAddressFormatSearchResult`	`getAddressFormats(AdminAddressFormatSearch search)` This returns an AdminAddressFormatSearchResult object.
`AdminAddressFormat[]`	`getAllAddressFormats()` This returns an array of all the address formats
`AdminApiCall[]`	`getAllApiCalls(java.lang.String sessionId)` Returns an array of all apiCalls in the database.
`AdminCountry[]`	`getAllCountriesFull()` Returns an array of all Country objects in the database.
`AdminGeoZone[]`	`getAllGeoZones()` Returns an array of all GeoZones in the database
`AdminLanguage[]`	`getAllLanguages()` Get all of the languages in the database
`AdminManufacturer[]`	`getAllManufacturers()` Get all manufacturers
`AdminOrderStatusName[]`	`getAllOrderStatuses(int orderStatus)` Returns a count of the Orders with the specified status.
`AdminPanel[]`	`getAllPanels(java.lang.String sessionId)` Returns an array of all panels in the database.
`AdminProductOption[]`	`getAllProductOptions(int languageId)` Return all product options in the database for any given language.
`AdminReviews`	`getAllReviews(java.lang.String sessionId, AdminDataDescriptor dataDesc)` Returns all reviews.
`AdminRole[]`	`getAllRoles(java.lang.String sessionId)` Returns an array of all Roles in the database.
`AdminProducts`	`getAllSpecials(java.lang.String sessionId, AdminDataDescriptor dataDesc, int languageId)` Returns an array of product objects which are all specials.
`AdminTaxClass[]`	`getAllTaxClassesFull()` Returns an array of all AdminTaxClass objects in the database.
`AdminTaxRateSearchResult`	`getAllTaxRates()` This returns an AdminTaxRateSearchResult object.
`AdminApiCall`	`getApiCall(java.lang.String sessionId, int apiCallId)` Returns the AdminApiCall referenced by the apiCallId.
`AdminApiCall[]`	`getApiCallsPerRole(java.lang.String sessionId, int roleId)` Retrieves an array of AdminApiCall objects for the role identified by the roleId parameter.
`AdminAuditSearchResult`	`getAuditData(java.lang.String sessionId, AdminAuditSearch retSearch, int offset, int size)` Retrieve audit data from the database.
`AdminProduct`	`getBundleProductDetails(java.lang.String sessionId, int bundleId, AdminProduct[] bundledProducts, AdminDiscount discount)` This method is used to calculate some attributes of a bundle product based on the products that the bundle contains.
`AdminCategory[]`	`getCategoriesPerPromotion(java.lang.String sessionId, int promotionId, int languageId)` Returns all of the categories for the promotion identified by promotionId.
`AdminCategory`	`getCategory(int categoryId, boolean getChildren, int languageId)` Returns either a single category object or a tree of category objects if getChildren is set to true.
`AdminCategory[]`	`getCategoryTree(int languageId, boolean getNumProducts)` Returns the complete category tree.
`AdminFile[]`	`getConfigFiles(java.lang.String sessionId)` Gets the Config files defined in konakart_config_files.xml
`java.lang.String[]`	`getConfigurationInfo(java.lang.String sessionId, java.lang.String[] validationKeys)` Get the configuration values for the given keys
`KKConfiguration[]`	`getConfigurationsByGroup(java.lang.String sessionId, int configGroup)` Get the configuration elements for the specified group
`AdminCountrySearchResult`	`getCountries(AdminCountrySearch search, int offset, int size)` This returns an AdminCountrySearchResult object.
`AdminCouponSearchResult`	`getCoupons(java.lang.String sessionId, AdminCouponSearch search, int offset, int size)` This returns an AdminCouponSearchResult object containing an array of AdminCoupons.
`AdminCoupon[]`	`getCouponsPerPromotion(java.lang.String sessionId, int promotionId)` Returns an array of Admin Coupon objects associated with the promotion identified by the promotionId parameter.
`AdminCurrencySearchResult`	`getCurrencies(AdminCurrencySearch search)` Returns an AdminCurrencySearchResult object.
`AdminCurrency`	`getCurrency(java.lang.String currencyCode)` Return the currency object for the specified currency code.
`AdminCustomer`	`getCustomerForEmail(java.lang.String sessionId, java.lang.String emailAddress)` Find and return a customer with an email address matching the emailAddress parameter.
`AdminCustomer`	`getCustomerForId(java.lang.String sessionId, int customerId)` Returns the customer object for the customer defined by the given id.
`AdminCustomerGroupSearchResult`	`getCustomerGroups(AdminCustomerGroupSearch search)` Return AdminCustomerGroups matching search criteria.
`AdminCustomerGroup[]`	`getCustomerGroupsPerPromotion(java.lang.String sessionId, int promotionId, int languageId)` Returns all of the customer groups for the promotion identified by promotionId.
`AdminCustomerSearchResult`	`getCustomers(java.lang.String sessionId, AdminCustomerSearch search, int offset, int size)` Returns a set of Customers that match the search criteria
`int`	`getCustomersCount(java.lang.String sessionId, AdminCustomerSearch search)` Returns a count of the number of Customers matching the specified search
`int`	`getCustomersCountWhoHaventPlacedAnOrderSince(java.lang.String sessionId, java.util.Calendar lastOrderDate)` Return the count of the number of customers who haven't placed an order since the lastOrderDate passed in as a parameter.
`int`	`getCustomersCountWhoHavePlacedAnOrderSince(java.lang.String sessionId, java.util.Calendar lastOrderDate)` Return the count of the number of customers who have placed an order since the lastOrderDate passed in as a parameter.
`AdminCustomerSearchResult`	`getCustomersLite(java.lang.String sessionId, AdminCustomerSearch search, int offset, int size)` Returns a set of "Lite" Customers that match the search criteria.
`AdminCustomValidatorSet`	`getCustomValidatorSet()` Gets an AdminCustomValidatorSet.
`AdminCurrency`	`getDefaultCurrency()` The default currency is referenced by a configuration variable called DEFAULT_CURRENCY.
`AdminLanguage`	`getDefaultLanguage()` Returns the default language.
`java.lang.String`	`getFileContents(java.lang.String sessionId, java.lang.String fileName)` Get the file contents.
`AdminGeoZoneSearchResult`	`getGeoZones(AdminGeoZoneSearch search, int offset, int size)` This returns an AdminGeoZoneSearchResult object.
`java.lang.String`	`getHelpMsg(java.lang.String msgKey, java.lang.String languageCode)` Return the help message for the specified language for the specified message key.
`java.lang.String`	`getHtml(java.lang.String sessionId, int htmlType, int id, int languageId, java.lang.String arg1)` Retrieve the html string for the specified html type, in the specified language.
`AdminLanguage`	`getLanguageByCode(java.lang.String code)` Returns the language referenced by the two letter lower case code (e.g.
`AdminLanguageSearchResult`	`getLanguages(AdminLanguageSearch search)` Returns an AdminLanguageSearchResult object.
`AdminManufacturer`	`getManufacturer(int manufacturerId)` Get a fully populated manufacturer
`AdminManufacturer[]`	`getManufacturersPerPromotion(java.lang.String sessionId, int promotionId)` Returns all of the manufacturers for the promotion identified by promotionId.
`KKModule[]`	`getModules(java.lang.String sessionId, int moduleType)` Get the available modules of the specified type.
`AdminMessageSet`	`getMsgs(java.lang.String languageCode)` Get a set of messages from the message catalog of the specified language.
`int`	`getNextProductOptionId(java.lang.String sessionId)` Get the next id to use when inserting a ProductOption record
`int`	`getNextProductOptionValuesId(java.lang.String sessionId)` Get the next id to use when inserting a ProductOptionValue record
`AdminOrder`	`getOrderForOrderId(java.lang.String sessionId, int orderId)` Retrieve an order for an orderId, using the default language
`AdminOrder`	`getOrderForOrderIdAndLangId(java.lang.String sessionId, int orderId, int languageId)` Returns an order for an orderId and a languageId.
`AdminOrderReturnSearchResult`	`getOrderReturns(java.lang.String sessionId, AdminOrderReturnSearch retSearch, int offset, int size)` Search for OrderReturn objects with search criteria and order by criteria.
`AdminOrderSearchResult`	`getOrders(java.lang.String sessionId, AdminOrderSearch search, int offset, int size, int languageId)` Returns a set of Orders that match the search criteria
`int`	`getOrdersCount(java.lang.String sessionId, int orderStatus)` Returns a count of the Orders with the specified status.
`AdminOrder[]`	`getOrdersCreatedSince(java.lang.String sessionId, java.util.Calendar since, int languageId)` Deprecated. From version 2.2.4.0 you should use getOrders().
`AdminOrderSearchResult`	`getOrdersLite(java.lang.String sessionId, AdminOrderSearch search, int offset, int size, int languageId)` Returns a set of Orders matching the specified search criteria - the orders returned are sparsely-populated with: id customer id customer name street address city formatted total price including tax purchase date order status id order status text custom1 custom2
`AdminOrderStatusNameSearchResult`	`getOrderStatusNames(AdminOrderStatusNameSearch search)` Returns an AdminOrderStatusNameSearchResult object.
`AdminPanel`	`getPanel(java.lang.String sessionId, int panelId)` Returns the AdminPanel referenced by the panelId.
`AdminPanel[]`	`getPanelsPerRole(java.lang.String sessionId, int roleId)` Retrieves an array of AdminPanel objects for the role identified by the roleId parameter.
`AdminProduct`	`getProduct(java.lang.String sessionId, int productId)` Get the product referenced by this product id, from the database.
`AdminProductAttribute[]`	`getProductAttributesPerProduct(java.lang.String sessionId, int productId)` Gets all of the product attributes for the product
`AdminProductOption[]`	`getProductOptionsPerId(java.lang.String sessionId, int productOptionId)` Returns an array of AdminProductOption objects.
`AdminProductOptionValue[]`	`getProductOptionValuesPerId(java.lang.String sessionId, int productOptionValueId)` Returns an array of productOptionValues.
`AdminProductOptionValue[]`	`getProductOptionValuesPerOption(int productOptionId, int languageId)` Return an array of product option value objects for a product option object
`AdminProducts`	`getProductsPerPromotion(java.lang.String sessionId, AdminProductSearch search, int offset, int size)` Get an array of Admin product objects for a promotion.
`AdminPromotion`	`getPromotion(java.lang.String sessionId, int id, boolean includeCoupons, boolean includeStats)` Get a promotion object and an array of associated coupon objects when applicable.
`AdminPromotionSearchResult`	`getPromotions(java.lang.String sessionId, AdminPromotionSearch search, int offset, int size)` This returns an AdminPromotionSearchResult object containing an array of AdminPromotions.
`int`	`getPromotionsCount(java.lang.String sessionId, AdminPromotionSearch search)` Returns a count of the number of AdminPromotions.
`AdminPromotion[]`	`getPromotionsPerCoupon(java.lang.String sessionId, int couponId)` Get an array of Admin promotion objects for a coupon.
`AdminProducts`	`getRelatedProducts(java.lang.String sessionId, AdminDataDescriptor dataDesc, int productId, int relationType, int languageId)` Find products related to the product defined by the productId parameter.
`AdminReport[]`	`getReports(java.lang.String sessionId)` Gets the reports
`AdminReview`	`getReview(java.lang.String sessionId, int reviewId)` Returns the review referenced by the review Id
`AdminReviews`	`getReviewsPerProduct(java.lang.String sessionId, AdminDataDescriptor dataDesc, int productId)` Returns the reviews for a product.
`AdminRole`	`getRole(java.lang.String sessionId, int roleId)` Returns the AdminRole referenced by the roleId.
`AdminRole[]`	`getRolesPerSessionId(java.lang.String sessionId)` Retrieves an array of AdminRole objects for the user logged in with the session id.
`AdminRole[]`	`getRolesPerUser(java.lang.String sessionId, int userId)` Retrieves an array of AdminRole objects for the user identified by the userId parameter.
`java.lang.String`	`getSku(java.lang.String sessionId, AdminOrderProduct orderProd)` Get the SKU for an orderProduct object.
`java.lang.String[]`	`getSkus(java.lang.String sessionId, AdminOrderProduct[] orderProds)` Get the SKUs for an array AdminOrderProduct objects.
`AdminSpecial`	`getSpecial(java.lang.String sessionId, int specialId)` Returns a special referenced by the id parameter
`AdminProducts`	`getSpecialsPerCategory(java.lang.String sessionId, AdminDataDescriptor dataDesc, int categoryId, int languageId)` Returns an array of product objects which are all specials, for a category
`AdminSubZoneSearchResult`	`getSubZones(AdminSubZoneSearch search, int offset, int size)` This returns an AdminSubZoneSearchResult object.
`AdminTagGroupSearchResult`	`getTagGroups(java.lang.String sessionId, AdminSearch search, int offset, int size)` Return the TagGroup objects defined by the search criteria.
`AdminTagGroup[]`	`getTagGroupsPerCategory(java.lang.String sessionId, int categoryId, int languageId)` Return an array of AdminTagGroup objects for a category.
`AdminTagSearchResult`	`getTags(java.lang.String sessionId, AdminSearch search, int offset, int size)` Return the Tag objects defined by the search criteria.
`AdminTag[]`	`getTagsPerProduct(java.lang.String sessionId, int productId, int languageId)` Fetches all of the tags associated with a product.
`AdminTaxClassSearchResult`	`getTaxClasses(AdminTaxClassSearch search)` This returns an AdminTaxClassSearchResult object.
`AdminTaxRateSearchResult`	`getTaxRates(AdminTaxRateSearch search, int offset, int size)` This returns an AdminTaxRateSearchResult object.
`AdminCategory[]`	`getTopLevelCategories(int languageId, AdminDataDescriptor dataDesc)` Returns all of the top level categories which are those that have a parentId = 0.
`AdminZoneSearchResult`	`getZones(AdminZoneSearch search, int offset, int size)` This returns an AdminZoneSearchResult object.
`AdminZone[]`	`getZonesById(int countryId)` Returns an array of fully-populated AdminZones for the specified countryId.
`int`	`insertAddressFormat(java.lang.String sessionId, AdminAddressFormat insertObj)` Insert an AdminAddressFormat object
`int`	`insertApiCall(java.lang.String sessionId, AdminApiCall apiCall)` Insert a new ApiCall.
`int`	`insertCategory(java.lang.String sessionId, AdminCategory cat)` Inserts a new category into the database.
`void`	`insertConfigs(java.lang.String sessionId, KKConfiguration[] config)` Insert one or more new configuration parameters
`int`	`insertCountry(java.lang.String sessionId, AdminCountry country)` Insert an AdminCountry object
`int`	`insertCoupon(java.lang.String sessionId, AdminCoupon coupon)` Inserts a coupon.
`int`	`insertCouponForPromotion(java.lang.String sessionId, AdminCoupon coupon, int promotionId)` Inserts a coupon and also a record in the promotion_to_coupon table to associate the coupon to a promotion.
`int`	`insertCurrency(java.lang.String sessionId, AdminCurrency curr)` Insert a Currency
`int`	`insertCustomerGroup(java.lang.String sessionId, AdminCustomerGroup custGroup)` Insert a Customer Group.
`int`	`insertCustomerGroups(java.lang.String sessionId, AdminCustomerGroup[] custGroups)` Insert an array of AdminCustomerGroup objects.
`void`	`insertDigitalDownload(java.lang.String sessionId, int customerId, int productId)` Create and insert a digital download record for the product identified by the `productId` and the customer identified by the `sessionId`.
`int`	`insertGeoZone(java.lang.String sessionId, AdminGeoZone insertObj)` Insert an AdminGeoZone object
`int`	`insertLanguage(java.lang.String sessionId, AdminLanguage lang)` Insert a Language
`int`	`insertManufacturer(java.lang.String sessionId, AdminManufacturer manu)` Insert a manufacturer
`int`	`insertOrderReturn(java.lang.String sessionId, AdminOrderReturn orderRet)` Insert an AdminOrderReturn object and its array of AdminOrderReturnProduct objects
`int`	`insertOrderStatusName(java.lang.String sessionId, AdminOrderStatusName obj)` Insert an OrderStatusName object
`int`	`insertOrderStatusNames(java.lang.String sessionId, AdminOrderStatusName[] ordStats)` Insert an array of AdminOrderStatusName objects.
`int`	`insertPanel(java.lang.String sessionId, AdminPanel panel)` Insert a new Panel.
`int`	`insertProduct(java.lang.String sessionId, AdminProduct product)` Insert the product.
`int`	`insertProductAttribute(java.lang.String sessionId, AdminProductAttribute prodAttr)` Inserts the product attribute
`void`	`insertProductNotification(java.lang.String sessionId, AdminProductNotification apn)` Insert a Product Notification record for the specified customer and product.
`void`	`insertProductOption(java.lang.String sessionId, AdminProductOption productOption)` Insert a product option
`int`	`insertProductOptions(java.lang.String sessionId, AdminProductOption[] productOptions)` The array of product options will all be inserted with the same id which is calculated by the system.
`void`	`insertProductOptionValue(java.lang.String sessionId, AdminProductOptionValue productOptionValue, int productOptionId)` Insert a product option value for a product option
`int`	`insertProductOptionValues(java.lang.String sessionId, AdminProductOptionValue[] productOptionValues, int productOptionId)` The array of product option values will all be inserted with the same id which is calculated by the system.
`int`	`insertPromotion(java.lang.String sessionId, AdminPromotion prom)` Inserts a promotion.
`int`	`insertReview(java.lang.String sessionId, AdminReview review)` A new review is inserted
`int`	`insertRole(java.lang.String sessionId, AdminRole role)` Insert a new Role.
`int`	`insertSpecial(java.lang.String sessionId, AdminSpecial special)` Inserts a new special
`int`	`insertSubZone(java.lang.String sessionId, AdminSubZone insertObj)` Insert an AdminSubZone object
`int`	`insertTag(java.lang.String sessionId, AdminTag tag)` Insert a new Tag object
`int`	`insertTagGroup(java.lang.String sessionId, AdminTagGroup tagGroup)` Insert a new TagGroup object
`int`	`insertTagGroups(java.lang.String sessionId, AdminTagGroup[] tagGroups)` Insert an array of TagGroup objects - provide a TagGroup object for each language
`int`	`insertTags(java.lang.String sessionId, AdminTag[] tags)` Insert an array of Tag objects - provide a Tag record for each supported language.
`int`	`insertTaxClass(java.lang.String sessionId, AdminTaxClass insertObj)` Insert an AdminTaxClass object
`int`	`insertTaxRate(java.lang.String sessionId, AdminTaxRate insertObj)` Insert an AdminTaxRate object
`int`	`insertZone(java.lang.String sessionId, AdminZone insertObj)` Insert an AdminZone object
`java.lang.String`	`login(java.lang.String user, java.lang.String password)` Used to log into the Admin application and get a session Id.

void

addApiCallsToRole(java.lang.String sessionId,
                  AdminApiCall[] apiCalls,
                  int roleId)

Adds the array of AdminApiCall objects to the role identified by the roleId parameter.

void

addCategoriesToPromotion(java.lang.String sessionId,
                         AdminCategory[] categories,
                         int promotionId,
                         int rule)

Add the array of categories to the promotion identified by promotionId.

void

addCouponsToPromotion(java.lang.String sessionId,
                      AdminCoupon[] coupons,
                      int promotionId)

Add the array of coupons to the promotion identified by promotionId.

void

addCustomerGroupsToPromotion(java.lang.String sessionId,
                             int[] groupIds,
                             int promotionId,
                             int rule)

Add the array of customer groups (identified by the group ids) to the promotion identified by promotionId.

void

addCustomersToPromotion(java.lang.String sessionId,
                        AdminCustomer[] customers,
                        int promotionId,
                        int rule,
                        int maxUse)

Add the array of customers to the promotion identified by promotionId.

void

addCustomersToPromotionPerOrdersMade(java.lang.String sessionId,
                                     java.util.Calendar lastOrderDate,
                                     boolean havePlacedOrder,
                                     int promotionId,
                                     int rule,
                                     int maxUse)

Add to the promotion identified by promotionId, the customers who have or haven't placed an order since the lastOrderDate passed in as a parameter.

void

addManufacturersToPromotion(java.lang.String sessionId,
                            AdminManufacturer[] manufacturers,
                            int promotionId,
                            int rule)

Add the array of manufacturers to the promotion identified by promotionId.

void

addPanelsToRole(java.lang.String sessionId,
                AdminPanel[] panels,
                int roleId)

Adds the array of AdminPanel objects to the role identified by the roleId parameter.

void

addProductsToPromotion(java.lang.String sessionId,
                       AdminProduct[] products,
                       int promotionId,
                       int rule)

Add the array of products to the promotion.

void

addPromotionsToCoupon(java.lang.String sessionId,
                      AdminPromotion[] promotions,
                      int couponId)

Add the array of promotions to the coupon identified by couponId.

void

addRelatedProducts(java.lang.String sessionId,
                   AdminProduct[] products,
                   int productId,
                   int relationType)

Add the array of products to the product defined by productId.

void

addRolesToUser(java.lang.String sessionId,
               AdminRole[] roles,
               int userId)

Adds the array of AdminRole objects to the user identified by the userId parameter.

void

addTagGroupsToCategory(java.lang.String sessionId,
                       AdminTagGroup[] tagGroups,
                       int categoryId)

Add the array of AdminTagGroups to the category identified by categoryId.

void

addTagsToProduct(java.lang.String sessionId,
                 AdminTag[] tags,
                 int productId)

Add the array of AdminTags to the product identified by productId.

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

checkSession(java.lang.String sessionId)
The given sessionId is checked to see whether it exists and whether it is has timed out.

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.

int

deleteAddressFormat(java.lang.String sessionId,
                    int id)

Delete an AdminAddressFormat object referenced by it's id.

void

deleteApiCall(java.lang.String sessionId,
              int apiCallId)

Deletes the apiCall identified by the apiCallId parameter.

void

deleteAuditData(java.lang.String sessionId,
                AdminAuditSearch delSearch)

Delete audit data from the database.

void

deleteCategoryTree(java.lang.String sessionId,
                   int categoryId,
                   int options)

Delete the category referenced to by categoryId.

int

deleteCountry(java.lang.String sessionId,
              int id)

Delete a Country

void

deleteCoupon(java.lang.String sessionId,
             int couponId)

Delete the coupon referenced by couponId.

int

deleteCurrency(java.lang.String sessionId,
               int currId)

Delete a Currency

int

deleteCustomer(java.lang.String sessionId,
               int custId)

Delete a Customer

int

deleteCustomerGroup(java.lang.String sessionId,
                    int custGroupId)

Delete a Customer Group.

int

deleteExpiredSessions(java.lang.String sessionId)
Deletes all sessions that have expired.

boolean

deleteFile(java.lang.String sessionId,
           java.lang.String fileName)

Delete the file.

int

deleteGeoZone(java.lang.String sessionId,
              int id)

Delete a GeoZone

int

deleteLanguage(java.lang.String sessionId,
               int langId)

Delete a Language

void

deleteManufacturer(java.lang.String sessionId,
                   int manufacturerId,
                   boolean deleteProducts)

Delete the manufacturer and manufacturer info records.

int

deleteOrder(java.lang.String sessionId,
            int ordId)

Deletes an order and all associated records (String sessionId, eg addreses, status history etc)

void

deleteOrderReturn(java.lang.String sessionId,
                  int orderRetId)

Delete the AdminOrderReturn object and any associated AdminOrderReturnProduct objects.

int

deleteOrderStatusName(java.lang.String sessionId,
                      int id)

Delete an OrderStatusName object

void

deletePanel(java.lang.String sessionId,
            int panelId)

Deletes the panel identified by the panelId parameter.

void

deleteProduct(java.lang.String sessionId,
              int productId)

Delete the product referenced by the productId parameter.

void

deleteProductAttribute(java.lang.String sessionId,
                       int productAttributeId)

Delete the productAttribute

void

deleteProductAttributesPerProduct(java.lang.String sessionId,
                                  int productId)

Delete the productAttributes Per product

void

deleteProductNotification(java.lang.String sessionId,
                          AdminProductNotification apn)

Delete a Product Notification record for the specified customer and product if it's found.

void

deleteProductOptions(java.lang.String sessionId,
                     int productOptionId)

Delete a product option record for all languages and all of its records in the options values to options table and all of its values.

void

deleteProductOptionValues(java.lang.String sessionId,
                          int productOptionValueId)

Delete a product option value record for all languages and all of its records in the options values to options table

void

deletePromotion(java.lang.String sessionId,
                int promotionId)

Delete the promotion referenced by promotionId.

void

deleteReview(java.lang.String sessionId,
             int reviewId)

Delete the review and all entries in the reviews description table.

void

deleteRole(java.lang.String sessionId,
           int roleId)

Deletes the role identified by the roleId parameter.

void

deleteSingleCategory(java.lang.String sessionId,
                     int categoryId)

Delete a single category and its descriptions.

void

deleteSpecial(java.lang.String sessionId,
              int specialId)

Deletes the special referenced by the special id

int

deleteSubZone(java.lang.String sessionId,
              int id)

Delete a SubZone

void

deleteTag(java.lang.String sessionId,
          int id)

Delete a Tag object.

void

deleteTagGroup(java.lang.String sessionId,
               int id)

Delete a TagGroup object

int

deleteTaxClass(java.lang.String sessionId,
               int id)

Delete an AdminTaxClass object referenced by it's id.

int

deleteTaxRate(java.lang.String sessionId,
              int id)

Delete an AdminTaxRate object referenced by it's id.

int

deleteZone(java.lang.String sessionId,
           int id)

Delete an AdminZone object referenced by it's id.

boolean

doesCustomerExistForEmail(java.lang.String sessionId,
                          java.lang.String emailAddr)

Checks to see whether a customer already exists with this email address.

void

editApiCall(java.lang.String sessionId,
            AdminApiCall apiCall)

Edit an ApiCall.

void

editCategory(java.lang.String sessionId,
             AdminCategory cat)

The category is edited.

void

editCoupon(java.lang.String sessionId,
           AdminCoupon coupon)

Edits the coupon, replacing existing data with data in the coupon parameter.

void

editManufacturer(java.lang.String sessionId,
                 AdminManufacturer manu)

Edits the manufacturer, replacing existing data with data in the manu parameter.

void

editOrder(java.lang.String sessionId,
          AdminOrder order)

Edit an existing order.

void

editOrderReturn(java.lang.String sessionId,
                AdminOrderReturn orderRet)

Edits the orderReturn, replacing existing data with data in the orderRet parameter.

void

editPanel(java.lang.String sessionId,
          AdminPanel panel)

Edit a Panel.

void

editProduct(java.lang.String sessionId,
            AdminProduct product)

Edits the product, replacing existing data with data in the product parameter.

void

editProductAttribute(java.lang.String sessionId,
                     AdminProductAttribute prodAttr)

Edits the product attribute, replacing existing data with data in the prodAttr parameter.

void

editProductOption(java.lang.String sessionId,
                  AdminProductOption productOption)

Edits the product option, replacing existing data with data in the productOption parameter.

void

editProductOptionValue(java.lang.String sessionId,
                       AdminProductOptionValue productOptionValue)

Edits the product option value, replacing existing data with data in the productOptionValue parameter.

void

editPromotion(java.lang.String sessionId,
              AdminPromotion promotion)

Edits the promotion, replacing existing data with data in the promotion parameter.

void

editReview(java.lang.String sessionId,
           AdminReview review)

Edits the review, replacing existing data with data in the review parameter.

void

editRole(java.lang.String sessionId,
         AdminRole role)

Edit a Role.

void

editSpecial(java.lang.String sessionId,
            AdminSpecial special)

Edits the special, replacing existing data with data in the special parameter.

AdminAddressFormatSearchResult

getAddressFormats(AdminAddressFormatSearch search)
This returns an AdminAddressFormatSearchResult object.

AdminAddressFormat[]

getAllAddressFormats()
This returns an array of all the address formats

AdminApiCall[]

getAllApiCalls(java.lang.String sessionId)
Returns an array of all apiCalls in the database.

AdminCountry[]

getAllCountriesFull()
Returns an array of all Country objects in the database.

AdminGeoZone[]

getAllGeoZones()
Returns an array of all GeoZones in the database

AdminLanguage[]

getAllLanguages()
Get all of the languages in the database

AdminManufacturer[]

getAllManufacturers()
Get all manufacturers

AdminOrderStatusName[]

getAllOrderStatuses(int orderStatus)
Returns a count of the Orders with the specified status.

AdminPanel[]

getAllPanels(java.lang.String sessionId)
Returns an array of all panels in the database.

AdminProductOption[]

getAllProductOptions(int languageId)
Return all product options in the database for any given language.

AdminReviews

getAllReviews(java.lang.String sessionId,
              AdminDataDescriptor dataDesc)

Returns all reviews.

AdminRole[]

getAllRoles(java.lang.String sessionId)
Returns an array of all Roles in the database.

AdminProducts

getAllSpecials(java.lang.String sessionId,
               AdminDataDescriptor dataDesc,
               int languageId)

Returns an array of product objects which are all specials.

AdminTaxClass[]

getAllTaxClassesFull()
Returns an array of all AdminTaxClass objects in the database.

AdminTaxRateSearchResult

getAllTaxRates()
This returns an AdminTaxRateSearchResult object.

AdminApiCall

getApiCall(java.lang.String sessionId,
           int apiCallId)

Returns the AdminApiCall referenced by the apiCallId.

AdminApiCall[]

getApiCallsPerRole(java.lang.String sessionId,
                   int roleId)

Retrieves an array of AdminApiCall objects for the role identified by the roleId parameter.

AdminAuditSearchResult

getAuditData(java.lang.String sessionId,
             AdminAuditSearch retSearch,
             int offset,
             int size)

Retrieve audit data from the database.

AdminProduct

getBundleProductDetails(java.lang.String sessionId,
                        int bundleId,
                        AdminProduct[] bundledProducts,
                        AdminDiscount discount)

This method is used to calculate some attributes of a bundle product based on the products that the bundle contains.

AdminCategory[]

getCategoriesPerPromotion(java.lang.String sessionId,
                          int promotionId,
                          int languageId)

Returns all of the categories for the promotion identified by promotionId.

AdminCategory

getCategory(int categoryId,
            boolean getChildren,
            int languageId)

Returns either a single category object or a tree of category objects if getChildren is set to true.

AdminCategory[]

getCategoryTree(int languageId,
                boolean getNumProducts)

Returns the complete category tree.

AdminFile[]

getConfigFiles(java.lang.String sessionId)
Gets the Config files defined in konakart_config_files.xml

java.lang.String[]

getConfigurationInfo(java.lang.String sessionId,
                     java.lang.String[] validationKeys)

Get the configuration values for the given keys

KKConfiguration[]

getConfigurationsByGroup(java.lang.String sessionId,
                         int configGroup)

Get the configuration elements for the specified group

AdminCountrySearchResult

getCountries(AdminCountrySearch search,
             int offset,
             int size)

This returns an AdminCountrySearchResult object.

AdminCouponSearchResult

getCoupons(java.lang.String sessionId,
           AdminCouponSearch search,
           int offset,
           int size)

This returns an AdminCouponSearchResult object containing an array of AdminCoupons.

AdminCoupon[]

getCouponsPerPromotion(java.lang.String sessionId,
                       int promotionId)

Returns an array of Admin Coupon objects associated with the promotion identified by the promotionId parameter.

AdminCurrencySearchResult

getCurrencies(AdminCurrencySearch search)
Returns an AdminCurrencySearchResult object.

AdminCurrency

getCurrency(java.lang.String currencyCode)
Return the currency object for the specified currency code.

AdminCustomer

getCustomerForEmail(java.lang.String sessionId,
                    java.lang.String emailAddress)

Find and return a customer with an email address matching the emailAddress parameter.

AdminCustomer

getCustomerForId(java.lang.String sessionId,
                 int customerId)

Returns the customer object for the customer defined by the given id.

AdminCustomerGroupSearchResult

getCustomerGroups(AdminCustomerGroupSearch search)
Return AdminCustomerGroups matching search criteria.

AdminCustomerGroup[]

getCustomerGroupsPerPromotion(java.lang.String sessionId,
                              int promotionId,
                              int languageId)

Returns all of the customer groups for the promotion identified by promotionId.

AdminCustomerSearchResult

getCustomers(java.lang.String sessionId,
             AdminCustomerSearch search,
             int offset,
             int size)

Returns a set of Customers that match the search criteria

int

getCustomersCount(java.lang.String sessionId,
                  AdminCustomerSearch search)

Returns a count of the number of Customers matching the specified search

int

getCustomersCountWhoHaventPlacedAnOrderSince(java.lang.String sessionId,
                                             java.util.Calendar lastOrderDate)

Return the count of the number of customers who haven't placed an order since the lastOrderDate passed in as a parameter.

int

getCustomersCountWhoHavePlacedAnOrderSince(java.lang.String sessionId,
                                           java.util.Calendar lastOrderDate)

Return the count of the number of customers who have placed an order since the lastOrderDate passed in as a parameter.

AdminCustomerSearchResult

getCustomersLite(java.lang.String sessionId,
                 AdminCustomerSearch search,
                 int offset,
                 int size)

Returns a set of "Lite" Customers that match the search criteria.

AdminCustomValidatorSet

getCustomValidatorSet()
Gets an AdminCustomValidatorSet.

AdminCurrency

getDefaultCurrency()
The default currency is referenced by a configuration variable called DEFAULT_CURRENCY.

AdminLanguage

getDefaultLanguage()
Returns the default language.

java.lang.String

getFileContents(java.lang.String sessionId,
                java.lang.String fileName)

Get the file contents.

AdminGeoZoneSearchResult

getGeoZones(AdminGeoZoneSearch search,
            int offset,
            int size)

This returns an AdminGeoZoneSearchResult object.

java.lang.String

getHelpMsg(java.lang.String msgKey,
           java.lang.String languageCode)

Return the help message for the specified language for the specified message key.

java.lang.String

getHtml(java.lang.String sessionId,
        int htmlType,
        int id,
        int languageId,
        java.lang.String arg1)

Retrieve the html string for the specified html type, in the specified language.

AdminLanguage

getLanguageByCode(java.lang.String code)
Returns the language referenced by the two letter lower case code (e.g.

AdminLanguageSearchResult

getLanguages(AdminLanguageSearch search)
Returns an AdminLanguageSearchResult object.

AdminManufacturer

getManufacturer(int manufacturerId)
Get a fully populated manufacturer

AdminManufacturer[]

getManufacturersPerPromotion(java.lang.String sessionId,
                             int promotionId)

Returns all of the manufacturers for the promotion identified by promotionId.

KKModule[]

getModules(java.lang.String sessionId,
           int moduleType)

Get the available modules of the specified type.

AdminMessageSet

getMsgs(java.lang.String languageCode)
Get a set of messages from the message catalog of the specified language.

int

getNextProductOptionId(java.lang.String sessionId)
Get the next id to use when inserting a ProductOption record

int

getNextProductOptionValuesId(java.lang.String sessionId)
Get the next id to use when inserting a ProductOptionValue record

AdminOrder

getOrderForOrderId(java.lang.String sessionId,
                   int orderId)

Retrieve an order for an orderId, using the default language

AdminOrder

getOrderForOrderIdAndLangId(java.lang.String sessionId,
                            int orderId,
                            int languageId)

Returns an order for an orderId and a languageId.

AdminOrderReturnSearchResult

getOrderReturns(java.lang.String sessionId,
                AdminOrderReturnSearch retSearch,
                int offset,
                int size)

Search for OrderReturn objects with search criteria and order by criteria.

AdminOrderSearchResult

getOrders(java.lang.String sessionId,
          AdminOrderSearch search,
          int offset,
          int size,
          int languageId)

Returns a set of Orders that match the search criteria

int

getOrdersCount(java.lang.String sessionId,
               int orderStatus)

Returns a count of the Orders with the specified status.

AdminOrder[]

getOrdersCreatedSince(java.lang.String sessionId,
                      java.util.Calendar since,
                      int languageId)

Deprecated. From version 2.2.4.0 you should use getOrders().

AdminOrderSearchResult

getOrdersLite(java.lang.String sessionId,
              AdminOrderSearch search,
              int offset,
              int size,
              int languageId)

Returns a set of Orders matching the specified search criteria - the orders returned are sparsely-populated with: id customer id customer name street address city formatted total price including tax purchase date order status id order status text custom1 custom2

AdminOrderStatusNameSearchResult

getOrderStatusNames(AdminOrderStatusNameSearch search)
Returns an AdminOrderStatusNameSearchResult object.

AdminPanel

getPanel(java.lang.String sessionId,
         int panelId)

Returns the AdminPanel referenced by the panelId.

AdminPanel[]

getPanelsPerRole(java.lang.String sessionId,
                 int roleId)

Retrieves an array of AdminPanel objects for the role identified by the roleId parameter.

AdminProduct

getProduct(java.lang.String sessionId,
           int productId)

Get the product referenced by this product id, from the database.

AdminProductAttribute[]

getProductAttributesPerProduct(java.lang.String sessionId,
                               int productId)

Gets all of the product attributes for the product

AdminProductOption[]

getProductOptionsPerId(java.lang.String sessionId,
                       int productOptionId)

Returns an array of AdminProductOption objects.

AdminProductOptionValue[]

getProductOptionValuesPerId(java.lang.String sessionId,
                            int productOptionValueId)

Returns an array of productOptionValues.

AdminProductOptionValue[]

getProductOptionValuesPerOption(int productOptionId,
                                int languageId)

Return an array of product option value objects for a product option object

AdminProducts

getProductsPerPromotion(java.lang.String sessionId,
                        AdminProductSearch search,
                        int offset,
                        int size)

Get an array of Admin product objects for a promotion.

AdminPromotion

getPromotion(java.lang.String sessionId,
             int id,
             boolean includeCoupons,
             boolean includeStats)

Get a promotion object and an array of associated coupon objects when applicable.

AdminPromotionSearchResult

getPromotions(java.lang.String sessionId,
              AdminPromotionSearch search,
              int offset,
              int size)

This returns an AdminPromotionSearchResult object containing an array of AdminPromotions.

int

getPromotionsCount(java.lang.String sessionId,
                   AdminPromotionSearch search)

Returns a count of the number of AdminPromotions.

AdminPromotion[]

getPromotionsPerCoupon(java.lang.String sessionId,
                       int couponId)

Get an array of Admin promotion objects for a coupon.

AdminProducts

getRelatedProducts(java.lang.String sessionId,
                   AdminDataDescriptor dataDesc,
                   int productId,
                   int relationType,
                   int languageId)

Find products related to the product defined by the productId parameter.

AdminReport[]

getReports(java.lang.String sessionId)
Gets the reports

AdminReview

getReview(java.lang.String sessionId,
          int reviewId)

Returns the review referenced by the review Id

AdminReviews

getReviewsPerProduct(java.lang.String sessionId,
                     AdminDataDescriptor dataDesc,
                     int productId)

Returns the reviews for a product.

AdminRole

getRole(java.lang.String sessionId,
        int roleId)

Returns the AdminRole referenced by the roleId.

AdminRole[]

getRolesPerSessionId(java.lang.String sessionId)
Retrieves an array of AdminRole objects for the user logged in with the session id.

AdminRole[]

getRolesPerUser(java.lang.String sessionId,
                int userId)

Retrieves an array of AdminRole objects for the user identified by the userId parameter.

java.lang.String

getSku(java.lang.String sessionId,
       AdminOrderProduct orderProd)

Get the SKU for an orderProduct object.

java.lang.String[]

getSkus(java.lang.String sessionId,
        AdminOrderProduct[] orderProds)

Get the SKUs for an array AdminOrderProduct objects.

AdminSpecial

getSpecial(java.lang.String sessionId,
           int specialId)

Returns a special referenced by the id parameter

AdminProducts

getSpecialsPerCategory(java.lang.String sessionId,
                       AdminDataDescriptor dataDesc,
                       int categoryId,
                       int languageId)

Returns an array of product objects which are all specials, for a category

AdminSubZoneSearchResult

getSubZones(AdminSubZoneSearch search,
            int offset,
            int size)

This returns an AdminSubZoneSearchResult object.

AdminTagGroupSearchResult

getTagGroups(java.lang.String sessionId,
             AdminSearch search,
             int offset,
             int size)

Return the TagGroup objects defined by the search criteria.

AdminTagGroup[]

getTagGroupsPerCategory(java.lang.String sessionId,
                        int categoryId,
                        int languageId)

Return an array of AdminTagGroup objects for a category.

AdminTagSearchResult

getTags(java.lang.String sessionId,
        AdminSearch search,
        int offset,
        int size)

Return the Tag objects defined by the search criteria.

AdminTag[]

getTagsPerProduct(java.lang.String sessionId,
                  int productId,
                  int languageId)

Fetches all of the tags associated with a product.

AdminTaxClassSearchResult

getTaxClasses(AdminTaxClassSearch search)
This returns an AdminTaxClassSearchResult object.

AdminTaxRateSearchResult

getTaxRates(AdminTaxRateSearch search,
            int offset,
            int size)

This returns an AdminTaxRateSearchResult object.

AdminCategory[]

getTopLevelCategories(int languageId,
                      AdminDataDescriptor dataDesc)

Returns all of the top level categories which are those that have a parentId = 0.

AdminZoneSearchResult

getZones(AdminZoneSearch search,
         int offset,
         int size)

This returns an AdminZoneSearchResult object.

AdminZone[]

getZonesById(int countryId)
Returns an array of fully-populated AdminZones for the specified countryId.

int

insertAddressFormat(java.lang.String sessionId,
                    AdminAddressFormat insertObj)

Insert an AdminAddressFormat object

int

insertApiCall(java.lang.String sessionId,
              AdminApiCall apiCall)

Insert a new ApiCall.

int

insertCategory(java.lang.String sessionId,
               AdminCategory cat)

Inserts a new category into the database.

void

insertConfigs(java.lang.String sessionId,
              KKConfiguration[] config)

Insert one or more new configuration parameters

int

insertCountry(java.lang.String sessionId,
              AdminCountry country)

Insert an AdminCountry object

int

insertCoupon(java.lang.String sessionId,
             AdminCoupon coupon)

Inserts a coupon.

int

insertCouponForPromotion(java.lang.String sessionId,
                         AdminCoupon coupon,
                         int promotionId)

Inserts a coupon and also a record in the promotion_to_coupon table to associate the coupon to a promotion.

int

insertCurrency(java.lang.String sessionId,
               AdminCurrency curr)

Insert a Currency

int

insertCustomerGroup(java.lang.String sessionId,
                    AdminCustomerGroup custGroup)

Insert a Customer Group.

int

insertCustomerGroups(java.lang.String sessionId,
                     AdminCustomerGroup[] custGroups)

Insert an array of AdminCustomerGroup objects.

void

insertDigitalDownload(java.lang.String sessionId,
                      int customerId,
                      int productId)

Create and insert a digital download record for the product identified by the productId and the customer identified by the sessionId.

int

insertGeoZone(java.lang.String sessionId,
              AdminGeoZone insertObj)

Insert an AdminGeoZone object

int

insertLanguage(java.lang.String sessionId,
               AdminLanguage lang)

Insert a Language

int

insertManufacturer(java.lang.String sessionId,
                   AdminManufacturer manu)

Insert a manufacturer

int

insertOrderReturn(java.lang.String sessionId,
                  AdminOrderReturn orderRet)

Insert an AdminOrderReturn object and its array of AdminOrderReturnProduct objects

int

insertOrderStatusName(java.lang.String sessionId,
                      AdminOrderStatusName obj)

Insert an OrderStatusName object

int

insertOrderStatusNames(java.lang.String sessionId,
                       AdminOrderStatusName[] ordStats)

Insert an array of AdminOrderStatusName objects.

int

insertPanel(java.lang.String sessionId,
            AdminPanel panel)

Insert a new Panel.

int

insertProduct(java.lang.String sessionId,
              AdminProduct product)

Insert the product.

int

insertProductAttribute(java.lang.String sessionId,
                       AdminProductAttribute prodAttr)

Inserts the product attribute

void

insertProductNotification(java.lang.String sessionId,
                          AdminProductNotification apn)

Insert a Product Notification record for the specified customer and product.

void

insertProductOption(java.lang.String sessionId,
                    AdminProductOption productOption)

Insert a product option

int

insertProductOptions(java.lang.String sessionId,
                     AdminProductOption[] productOptions)

The array of product options will all be inserted with the same id which is calculated by the system.

void

insertProductOptionValue(java.lang.String sessionId,
                         AdminProductOptionValue productOptionValue,
                         int productOptionId)

Insert a product option value for a product option

int

insertProductOptionValues(java.lang.String sessionId,
                          AdminProductOptionValue[] productOptionValues,
                          int productOptionId)

The array of product option values will all be inserted with the same id which is calculated by the system.

int

insertPromotion(java.lang.String sessionId,
                AdminPromotion prom)

Inserts a promotion.

int

insertReview(java.lang.String sessionId,
             AdminReview review)

A new review is inserted

int

insertRole(java.lang.String sessionId,
           AdminRole role)

Insert a new Role.

int

insertSpecial(java.lang.String sessionId,
              AdminSpecial special)

Inserts a new special

int

insertSubZone(java.lang.String sessionId,
              AdminSubZone insertObj)

Insert an AdminSubZone object

int

insertTag(java.lang.String sessionId,
          AdminTag tag)

Insert a new Tag object

int

insertTagGroup(java.lang.String sessionId,
               AdminTagGroup tagGroup)

Insert a new TagGroup object

int

insertTagGroups(java.lang.String sessionId,
                AdminTagGroup[] tagGroups)

Insert an array of TagGroup objects - provide a TagGroup object for each language

int

insertTags(java.lang.String sessionId,
           AdminTag[] tags)

Insert an array of Tag objects - provide a Tag record for each supported language.

int

insertTaxClass(java.lang.String sessionId,
               AdminTaxClass insertObj)

Insert an AdminTaxClass object

int

insertTaxRate(java.lang.String sessionId,
              AdminTaxRate insertObj)

Insert an AdminTaxRate object

int

insertZone(java.lang.String sessionId,
           AdminZone insertObj)

Insert an AdminZone object

java.lang.String

login(java.lang.String user,
      java.lang.String password)

Used to log into the Admin application and get a session Id.

com.konakartadmin.appif Interface KKAdminIf

com.konakartadmin.appif
Interface KKAdminIf