public class KKAdmin extends KKAdminBase implements KKAdminIf
adminEng, allConfig, configFile, configFileURL, emailReportingExclusions, engConf, engineCacheMgr, globalInit, kkCartInit, kkConfig, kkInstanceId, konakartAdminPropsFileName, konakartAdminPropsFilePath, log, logMgr, mgrFactory, mutex, torqueConfig, torqueInit| Constructor and Description |
|---|
KKAdmin()
Deprecated.
From version 2.2.7.0, you should use the constructor that receives an
AdminEngineConfig object
|
KKAdmin(AdminEngineConfig engConf)
Constructor with an EngineConfig object.
|
KKAdmin(java.lang.String propertiesFileName)
Deprecated.
From version 2.2.7.0, you should use the constructor that receives an
AdminEngineConfig object
|
| Modifier and Type | Method and Description |
|---|---|
void |
addAddressesToProduct(java.lang.String sessionId,
AdminAddress[] addresses,
int productId)
Associate an array of addresses to a product.
|
void |
addAllProductsToSearchEngine(java.lang.String sessionId,
boolean async)
Add all products in the KonaKart database to the search engine.
|
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 |
addCatalogRules(java.lang.String sessionId,
java.lang.String catalogId,
AdminCatalogRule[] rules)
The purpose of this method is to add an array of rules to a catalog so that it can be created
automatically using
createCatalogPricesFromRules() using the rules to make price
adjustments to products within selected categories and to include or exclude products from
selected categories. |
void |
addCategoriesToPromotion(java.lang.String sessionId,
AdminCategory[] categories,
int promotionId,
int rule)
Add the array of categories to the promotion identified by promotionId.
|
void |
addCategoriesToTagGroups(java.lang.String sessionId,
int tagGroupId,
int[] categories)
Add the array of categories to the tagGroup specified.
|
void |
addChildrenToCustomer(java.lang.String sessionId,
int parentId,
AdminCustomer[] children)
The array of AdminCustomer children objects are given the parent id passed in as a parameter.
|
void |
addCouponsToPromotion(java.lang.String sessionId,
AdminCoupon[] coupons,
int promotionId)
Add the array of coupons to the promotion identified by promotionId.
|
void |
addCustomDataToSession(java.lang.String sessionId,
java.lang.String data,
int position)
A sessionId is created when a customer logs in to the KonaKart Admin App using the login()
API call.
|
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 |
addExpressionsToPromotion(java.lang.String sessionId,
AdminExpression[] expressions,
int promotionId)
Add the array of expressions to the promotion identified by promotionId.
|
void |
addGiftCertificatesToPromotion(java.lang.String sessionId,
AdminProduct[] giftCertificates,
int promotionId)
Add the array of gift certificate products to the promotion.
|
void |
addImage(java.lang.String sessionId,
AdminImageOptions options)
Add the image to the object defined in the AdminImageOptions object.
|
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.
|
int |
addPoints(java.lang.String sessionId,
int customerId,
int points,
java.lang.String code,
java.lang.String description)
Adds a number of reward points to the total for the customer identified by the
customerId parameter. |
void |
addProdAttrDescsToTemplate(java.lang.String sessionId,
AdminProdAttrDesc[] attrDescs,
int templateId)
Add the array of AdminProdAttrDesc objects to the template.
|
void |
addProductsToPromotion(java.lang.String sessionId,
AdminProduct[] products,
int promotionId,
int rule)
Add the array of products to the promotion.
|
void |
addProductToSearchEngine(java.lang.String sessionId,
int productId)
Add the product referenced by productId to the search engine.
|
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 |
addRelatedProductsWithOptions(java.lang.String sessionId,
AdminProduct[] products,
int productId,
int relationType,
AdminProductMgrOptions mgrOptions)
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 |
addVendorToStore(java.lang.String sessionId,
int vendorId,
java.lang.String vendorStoreId)
Associates a vendor with a store.
|
com.konakart.app.NameValue[] |
callPaymentModule(java.lang.String sessionId,
java.lang.String moduleClassName,
com.konakart.app.PaymentOptions options)
This method is used to call a payment module from the Admin App.
|
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.
|
void |
changeUserPassword(java.lang.String user,
java.lang.String currentPassword,
java.lang.String newPassword)
Change a user's password.
|
boolean |
checkDataIntegrity(java.lang.String sessionId,
AdminDataIntegrityOptions dataIntegrityOptions)
Checks the integrity of data in the specified area in the KonaKart database
|
boolean |
checkPasswordValidity(java.lang.String sessionId,
java.lang.String password,
int userId)
Is the password valid?
|
int |
checkSession(java.lang.String sessionId)
The given sessionId is checked to see whether it exists and whether it is has timed out.
|
protected void |
checkStoreStatus(int customerId)
Check that the store should continue to execute API functions.
|
protected void |
checkStoreStatus(java.lang.String sessId)
Check that the store should continue to execute API functions.
|
AdminCloneCustomerResult |
cloneCustomer(java.lang.String sessionId,
int cloneCustId,
java.lang.String[] stores)
This API call is used to clone customers across multiple stores and is only available when in
multi-store single DB, non shared customer mode.
|
void |
cloneStore(java.lang.String sessionId,
AdminNewStoreOptions options,
java.lang.String storeToCloneId,
AdminStore newStore)
Insert a new store into the mall by cloning a specified store.
|
boolean |
copyFile(java.lang.String sessionId,
java.lang.String srcFileName,
java.lang.String dstFileName)
Copy the source file to the destination file.
|
boolean |
copyFiles(java.lang.String sessionId,
java.lang.String[] srcFileNames,
java.lang.String[] dstFileNames)
Copy the source files to the destination files.
|
int |
copyProductToStore(java.lang.String sessionId,
int productId,
java.lang.String storeIdFrom,
java.lang.String storeIdTo,
AdminCopyProductOptions options)
Copies a product from the store referenced by storeIdFrom to the store referenced by
storeIdTo .
|
AdminCreateCatalogPricesResult |
createCatalogPricesFromRules(java.lang.String sessionId,
java.lang.String catalogId,
AdminCreateCatalogPriceOptions options)
This method populates a catalog with product prices based on rules that have been previously
added using the
addCatalogRules() method. |
void |
createMailingList(java.lang.String sessionId,
AdminCustomerSearch search,
AdminMailListOptions listOptions)
Create a mailing list file on disk that contains a record for every customer defined by the
AdminCustomerSearch 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 |
deleteAddress(java.lang.String sessionId,
int addressId)
Deletes an AdminAddress.
|
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 |
deleteBooking(java.lang.String sessionId,
int bookingId,
AdminBookableProductOptions options)
Delete the booking with the specified bookingId.
|
void |
deleteCatalog(java.lang.String sessionId,
int catalogId)
Delete a Catalog definition from the database
|
void |
deleteCatalogWithOptions(java.lang.String sessionId,
int catalogId,
AdminDeleteCatalogOptions options)
Delete a Catalog definition from the database with Options
|
void |
deleteCategoryTree(java.lang.String sessionId,
int categoryId,
int options)
Delete the category referenced to by categoryId.
|
void |
deleteContent(java.lang.String sessionId,
int contentId)
Delete an AdminContent object - all associated AdminContentDescriptions are also deleted
|
void |
deleteContentType(java.lang.String sessionId,
int contentTypeId)
Delete an AdminContentType object - all associated AdminContentTypeDescriptions are also
deleted
|
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.
|
AdminDeleteCustomerResult |
deleteCustomerMultiStore(java.lang.String sessionId,
int customerId,
java.lang.String[] stores)
This API call is used to delete customers across multiple stores and is only available when
in multi-store single DB, non shared customer mode.
|
int |
deleteCustomerTag(java.lang.String sessionId,
int id)
Delete a Customer tag
|
void |
deleteCustomerTagForCustomer(java.lang.String sessionId,
int customerId,
java.lang.String tagName)
Deletes the value of the customer tag referenced by
tagName for the customer
referenced by customerId. |
int |
deleteExpiredSessions(java.lang.String sessionId)
Deletes all sessions that have expired.
|
int |
deleteExpression(java.lang.String sessionId,
int id)
Deletes the Expression object referenced by
id. |
int |
deleteExpressionVariable(java.lang.String sessionId,
int id)
Deletes the ExpressionVariable object referenced by
id. |
void |
deleteExpressionVariablesForExpression(java.lang.String sessionId,
int expressionId)
Deletes all of the AdminExpressionVariable objects belonging to the AdminExpression
referenced by
expressionId. |
boolean |
deleteFile(java.lang.String sessionId,
java.lang.String fileName)
Delete the file.
|
void |
deleteFilter(java.lang.String sessionId,
int id)
Delete an AdminFilter object
|
void |
deleteFiltersForCustomer(java.lang.String sessionId,
int custId)
Delete all the AdminFilter objects associated with the specified customer
|
int |
deleteGeoZone(java.lang.String sessionId,
int id)
Delete a GeoZone.
|
void |
deleteKKEvents(java.lang.String sessionId,
com.konakart.app.KKEventSearch search)
Delete all the events matching the event search criteria
|
int |
deleteLanguage(java.lang.String sessionId,
int langId)
Delete a Language.
|
void |
deleteMallStore(java.lang.String sessionId,
java.lang.String storeId)
Deletes an AdminStore object.
|
void |
deleteManufacturer(java.lang.String sessionId,
int manufacturerId,
boolean deleteProducts)
Delete the manufacturer and manufacturer info records.
|
void |
deleteMiscItem(java.lang.String sessionId,
int miId)
Delete an AdminMiscItem.
|
void |
deleteMiscItemType(java.lang.String sessionId,
int miTypeId,
boolean deleteChildren)
Delete an AdminMiscItemType.
|
void |
deleteMiscPrices(java.lang.String sessionId,
AdminMiscPriceSearch miscPriceSearch)
Delete the AdminMiscPrice objects that match the specified AdminMiscPriceSearch object
|
void |
deleteMsg(java.lang.String sessionId,
java.lang.String key,
int type,
java.lang.String locale)
Delete a Message from the database
|
int |
deleteOrder(java.lang.String sessionId,
int ordId)
Deletes an order and all associated records (eg addresses, status history etc).
|
void |
deleteOrderRefund(java.lang.String sessionId,
int orderRefundId)
Delete the AdminOrderRefund object.
|
void |
deleteOrderReturn(java.lang.String sessionId,
int orderRetId)
Delete the AdminOrderReturn object and any associated AdminOrderReturnProduct objects.
|
int |
deleteOrderReturnStatus(java.lang.String sessionId,
int id)
Delete an OrderReturnStatus object.
|
void |
deleteOrderShipment(java.lang.String sessionId,
int orderShipmentId)
Delete the AdminOrderShipment object and any associated AdminOrderShipmentProduct 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.
|
int |
deletePaymentSchedule(java.lang.String sessionId,
int id)
Delete a Payment Schedule Object
|
int |
deletePoints(java.lang.String sessionId,
int customerId,
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
customerId parameter. |
int |
deleteProdAttrDesc(java.lang.String sessionId,
int id)
Delete an AdminProdAttrDesc
|
int |
deleteProdAttrDescWithOptions(java.lang.String sessionId,
int id,
AdminProdAttrDescOptions options)
Delete an AdminProdAttrDesc
|
int |
deleteProdAttrTemplate(java.lang.String sessionId,
int id)
Delete an AdminProdAttrTemplate object.
|
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 |
deleteProducts(java.lang.String sessionId,
AdminCommonOptions options)
Delete the products referenced by the options parameter.
|
void |
deletePromotion(java.lang.String sessionId,
int promotionId)
Delete the promotion referenced by promotionId.
|
void |
deletePromotionWithOptions(java.lang.String sessionId,
int promotionId,
AdminDeletePromotionOptions options)
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 |
deleteReviewsPerCustomer(java.lang.String sessionId,
int customerId)
Delete all the reviews written by a customer.
|
void |
deleteRole(java.lang.String sessionId,
int roleId)
Deletes the role identified by the roleId parameter.
|
int |
deleteShipper(java.lang.String sessionId,
int shipperId)
Delete a Shipper
|
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 |
deleteSubscription(java.lang.String sessionId,
int id)
Delete a Subscription Object
|
int |
deleteSubZone(java.lang.String sessionId,
int id)
Delete a SubZone.
|
void |
deleteSuggestions(java.lang.String sessionId,
AdminSuggestion suggestion)
This deletes Product Recommendation Suggestion records from the database.
|
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.
|
void |
deleteVendor(java.lang.String sessionId,
int vendorId)
Delete a vendor together with any addresses and reviews associated with the vendor.
|
void |
deleteVendorReview(java.lang.String sessionId,
int reviewId)
Delete the vendor review and all entries in the reviews description table.
|
void |
deleteVendorReviewsPerCustomer(java.lang.String sessionId,
int customerId)
Delete all the vendor reviews written by a customer.
|
void |
deleteWishList(java.lang.String sessionId,
int wishListId)
Delete a wish list and all of its wish list items.
|
void |
deleteWishListItem(java.lang.String sessionId,
int wishListItemId)
Delete a wish list and all of its wish list items.
|
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.
|
boolean |
doesMallStoreExist(java.lang.String storeId)
Does the specified store exist?
|
boolean |
doesProductExist(java.lang.String sessionId,
int productId)
Is there a product in the database with the specified productId
|
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 |
editOrderRefund(java.lang.String sessionId,
AdminOrderRefund orderRefund)
Edits the AdminOrderRefund object, replacing existing data with data in the orderRefund
parameter.
|
void |
editOrderReturn(java.lang.String sessionId,
AdminOrderReturn orderRet)
Edits the orderReturn, replacing existing data with data in the orderRet parameter.
|
void |
editOrderShipment(java.lang.String sessionId,
AdminOrderShipment orderShipment)
Edits the orderShipment, replacing existing data with data in the orderShipment 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 |
editProductWithOptions(java.lang.String sessionId,
AdminProduct product,
AdminProductMgrOptions mgrOptions)
Edit a product and its product description objects.
|
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.
|
boolean |
evaluateExpression(java.lang.String sessionId,
int customerId,
int expressionId,
java.lang.String expressionName)
An expression object is retrieved from the database and evaluated for the customer referenced
by the
customerId. |
java.lang.String |
execute(java.lang.String sessionId,
java.lang.String className,
java.lang.String methodName,
java.lang.String[] paramArray)
Executes a method with name methodName of a class with name className with the parameters of
type String in paramArray.
|
java.lang.String |
exportMsgs(int type,
java.lang.String locale)
Export Messages from the database
|
com.konakart.app.ExportOrderResponse |
exportOrder(java.lang.String sessionId,
com.konakart.app.ExportOrderOptions options)
Exports the Order
|
int |
forceRegisterCustomer(java.lang.String sessionId,
AdminCustomerRegistration custReg)
Register a new customer.
|
AdminAddress |
getAddressById(java.lang.String sessionId,
int addressId)
Get Addresses defined by the search criteria
|
AdminAddressSearchResult |
getAddresses(java.lang.String sessionId,
AdminAddressSearch search,
int offset,
int size)
Get Addresses defined by the search criteria
|
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.
|
AdminConfigurationGroup[] |
getAllConfigurationGroups(java.lang.String sessionId)
Returns an array of all the Configuration Group objects.
|
KKConfiguration[] |
getAllConfigurations(java.lang.String sessionId)
Returns an array of all the Configuration objects.
|
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 ordered by name.
|
AdminOrderReturnStatus[] |
getAllOrderReturnStatuses(int languageId)
Returns an array of AdminOrderReturnStatus objects for the specified languageId.
|
AdminOrderStatusName[] |
getAllOrderStatuses(int languageId)
Returns an array of AdminOrderStatusNames for the specified languageId.
|
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.
|
AdminProductOptionValue[] |
getAllProductOptionValues(java.lang.String sessionId,
int languageId)
Get an array of all the product option value objects for the specified 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 AdminProducts object containing 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.
|
AdminBookingSearchResult |
getBookings(java.lang.String sessionId,
AdminBookingSearch search,
int offset,
int size,
AdminBookableProductOptions options)
Search for bookings.
|
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.
|
AdminCatalog |
getCatalogById(java.lang.String sessionId,
int catalogId)
Fetch a catalog from the database referenced by the catalog id
|
AdminCatalogRule[] |
getCatalogRules(java.lang.String sessionId,
java.lang.String catalogId)
The purpose of this method is fetch an array of catalog rules which are used by
createCatalogPricesFromRules() to automatically create the catalog using the
rules to make price adjustments to products within selected categories and to include or
exclude products from selected categories. |
AdminCatalogSearchResult |
getCatalogs(java.lang.String sessionId,
AdminCatalogSearch search,
int offset,
int size)
Get an array of catalogs matching the search criteria from the database.
|
AdminCategory[] |
getCategoriesPerPromotion(java.lang.String sessionId,
int promotionId,
int languageId)
Returns all of the categories for the promotion identified by promotionId.
|
int[] |
getCategoriesPerTagGroup(java.lang.String sessionId,
int tagGroupId)
Return an array of Category Ids linked to the specified tag group.
|
AdminCategoryToTagGroup[] |
getCategoriesToTagGroups(java.lang.String sessionId)
Return an array of all of the AdminCategoryToTagGroup records.
|
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.
|
AdminConfigData[] |
getConfigData(java.lang.String sessionId,
java.lang.String key)
Returns the AdminConfigData items with the specified key or all AdminConfigData items if the
key is null
|
AdminFile[] |
getConfigFiles(java.lang.String sessionId)
Gets the Config files defined in konakart_config_files.xml
|
KKConfiguration |
getConfigurationByKey(java.lang.String sessionId,
java.lang.String key)
Returns a KKConfiguration object with the specified key.
|
AdminConfigurationGroup[] |
getConfigurationGroupsByTitle(java.lang.String sessionId,
java.lang.String title)
Returns an array of AdminConfigurationGroup objects with the specified title.
|
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
|
AdminContent |
getContent(java.lang.String sessionId,
int contentId)
Returns the content referenced by the contentId.
|
AdminContentSearchResult |
getContents(java.lang.String sessionId,
AdminContentSearch search,
AdminDataDescriptor dataDesc)
Returns an array of content records matching the search criteria.
|
AdminContentType |
getContentType(java.lang.String sessionId,
int contentTypeId)
Returns the AdminContentType referenced by the contentTypeId.
|
AdminContentTypeSearchResult |
getContentTypes(java.lang.String sessionId,
AdminContentTypeSearch search,
AdminDataDescriptor dataDesc)
Returns an array of AdminContentType records matching the search criteria.
|
AdminCountrySearchResult |
getCountries(AdminCountrySearch search,
int offset,
int count)
This returns an AdminCountrySearchResult object.
|
java.lang.String |
getCouponCode(java.lang.String sessionId,
java.lang.String options)
This method may be customized in the OrderIntegrationMgr to implement an algorithm that
creates a coupon code or to read a coupon code from an external source.
|
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.
|
java.lang.String |
getCustomDataFromSession(java.lang.String sessionId,
int position)
A sessionId is created when a customer logs in to KonaKart Admin App using the login() API
call.
|
AdminCustomer |
getCustomerForEmail(java.lang.String sessionId,
java.lang.String emailAddress)
Find and return a customer with an email address matching the emailAddress parameter.
|
AdminCustomer |
getCustomerForEmailWithOptions(java.lang.String sessionId,
java.lang.String emailAddress,
AdminGetCustomerOptions options)
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.
|
AdminCustomer |
getCustomerForIdWithOptions(java.lang.String sessionId,
int customerId,
AdminGetCustomerOptions options)
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.
|
AdminCustomerTag |
getCustomerTag(java.lang.String sessionId,
int id)
Returns the AdminCustomerTag object for the
id parameter, or Null if the
customer tag doesn't exist in the DB. |
AdminCustomerTag |
getCustomerTagForCustomer(java.lang.String sessionId,
int customerId,
java.lang.String tagName)
Returns the customer tag object for the
tagName parameter, or Null if the
customer tag doesn't exist in the DB. |
AdminCustomerTag |
getCustomerTagForName(java.lang.String sessionId,
java.lang.String tagName)
Returns the customer tag object for the
tagName parameter, or Null if the
customer tag doesn't exist in the DB. |
AdminCustomerTagSearchResult |
getCustomerTags(java.lang.String sessionId,
AdminCustomerTagSearch search,
int offset,
int size)
Returns an AdminCustomerTagSearchResult object.
|
AdminCustomerTag[] |
getCustomerTagsForCustomer(java.lang.String sessionId,
int customerId)
This method fetches all of the customer tags for the customer referenced by the
customerId parameter. |
AdminCustomValidatorSet |
getCustomValidatorSet()
Gets an AdminCustomValidatorSet.
|
protected AdminEngineConfig |
getDefaultAdminEngConfig() |
AdminCurrency |
getDefaultCurrency()
The default currency is referenced by a configuration variable called DEFAULT_CURRENCY.
|
AdminLanguage |
getDefaultLanguage()
Returns the default language.
|
AdminExpression |
getExpression(java.lang.String sessionId,
int id)
Returns the AdminExpression object for the
id parameter, or Null if the
AdminExpression doesn't exist in the DB. |
AdminExpression |
getExpressionForName(java.lang.String sessionId,
java.lang.String expName)
Returns the AdminExpression object for the
expName parameter, or Null if the
AdminExpression doesn't exist in the DB. |
AdminExpressionSearchResult |
getExpressions(java.lang.String sessionId,
AdminExpressionSearch search,
int offset,
int size)
This returns an AdminExpressionSearchResult object.
|
AdminExpression[] |
getExpressionsPerPromotion(java.lang.String sessionId,
int promotionId)
Fetch an array of Expression objects linked to the promotion referenced by
promotionId |
AdminExpressionVariable |
getExpressionVariable(java.lang.String sessionId,
int id)
Returns the AdminExpressionVariable object for the
id parameter, or Null if the
AdminExpressionVariable doesn't exist in the DB. |
AdminExpressionVariable[] |
getExpressionVariablesForExpression(java.lang.String sessionId,
int expressionId)
Returns an array of AdminExpressionVariable objects for the AdminExpression identified by the
id parameter. |
java.lang.String |
getFileContents(java.lang.String sessionId,
java.lang.String fileName)
Get the file contents.
|
byte[] |
getFileContentsAsByteArray(java.lang.String sessionId,
java.lang.String fileName)
Get the file contents as a byte array.
|
AdminFile[] |
getFiles(java.lang.String sessionId,
java.lang.String directory,
java.lang.String extension)
Returns an array of files found in the directory ordered by lastModified date descending.
|
AdminFilter |
getFilter(java.lang.String sessionId,
int Id)
Returns the filter referenced by the Id.
|
AdminFilterSearchResult |
getFilters(java.lang.String sessionId,
AdminFilterSearch search,
AdminDataDescriptor dataDesc)
Returns an array of filter records matching the search criteria.
|
AdminFilter[] |
getFiltersForCustomer(java.lang.String sessionId,
int custId)
Returns an array of filter records matching the search criteria.
|
AdminGeoZoneSearchResult |
getGeoZones(AdminGeoZoneSearch search,
int offset,
int size)
This returns an AdminGeoZoneSearchResult object.
|
AdminProducts |
getGiftCertificatesPerPromotion(java.lang.String sessionId,
AdminProductSearch search,
int offset,
int size)
Get an array of Admin product gift certificate objects for a promotion.
|
java.lang.String |
getHelpMsg(java.lang.String msgKey,
java.lang.String languageCode)
Return the help message for the specified language and the specified 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.
|
AdminJobStatusResponse |
getJobStatus(java.lang.String sessionId,
AdminJobStatusRequest jobStatusRequest)
Retrieve information on the Batch Jobs running in the system.
|
com.konakart.app.KKEvent[] |
getKKEvents(java.lang.String sessionId,
com.konakart.app.KKEventSearch search,
com.konakart.app.DataDescriptor desc)
Delete all the events matching the event search criteria
|
java.lang.String |
getKonaKartAdminVersion()
Return the version number of KonaKart Admin that is contained within the konakart.jar
|
java.lang.String |
getKonakartPropertyValue(java.lang.String sessionId,
java.lang.String section,
java.lang.String propertyName)
Returns the property value from the properties file in the specified section.
|
AdminLanguage |
getLanguageByCode(java.lang.String code)
Returns the language referenced by the two letter lower case code (e.g.
|
AdminLanguage |
getLanguageById(int id)
Returns the language referenced by language ID.
|
AdminLanguage |
getLanguageForLocale(java.lang.String locale)
Retrieves the language for the locale
|
int |
getLanguageIdForLocale(java.lang.String locale)
Retrieves the language Id for the locale
|
AdminLanguageSearchResult |
getLanguages(AdminLanguageSearch search)
This returns an AdminLanguageSearchResult object.
|
AdminStoreSearchResult |
getMallStores(AdminStoreSearch search,
int offset,
int size)
Get the stores in the mall supported by the server - Multi-Store Single DB only.
|
AdminManufacturer |
getManufacturer(int manufacturerId)
Get a fully populated manufacturer
|
AdminManufacturerSearchResult |
getManufacturers(java.lang.String sessionId,
AdminManufacturerSearch search,
int offset,
int size)
Returns an AdminManufacturerSearchResult object.
|
AdminManufacturer[] |
getManufacturersPerPromotion(java.lang.String sessionId,
int promotionId)
Returns all of the manufacturers for the promotion identified by promotionId.
|
AdminMiscItemSearchResult |
getMiscItems(java.lang.String sessionId,
AdminSearch search,
int offset,
int size)
Return the AdminMiscItem objects defined by the search criteria.
|
AdminMiscItemType[] |
getMiscItemTypes(java.lang.String sessionId,
AdminSearch search,
int offset,
int size)
Return the AdminMiscItemType objects defined by the search criteria.
|
AdminMiscPrice[] |
getMiscPrices(java.lang.String sessionId,
AdminMiscPriceSearch miscPriceSearch)
Retrieves the AdminMiscPrice objects that match the specified AdminMiscPriceSearch object
|
KKModule[] |
getModules(java.lang.String sessionId,
int moduleType)
Get the available modules of the specified type.
|
AdminMessageSet |
getMsgs(java.lang.String languageCode)
Return a set of admin application messages for the specified language.
|
java.lang.String |
getMsgValue(java.lang.String key,
int type,
java.lang.String locale)
Get a Message Value from the database
|
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.
|
AdminOrderRefundSearchResult |
getOrderRefunds(java.lang.String sessionId,
AdminOrderRefundSearch retSearch,
int offset,
int size)
Search for OrderRefund objects with search criteria and order by criteria.
|
AdminOrderReturnSearchResult |
getOrderReturns(java.lang.String sessionId,
AdminOrderReturnSearch retSearch,
int offset,
int size)
Search for OrderReturn objects with search criteria and order by criteria.
|
AdminOrderReturnStatusSearchResult |
getOrderReturnStatuses(AdminOrderReturnStatusSearch search)
Returns an
AdminOrderReturnStatusSearchResult object. |
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.
|
AdminOrderShipmentSearchResult |
getOrderShipments(java.lang.String sessionId,
AdminOrderShipmentSearch shipSearch,
int offset,
int size)
Search for OrderShipment objects with search criteria and order by criteria.
|
AdminOrderSearchResult |
getOrdersLite(java.lang.String sessionId,
AdminOrderSearch _search,
int offset,
int size,
int languageId)
Returns a set of Orders matching the specified search criteria.
|
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.
|
AdminPaymentSchedule |
getPaymentSchedule(java.lang.String sessionId,
int id)
Returns the payment schedule object for the
id parameter, or Null if the payment
schedule object doesn't exist in the DB. |
AdminPaymentScheduleSearchResult |
getPaymentSchedules(java.lang.String sessionId,
AdminPaymentScheduleSearch search,
int offset,
int size)
This returns an AdminPaymentScheduleSearchResult object.
|
PdfResult |
getPdf(java.lang.String sessionId,
PdfOptions options)
Create the PDF document and return the URL, File name or bytes as defined by the input
options.
|
AdminProdAttrDesc |
getProdAttrDesc(java.lang.String sessionId,
int id)
Returns the AdminProdAttrDesc object for the
id parameter, or Null if the
AdminProdAttrDesc doesn't exist in the DB. |
AdminProdAttrDescSearchResult |
getProdAttrDescs(java.lang.String sessionId,
AdminProdAttrDescSearch search,
int offset,
int size)
This returns an AdminProdAttrDescSearchResult object that contains an array of
AdminProdAttrDesc objects.
|
AdminProdAttrDesc[] |
getProdAttrDescsForTemplate(java.lang.String sessionId,
int templateId)
This method fetches all of the AdminProdAttrDesc objects for the template referenced by the
templateId parameter. |
AdminProdAttrDesc[] |
getProdAttrDescsForTemplates(java.lang.String sessionId,
AdminProdAttrTemplate[] templates)
This method fetches all of the AdminProdAttrDesc objects for the array of templates
referenced by the
templates parameter. |
AdminProdAttrTemplate |
getProdAttrTemplate(java.lang.String sessionId,
int id)
Returns the AdminProdAttrTemplate object for the
id parameter, or Null if the
AdminProdAttrTemplate doesn't exist in the DB. |
AdminProdAttrTemplateSearchResult |
getProdAttrTemplates(java.lang.String sessionId,
AdminProdAttrTemplateSearch search,
int offset,
int size)
This returns an AdminProdAttrTemplateSearchResult object containing an array of
AdminProdAttrTemplate objects.
|
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.
|
java.util.Calendar |
getProductAvailability(java.lang.String sessionId,
java.lang.String sku,
int id)
A method that directly returns the date when a product will be available.
|
java.util.Calendar |
getProductAvailabilityWithOptions(java.lang.String sessionId,
java.lang.String sku,
int id,
AdminProductMgrOptions mgrOptions)
A method that directly returns the date when a product will be available.
|
int |
getProductCountPerAddress(java.lang.String sessionId,
int addressId)
Returns the number of products using the address identified by addressId.
|
int |
getProductCountPerProdAttrDesc(java.lang.String sessionId,
int attrDescId)
Returns the number of products using the product attribute descriptor.
|
int |
getProductCountPerTemplate(java.lang.String sessionId,
int templateId)
Returns the number of products using the custom product attribute template.
|
AdminProductNotification[] |
getProductNotificationsForCustomer(java.lang.String sessionId,
int customerId)
Get an array of product notifications for the customer.
|
AdminProductOptionSearchResult |
getProductOptions(java.lang.String sessionId,
AdminProductOptionSearch search,
int offset,
int size)
This returns an AdminProductOptionSearchResult object.
|
AdminProductOption[] |
getProductOptionsPerId(java.lang.String sessionId,
int productOptionId)
Returns an array of AdminProductOption objects.
|
AdminProductOption[] |
getProductOptionsPerName(java.lang.String sessionId,
java.lang.String name,
int langId)
Returns an array of productOptions with the specified name and languageId.
|
AdminProductOptionValue[] |
getProductOptionValuesPerId(java.lang.String sessionId,
int productOptionValueId)
Returns an array of productOptionValues.
|
AdminProductOptionValue[] |
getProductOptionValuesPerName(java.lang.String sessionId,
java.lang.String name,
int languageId)
Get an array of product option value objects with the specified name and language.
|
AdminProductOptionValue[] |
getProductOptionValuesPerOption(int productOptionId,
int languageId)
Return an array of product option value objects for a product option object
|
AdminProdOptionValToProdOption[] |
getProductOptionValueToProductOptions(java.lang.String sessionId,
AdminProdOptionValToProdOption prodOptValToProdOpt)
Gets an array of AdminProdOptionValToProdOption objects that have the specified optionId and
OptionValueId.
|
int |
getProductQuantity(java.lang.String sessionId,
java.lang.String sku,
int id)
A method that allows you to directly retrieve the quantity of a product.
|
int |
getProductQuantityWithOptions(java.lang.String sessionId,
java.lang.String sku,
int id,
AdminProductMgrOptions mgrOptions)
A method that allows you to directly retrieve the quantity of a product.
|
AdminProducts |
getProductsPerPromotion(java.lang.String sessionId,
AdminProductSearch search,
int offset,
int size)
Get an array of Admin product objects for a promotion.
|
AdminProductToStore[] |
getProductsToStores(java.lang.String sessionId,
AdminDataDescriptor dataDesc,
AdminSearch search)
Returns an array of AdminProductToStore objects for the specified store
|
AdminProducts |
getProductsToSynchronize(java.lang.String sessionId,
java.lang.String storeIdFrom,
java.lang.String storeIdTo,
AdminDataDescriptor dataDesc,
int languageId,
AdminSynchProductsOptions options,
AdminProductMgrOptions mgrOptions)
This API call is used to get a list of products that are out of sync between two stores.
|
AdminProduct |
getProductWithOptions(java.lang.String sessionId,
int productId,
AdminProductMgrOptions mgrOptions)
Get the product referenced by this product id, from the database.
|
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.
|
AdminProducts |
getRelatedProductsWithOptions(java.lang.String sessionId,
AdminDataDescriptor dataDesc,
int productId,
int relationType,
int languageId,
AdminProductMgrOptions mgrOptions)
Find products related to the product defined by the productId parameter.
|
AdminReport[] |
getReports(java.lang.String sessionId)
Retrieves the reports as an array of AdminReport objects that define the set of reports
currently defined on the system.
|
AdminReview |
getReview(java.lang.String sessionId,
int reviewId)
Returns the review referenced by the review Id
|
AdminReviews |
getReviews(java.lang.String sessionId,
AdminDataDescriptor dataDesc,
AdminReviewSearch revSearch)
Returns the reviews for the given search criteria.
|
AdminReviews |
getReviewsPerProduct(java.lang.String sessionId,
AdminDataDescriptor dataDesc,
int productId)
Returns the reviews for a product.
|
AdminReviews |
getReviewsPerVendor(java.lang.String sessionId,
AdminDataDescriptor dataDesc,
int vendorId)
Returns the reviews for a vendor.
|
AdminRewardPointSearchResult |
getRewardPoints(java.lang.String sessionId,
AdminRewardPointSearch search,
int offset,
int size)
The Reward Point transactions can be filtered by the creation dates and sorted by:
AdminDataDescriptor.ORDER_BY_DATE_ADDED_ASCENDING
AdminDataDescriptor.ORDER_BY_DATE_ADDED_DESCENDING
|
java.lang.String |
getRMACode(java.lang.String sessionId,
int orderId)
This method may be customized in the OrderIntegrationMgr to implement an algorithm that
creates an RMA code for the order.
|
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.
|
AdminSearchRule[] |
getSearchRules()
Reads the search rules from a properties file and returns them as an array.
|
AdminShipper |
getShipper(java.lang.String sessionId,
int shipperId)
Get a shipper by id
|
AdminShipperSearchResult |
getShippers(java.lang.String sessionId,
AdminShipperSearch search)
This returns an AdminShipperSearchResult object matching the search constraints.
|
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,
boolean searchInSubCats,
int languageId)
Returns an AdminProducts object containing an array of specials for a category.
|
AdminStore[] |
getStores()
Get the stores supported by the server.
|
AdminStore[] |
getStoresForCustomer(java.lang.String sessionId,
java.lang.String emailAddress)
This API call is only available when in multi-store single DB, non shared customer mode.
|
java.util.Calendar |
getStoreTime()
Returns the local store time based on the tz database time zone of the store.
|
AdminSubscription |
getSubscription(java.lang.String sessionId,
int id)
Returns the subscription object for the
id parameter, or Null if the
subscription object doesn't exist in the DB. |
AdminSubscriptionSearchResult |
getSubscriptions(java.lang.String sessionId,
AdminSubscriptionSearch search,
int offset,
int size)
This returns an AdminSubscriptionSearchResult object.
|
AdminSubZoneSearchResult |
getSubZones(AdminSubZoneSearch search,
int offset,
int size)
This returns an AdminSubZoneSearchResult object.
|
AdminSuggestionSearchResult |
getSuggestions(java.lang.String sessionId,
AdminSuggestion _suggestion,
AdminDataDescriptor dataDesc)
This retrieves Product Recommendation AdminSuggestion objects from the database.
|
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.
|
AdminTagGroupToTag[] |
getTagGroupToTags(java.lang.String sessionId,
AdminSearch search,
int offset,
int size)
Return the TagGroupToTag objects defined by the search criteria.
|
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.
|
int |
getTemplateCountPerProdAttrDesc(java.lang.String sessionId,
int attrDescId)
Returns the number of templates using the product attribute descriptor.
|
AdminCategory[] |
getTopLevelCategories(int languageId,
AdminDataDescriptor dataDesc)
Returns all of the top level categories which are those that have a parentId = 0.
|
AdminVendor |
getVendorForId(java.lang.String sessionId,
int vendorId)
Returns a single vendor object referenced by the vendorId parameter, or null if it doesn't
exist.
|
AdminReview |
getVendorReview(java.lang.String sessionId,
int reviewId)
Returns the vendor review referenced by the review Id
|
AdminReviews |
getVendorReviews(java.lang.String sessionId,
AdminDataDescriptor dataDesc,
AdminReviewSearch revSearch)
Returns the reviews for the given search criteria.
|
AdminVendorSearchResult |
getVendors(java.lang.String sessionId,
AdminVendorSearch vendorSearch,
int offset,
int size)
Search for vendors matching a set of search criteria within the AdminVendorSearch object.
|
AdminWishLists |
getWishLists(java.lang.String sessionId,
AdminWishListSearch search,
int offset,
int size)
Return the WishList objects defined by the search criteria.
|
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 |
importAudit(java.lang.String sessionId,
AdminAudit audit)
Imports an audit object.
|
int |
importDigitalDownload(java.lang.String sessionId,
AdminDigitalDownload digDownload)
Import a new digital download record.
|
void |
importMsgs(java.lang.String sessionId,
int type,
java.lang.String locale,
java.lang.String msgString,
boolean replace)
Import Messages into the database
|
int |
insertAddress(java.lang.String sessionId,
AdminAddress address)
Insert an AdminAddress.
KonaKart supports addresses for customers, products, manufacturers and stores. |
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 |
insertBooking(java.lang.String sessionId,
AdminBooking booking,
AdminBookableProductOptions options)
Insert a new booking.
|
int |
insertCatalog(java.lang.String sessionId,
AdminCatalog catalog)
Insert a new catalog
|
void |
insertCatalogPrices(java.lang.String sessionId,
AdminProductPrice[] prices,
AdminInsertCatalogPriceOptions options)
This API call is intended to provide a fast way to load catalog prices.
|
int |
insertCategory(java.lang.String sessionId,
AdminCategory cat)
Inserts a new category into the database.
|
int[] |
insertConfigData(java.lang.String sessionId,
AdminConfigData[] configs)
Insert the AdminConfigData items.
|
void |
insertConfigs(java.lang.String sessionId,
KKConfiguration[] configs)
Insert one or more new configuration parameters
|
int |
insertConfiguration(java.lang.String sessionId,
KKConfiguration config)
Insert a configuration object.
|
int |
insertConfigurationGroup(java.lang.String sessionId,
AdminConfigurationGroup configGroup)
Insert a configuration group.
|
int |
insertContent(java.lang.String sessionId,
AdminContent content)
Insert an AdminContent object.
|
int |
insertContentType(java.lang.String sessionId,
AdminContentType contentType)
Insert an AdminContentType object.
|
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.
|
int |
insertCustomerTag(java.lang.String sessionId,
AdminCustomerTag tag)
Inserts an AdminCustomerTag object into the database.
|
void |
insertCustomerTagForCustomer(java.lang.String sessionId,
int customerId,
AdminCustomerTag tag)
Assigns a customer tag to the customer referenced by the
customerId. |
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 |
insertExpression(java.lang.String sessionId,
AdminExpression exp)
Inserts an AdminExpression object.
|
int |
insertExpressionVariables(java.lang.String sessionId,
AdminExpressionVariable[] expVarArray)
Inserts an array of ExpressionVariable objects that should all belong to the same expression.
|
int |
insertFilter(java.lang.String sessionId,
AdminFilter filter)
Insert an AdminFilter record.
|
int |
insertGeoZone(java.lang.String sessionId,
AdminGeoZone insertObj)
Insert an AdminGeoZone object.
|
int |
insertIpnHistory(java.lang.String sessionId,
AdminIpnHistory ipnHistory)
Save the AdminIpnHistory object in the database.
|
int |
insertKKEvent(java.lang.String sessionId,
com.konakart.app.KKEvent event)
Insert an event
|
int |
insertLanguage(java.lang.String sessionId,
AdminLanguage lang)
Insert a Language.
|
void |
insertMallStore(java.lang.String sessionId,
AdminStore store)
Insert a new store into the mall.
|
int |
insertManufacturer(java.lang.String sessionId,
AdminManufacturer manu)
Insert a manufacturer
|
int |
insertMiscItems(java.lang.String sessionId,
AdminMiscItem[] mItems)
Insert an array of AdminMiscItem objects
|
int |
insertMiscItemType(java.lang.String sessionId,
AdminMiscItemType[] miTypes)
Insert an array of AdminMiscItemType objects
|
int |
insertMiscPrices(java.lang.String sessionId,
AdminMiscPrice[] miscPrices)
Insert the AdminMiscPrice objects in the specified array
|
void |
insertMsg(java.lang.String sessionId,
java.lang.String key,
int type,
java.lang.String locale,
java.lang.String value)
Insert a Message into the database
|
int |
insertOrder(java.lang.String sessionId,
AdminOrder order)
Insert an order.
|
int |
insertOrderRefund(java.lang.String sessionId,
AdminOrderRefund orderRefund)
Insert an AdminOrderRefund object.
|
int |
insertOrderReturn(java.lang.String sessionId,
AdminOrderReturn orderRet)
Insert an AdminOrderReturn object and its array of AdminOrderReturnProduct objects
|
int |
insertOrderReturnStatus(java.lang.String sessionId,
AdminOrderReturnStatus status)
Insert an OrderReturnStatus object.
|
int |
insertOrderReturnStatuses(java.lang.String sessionId,
AdminOrderReturnStatus[] statuses)
Insert an array of AdminOrderReturnStatus objects.
|
int |
insertOrderShipment(java.lang.String sessionId,
AdminOrderShipment orderShipment)
Insert an AdminOrderShipment object and its array of AdminOrderShipmentProduct 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 |
insertPaymentSchedule(java.lang.String sessionId,
AdminPaymentSchedule ps)
An AdminPaymentSchedule object is inserted into the database.
|
int |
insertProdAttrDesc(java.lang.String sessionId,
AdminProdAttrDesc attrDesc)
An AdminProdAttrDesc object is inserted into the database.
|
int |
insertProdAttrTemplate(java.lang.String sessionId,
AdminProdAttrTemplate template)
An AdminProdAttrTemplate object is inserted into the database.
|
int |
insertProduct(java.lang.String sessionId,
AdminProduct product)
Insert the product.
|
int |
insertProductAttribute(java.lang.String sessionId,
AdminProductAttribute prodAttr)
Inserts the product attribute.
|
boolean |
insertProductCategory(java.lang.String sessionId,
int prodId,
int catId)
Inserts a new product category record into the database if it doesn't already exist.
|
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 |
insertProductsOptionsValuesToProductsOptions(java.lang.String sessionId,
AdminProdOptionValToProdOption prodOptValToProdOpt)
Insert a product option value to product option record.
|
void |
insertProductsToStores(java.lang.String sessionId,
AdminProductToStore[] productToStores)
Inserts an array of AdminProductToStore objects
|
int |
insertProductWithOptions(java.lang.String sessionId,
AdminProduct product,
AdminProductMgrOptions mgrOptions)
Insert the product.
|
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 |
insertShipper(java.lang.String sessionId,
AdminShipper shipper)
Insert a Shipper
|
int |
insertSpecial(java.lang.String sessionId,
AdminSpecial special)
Inserts a new special
|
int |
insertSubscription(java.lang.String sessionId,
AdminSubscription subscription)
An AdminSubscription object is inserted into the database.
|
int |
insertSubZone(java.lang.String sessionId,
AdminSubZone insertObj)
Insert an AdminSubZone object.
|
void |
insertSuggestions(java.lang.String sessionId,
AdminSuggestion[] suggestions)
This inserts Product Recommendation AdminSuggestion objects into the database.
|
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[] tagGroup)
Insert an array of TagGroup objects - provide a TagGroup object for each language
|
void |
insertTagGroupToTags(java.lang.String sessionId,
AdminTagGroupToTag tagGroupToTag)
Insert an AdminTagGroupToTag record
|
int |
insertTags(java.lang.String sessionId,
AdminTag[] tag)
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 |
insertVendor(java.lang.String sessionId,
AdminVendor vendor)
Insert a vendor
|
int |
insertWishList(java.lang.String sessionId,
AdminWishList wishList)
Insert a wish list and any attached wish list items.
|
int |
insertWishListItem(java.lang.String sessionId,
AdminWishListItem wishListItem)
Insert an AdminWishListItem.
|
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 |
logMsg(int level,
java.lang.String message)
For debugging the client - it writes out the String that's sent if we are logging at the
specified level or above
|
void |
logout(java.lang.String sessionId)
Used to logout the user with the specified sessionId.
|
void |
moveCategory(java.lang.String sessionId,
int categoryId,
int newParentId)
The category referenced by categoryId is moved to a new parent referenced by newParentId.
|
int |
pointsAvailable(java.lang.String sessionId,
int customerId)
Calculates the number of reward points available for the customer identified by the
customerId parameter. |
void |
publishProducts(java.lang.String sessionId,
AdminPublishConfig adminPublishConfig)
Deprecated.
|
java.lang.String |
readFromUrl(java.lang.String sessionId,
java.lang.String url)
Reads the resource at the given URL and returns it as a string.
|
int |
registerCustomer(java.lang.String sessionId,
AdminCustomerRegistration custReg)
Register a new customer.
|
void |
reloadReports(java.lang.String sessionId)
Reloads the reports
|
void |
removeAddressFromProduct(java.lang.String sessionId,
int addressId,
int productId)
Remove the relationship between the address and the product.
|
void |
removeAllProductsFromSearchEngine(java.lang.String sessionId,
boolean async)
Remove all products from the search engine.
|
void |
removeApiCallsFromRole(java.lang.String sessionId,
AdminApiCall[] apiCalls,
int roleId)
Removes the array of AdminApiCall objects from the role identified by the roleId parameter.
|
void |
removeCategoriesFromPromotion(java.lang.String sessionId,
AdminCategory[] categories,
int promotionId)
Remove an array of categories from the promotion identified by the promotionId parameter.
|
void |
removeConfigData(java.lang.String sessionId,
int id)
Remove the AdminConfigData item from the Database.
|
void |
removeConfigs(java.lang.String sessionId,
java.lang.String[] configKeys)
Remove one or more configuration parameters
|
void |
removeCouponsFromPromotion(java.lang.String sessionId,
AdminCoupon[] coupons,
int promotionId)
Remove an array of coupons from the promotion identified by the promotionId parameter.
|
void |
removeCustomerGroupsFromPromotion(java.lang.String sessionId,
int[] groupIds,
int promotionId)
Remove an array of customer groups from the promotion identified by the promotionId
parameter.
|
void |
removeCustomersFromPromotion(java.lang.String sessionId,
AdminCustomer[] customers,
int promotionId)
Remove an array of customers from the promotion identified by the promotionId parameter.
|
void |
removeExpressionsFromPromotion(java.lang.String sessionId,
AdminExpression[] expressions,
int promotionId)
Remove an array of expressions from the promotion identified by the promotionId parameter.
|
void |
removeGiftCertificatesFromPromotion(java.lang.String sessionId,
AdminProduct[] giftCertificates,
int promotionId)
Remove an array of gift certificate products from the promotion identified by the promotionId
parameter.
|
void |
removeImage(java.lang.String sessionId,
AdminImageOptions options)
Remove the image (or images) from the object defined in the AdminImageOptions object.
|
void |
removeMallStore(java.lang.String sessionId,
java.lang.String storeId)
Removes a Store.
|
void |
removeManufacturersFromPromotion(java.lang.String sessionId,
AdminManufacturer[] manufacturers,
int promotionId)
Remove an array of manufacturers from the promotion identified by the promotionId parameter.
|
void |
removePanelsFromRole(java.lang.String sessionId,
AdminPanel[] panels,
int roleId)
Removes the array of AdminPanel objects from the role identified by the roleId parameter.
|
void |
removeProdAttrDescsFromTemplate(java.lang.String sessionId,
AdminProdAttrDesc[] attrDescs,
int templateId)
Remove an array of ProdAttrDesc objects from the template.
|
void |
removeProductFromCatalog(java.lang.String sessionId,
int productId,
java.lang.String catalogId)
Removes product prices and quantities from the catalog referenced by catalogId for the
product referenced by productId.
|
void |
removeProductFromSearchEngine(java.lang.String sessionId,
int productId)
Remove the product referenced by productId from the search engine.
|
void |
removeProductsFromPromotion(java.lang.String sessionId,
AdminProduct[] products,
int promotionId)
Remove an array of products from the promotion identified by the promotionId parameter.
|
void |
removeProductsToStores(java.lang.String sessionId,
AdminProductToStore[] productToStores)
Removes an array of AdminProductToStore objects
|
void |
removePromotionsFromCoupon(java.lang.String sessionId,
AdminPromotion[] promotions,
int couponId)
Remove an array of promotions from the coupon identified by the couponId parameter.
|
void |
removeRelatedProduct(java.lang.String sessionId,
int productIdFrom,
int productIdTo,
int relationType)
Removes any existing relation of type == relationType defined on the product with id ==
productId.
|
void |
removeRelatedProducts(java.lang.String sessionId,
int productId,
int relationType)
Removes related products from the product defined by productId.
|
void |
removeRolesFromUser(java.lang.String sessionId,
AdminRole[] roles,
int userId)
Removes the array of AdminRole objects from the user identified by the userId parameter.
|
void |
removeTagGroupsFromCategory(java.lang.String sessionId,
AdminTagGroup[] tagGroups,
int categoryId)
If associations exist between the AdminTagGroups and the category identified by categoryId,
then they are removed.
|
void |
removeTagsFromProduct(java.lang.String sessionId,
AdminTag[] tags,
int productId)
If associations exist between the AdminTags and the product identified by productId, then
they are removed.
|
boolean |
renameFile(java.lang.String sessionId,
java.lang.String srcFileName,
java.lang.String dstFileName)
Rename the source file to the destination file.
|
boolean |
renameFiles(java.lang.String sessionId,
java.lang.String[] srcFileNames,
java.lang.String[] dstFileNames)
Rename the source files to the destination files.
|
void |
resetCustomerPassword(java.lang.String sessionId,
int custId)
Reset a customer's password.
|
void |
resetCustomerPasswordSpecifyingEmail(java.lang.String sessionId,
int custId,
java.lang.String eMailAddress)
Reset a customer's password using the eMail address specified.
|
boolean |
runBatchJob(java.lang.String sessionId,
java.lang.String group,
java.lang.String name,
java.lang.String[] paramArray)
Executes the batch job with the specified group and name.
|
void |
saveConfigs(java.lang.String sessionId,
KKConfiguration[] configs,
KKConfiguration[] origConfigs)
Saves an array of KKConfiguration objects to the database.
|
void |
saveFileContents(java.lang.String sessionId,
java.lang.String fileName,
java.lang.String fileContents)
Writes the specified file contents into the specified file.
|
boolean |
scaleImage(java.lang.String sessionId,
AdminScaleOptions scaleOptions)
Scale the specified image to the specified name and dimensions.
|
AdminDigitalDownloadSearchResult |
searchDigitalDownloads(java.lang.String sessionId,
AdminDigitalDownloadSearch search,
int offset,
int size)
Retrieve the Digital Download records matching the search criteria
|
AdminIpnHistories |
searchForIpnHistory(java.lang.String sessionId,
AdminDataDescriptor dataDesc,
AdminIpnSearch ipnSearch)
Search for IpnHistory records with search criteria and order by criteria.
|
AdminProducts |
searchForProducts(java.lang.String sessionId,
AdminDataDescriptor dataDesc,
AdminProductSearch prodSearch,
int languageId)
Search for products.
|
AdminProducts |
searchForProductsWithOptions(java.lang.String sessionId,
AdminDataDescriptor dataDesc,
AdminProductSearch prodSearch,
int languageId,
AdminProductMgrOptions mgrOptions)
Search for products.
|
AdminKkMsgSearchResult |
searchMsg(AdminKkMsgSearch search,
int groupSize,
int offset)
Retrieve all the messages from the database that match the specified search criteria
|
boolean |
sendEmail(java.lang.String sessionId,
AdminEmail adminEmailData)
Send an email as defined in the specified AdminEmail object.
|
void |
sendTemplateEmailToCustomers(java.lang.String sessionId,
AdminCustomerSearch custSearch,
java.lang.String templateName,
java.lang.Object obj1,
java.lang.Object obj2,
java.lang.Object obj3,
java.lang.Object obj4,
java.lang.Object obj5,
int numEmailThreads)
An email is sent to the customers which are found based on the selection criteria set in the
AdminCustomerSearch object.
|
void |
sendTemplateEmailToCustomers1(java.lang.String sessionId,
AdminCustomerSearch custSearch,
java.lang.String templateName,
java.lang.String message,
AdminProduct[] products,
AdminOrder[] orders,
AdminManufacturer[] manufacturers,
AdminCategory[] categories,
int numEmailThreads)
An email is sent to the customers which are found based on the selection criteria set in the
AdminCustomerSearch object.
|
void |
sendTemplateEmailToCustomers1WithOptions(java.lang.String sessionId,
AdminCustomerSearch custSearch,
java.lang.String templateName,
java.lang.String message,
AdminProduct[] products,
AdminOrder[] orders,
AdminManufacturer[] manufacturers,
AdminCategory[] categories,
int numEmailThreads,
AdminEmailOptions options)
This method has the same functionality as sendTemplateEmailToCustomers1() except that it
includes an extra options object to enhance the available functionality.
|
void |
sendTemplateEmailToCustomersWithOptions(java.lang.String sessionId,
AdminCustomerSearch custSearch,
java.lang.String templateName,
java.lang.Object obj1,
java.lang.Object obj2,
java.lang.Object obj3,
java.lang.Object obj4,
java.lang.Object obj5,
int numEmailThreads,
AdminEmailOptions options)
This method has the same functionality as sendTemplateEmailToCustomers() except that it
includes an extra options object to enhance the available functionality.
|
boolean |
setConfigurationValue(java.lang.String sessionId,
java.lang.String key,
java.lang.String value)
Sets a Configuration Value for the specified key
|
void |
setCreditCardDetailsOnOrder(java.lang.String sessionId,
AdminCreditCard creditCard)
Set Credit Card details on an existing order.
|
void |
setCustomerPassword(java.lang.String sessionId,
int custId,
java.lang.String newPassword)
Set a customer's password.
|
void |
setEndpoint(java.lang.String wsEndpoint)
Set the Web Service endpoint for the engine.
|
void |
setProductAvailability(java.lang.String sessionId,
java.lang.String sku,
int id,
java.util.Calendar dateAvailable)
A method that allows you to modify the date when a product will be available, through the API
without needing to fetch the complete product and edit it.
|
void |
setProductAvailabilityWithOptions(java.lang.String sessionId,
java.lang.String sku,
int id,
java.util.Calendar dateAvailable,
AdminProductMgrOptions mgrOptions)
A method that allows you to modify the date when a product will be available, through the API
without needing to fetch the complete product and edit it.
|
void |
setProductQuantity(java.lang.String sessionId,
java.lang.String sku,
int id,
int quantity,
int operation)
A method that allows you to modify the quantity of a product through the API without needing
to fetch the complete product and edit it.
|
void |
setProductQuantityWithOptions(java.lang.String sessionId,
java.lang.String sku,
int id,
int quantity,
int operation,
AdminProductMgrOptions mgrOptions)
A method that allows you to modify the quantity of a product through the API without needing
to fetch the complete product and edit it.
|
void |
setProductVariantQuantityWithOptions(java.lang.String sessionId,
java.lang.String sku,
int id,
int quantity,
int operation,
java.lang.String variantCode,
AdminProductMgrOptions mgrOptions)
A method that allows you to modify the quantity of a product variant through the API without needing
to fetch the complete product and edit it.
|
java.lang.String |
tailFile(java.lang.String sessionId,
java.lang.String fileName,
int offset)
Get the file contents from the specified byte offset.
|
AdminDBConnector |
testDB(AdminDBConnector connector)
The connector parameter isn't currently used.
|
void |
updateAddress(java.lang.String sessionId,
AdminAddress address)
Updates an AdminAddress.
|
int |
updateAddressFormat(java.lang.String sessionId,
AdminAddressFormat updateObj)
Update an AdminAddressFormat object
|
void |
updateBooking(java.lang.String sessionId,
AdminBooking booking,
AdminBookableProductOptions options)
Update the booking
|
void |
updateCachedConfigurations(java.lang.String sessionId)
Wherever in the engine any configurations have been cached, they are refreshed when this
method is called.
|
void |
updateCatalog(java.lang.String sessionId,
AdminCatalog catalog)
Update an existing catalog
|
void |
updateConfigData(java.lang.String sessionId,
AdminConfigData[] configs)
Update the AdminConfigData items.
|
void |
updateConfiguration(java.lang.String sessionId,
KKConfiguration newConf)
Updates a KKConfiguration object.
|
void |
updateConfigurationGroup(java.lang.String sessionId,
AdminConfigurationGroup newConf)
Updates an AdminConfigurationGroup object.
|
void |
updateContent(java.lang.String sessionId,
AdminContent content)
Update an AdminContent object
|
void |
updateContentType(java.lang.String sessionId,
AdminContentType content)
Update an AdminContentType object
|
int |
updateCountry(java.lang.String sessionId,
AdminCountry country)
Update an AdminCountry object.
|
int |
updateCurrency(java.lang.String sessionId,
AdminCurrency curr)
Update a Currency.
|
void |
updateCustomer(java.lang.String sessionId,
AdminCustomer customer)
Update a Customer.
|
int |
updateCustomerGroup(java.lang.String sessionId,
AdminCustomerGroup custGroup)
Update a customer group.
|
int |
updateCustomerTag(java.lang.String sessionId,
AdminCustomerTag tag)
Update an AdminCustomerTag object.
|
void |
updateCustomerWithOptions(java.lang.String sessionId,
AdminCustomer customer,
AdminUpdateCustomerOptions options)
Update a Customer.
|
int |
updateExpression(java.lang.String sessionId,
AdminExpression exp)
Updates the expression.
|
int |
updateExpressionVariable(java.lang.String sessionId,
AdminExpressionVariable expVar)
Updates the ExpressionVariable object passed in as a parameter.
|
void |
updateFilter(java.lang.String sessionId,
AdminFilter filter)
Update an AdminFilterType object
|
int |
updateGeoZone(java.lang.String sessionId,
AdminGeoZone updateObj)
Update an AdminGeoZone object.
|
int |
updateLanguage(java.lang.String sessionId,
AdminLanguage lang)
Update a Language.
|
void |
updateMallStore(java.lang.String sessionId,
AdminStore store)
Updates an AdminStore object.
|
void |
updateMiscItems(java.lang.String sessionId,
AdminMiscItem[] mItems)
Update an array of AdminMiscItem objects.
|
void |
updateMiscItemType(java.lang.String sessionId,
AdminMiscItemType[] miTypes)
Update an array of AdminMiscItemType objects.
|
void |
updateMiscPrices(java.lang.String sessionId,
AdminMiscPrice[] miscPrices)
Update the AdminMiscPrice objects in the specified array
|
void |
updateMsg(java.lang.String sessionId,
java.lang.String key,
int type,
java.lang.String locale,
java.lang.String value)
Update a Message in the database.
|
void |
updateOrder(java.lang.String sessionId,
int orderId,
int orderStatus,
java.lang.String comments,
boolean notifyCustomer,
AdminOrderUpdate updateOrder)
Update the order status with optional comments.
|
int |
updateOrderReturnStatus(java.lang.String sessionId,
AdminOrderReturnStatus status)
Update an OrderReturnStatus object.
|
void |
updateOrderStatus(java.lang.String sessionId,
int orderId,
int orderStatus,
java.lang.String comments,
boolean notifyCustomer)
Deprecated.
|
int |
updateOrderStatusName(java.lang.String sessionId,
AdminOrderStatusName obj)
Update an OrderStatusName object.
|
int |
updatePaymentSchedule(java.lang.String sessionId,
AdminPaymentSchedule ps)
Update an AdminPaymentSchedule object.
|
int |
updateProdAttrDesc(java.lang.String sessionId,
AdminProdAttrDesc attrDesc)
Update an AdminProdAttrDesc object.
|
int |
updateProdAttrTemplate(java.lang.String sessionId,
AdminProdAttrTemplate template)
Update an AdminProdAttrTemplate object.
|
int |
updateProductsUsingProdAttrDesc(java.lang.String sessionId,
int attrDescId)
When custom attributes are converted to an XML string and saved within the product object,
some metadata fields of the custom attribute are saved along with the value of the attribute
itself.
|
int |
updateProductsUsingTemplates(java.lang.String sessionId,
int[] templateIds)
When custom attributes are converted to an XML string and saved within the product object,
some metadata fields of the custom attribute are saved along with the value of the attribute
itself.
|
int |
updateShipper(java.lang.String sessionId,
AdminShipper shipper)
Update a Shipper
|
int |
updateSubscription(java.lang.String sessionId,
AdminSubscription subscription)
Update an AdminSubscription object.
|
int |
updateSubZone(java.lang.String sessionId,
AdminSubZone updateObj)
Update an AdminSubZone object.
|
int |
updateTag(java.lang.String sessionId,
AdminTag tag)
Update an existing Tag object - only the Name and the SortOrder can be updated
|
int |
updateTagGroup(java.lang.String sessionId,
AdminTagGroup tagGroup)
Update an existing TagGroup object - You can update the name, description and the set of tags
associated to the tag group
|
int |
updateTaxClass(java.lang.String sessionId,
AdminTaxClass updateObj)
Update an AdminTaxClass object
|
int |
updateTaxRate(java.lang.String sessionId,
AdminTaxRate updateObj)
Update an AdminTaxRate object
|
void |
updateVendor(java.lang.String sessionId,
AdminVendor vendor)
Update a vendor.
|
int |
updateZone(java.lang.String sessionId,
AdminZone updateObj)
Update an AdminZone object
|
auditDeletes, auditDeletes, auditDeletes, auditDeletes, auditDeletesForArray, auditEdits, auditEdits, auditEdits, auditEdits, auditEdits, auditInserts, auditInserts, auditInserts, auditInserts, auditReads, auditReads, checkConfig, checkEnterpriseForCatalog, checkEnterpriseForExtPriceOrExtQuantity, checkLicense, checkManagerExists, excludedException, getAdminAddressMgr, getAdminAuditMgr, getAdminBillingMgr, getAdminBookableProductMgr, getAdminCategoryMgr, getAdminConfigurationMgr, getAdminContentMgr, getAdminCurrencyMgr, getAdminCustomerMgr, getAdminCustomerPwdHistMgr, getAdminCustomerTagMgr, getAdminDataIntegrityMgr, getAdminEmailMgr, getAdminEng, getAdminEventMgr, getAdminExecuteMgr, getAdminFileMgr, getAdminFilterMgr, getAdminHtmlMgr, getAdminLanguageMgr, getAdminManufacturerMgr, getAdminMessageMgr, getAdminMiscItemMgr, getAdminMiscPriceMgr, getAdminOrderMgr, getAdminPdfMgr, getAdminProdAttrMgr, getAdminProductMgr, getAdminPromotionMgr, getAdminRemoteAccessMgr, getAdminReportMgr, getAdminReviewMgr, getAdminRewardPointMgr, getAdminSchedulerMgr, getAdminSearchRuleMgr, getAdminSecurityMgr, getAdminShipmentMgr, getAdminSolrMgr, getAdminStoreMgr, getAdminSuggestionMgr, getAdminTagMgr, getAdminTaxMgr, getAdminValidationMgr, getAdminWishListMgr, getConfigFile, getDbVersion, getEmailReportingExclusions, getEngConf, getEngineId, getEngineModeStr, getEngineShareMode, getExceptionMessage, getKkInstanceId, getKonakartAdminPropsFileName, getKonakartAdminPropsFilePath, getKonaKartBuildDate, getKonakartPropertyValue, getKonakartPropertyValueAsBoolWithDefault, getKonakartPropertyValueAsLongWithDefault, getKonakartPropertyValueWithDefault, getKonakartTimeStamp, getKonakartTimeStampDate, getKonaKartVersion, getLogMgr, getModulesMgr, getStoreName, init, initKonakart, initMultiStoreMultiDB, initMultiStoreSingleDB, initSingleStore, initTorque, isSingleStoreMode, isTorqueInit, manageThrowable, manageThrowable, setAdminEng, setEngConf, setKonakartAdminPropsFileName, setKonakartAdminPropsFilePathclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetEngConf, getKonakartAdminPropsFilePathpublic KKAdmin(AdminEngineConfig engConf) throws KKAdminException
engConf - the engConfKKAdminException - unexpected exception in the KonaKart Admin Engine@Deprecated
public KKAdmin()
throws KKAdminException
KKAdminException - unexpected exception in the KonaKart Admin Engine@Deprecated
public KKAdmin(java.lang.String propertiesFileName)
throws KKAdminException
propertiesFileName - name of the properties file (can be just the name of a file on the classpath or a
full file path).KKAdminException - unexpected exception in the KonaKart Admin Engineprotected AdminEngineConfig getDefaultAdminEngConfig()
protected void checkStoreStatus(java.lang.String sessId)
throws java.lang.Exception
sessId - the sessionId of the user making the API calljava.lang.Exception - an unexpected exceptionprotected void checkStoreStatus(int customerId)
throws KKAdminException
customerId - the customerId of the user making the API callKKAdminException - unexpected exception in the KonaKart Admin Enginepublic AdminDBConnector testDB(AdminDBConnector connector) throws KKAdminException
KKAdminIftestDB in interface KKAdminIfconnector - the connectorKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void logMsg(int level,
java.lang.String message)
throws KKAdminException
KKAdminIflogMsg in interface KKAdminIflevel - the logging level (0=OFF,1=SEVERE,2=ERROR,4=WARNING,6=INFO,8=DEBUG)message - the message to logKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminLanguage getDefaultLanguage() throws KKAdminException
KKAdminIfgetDefaultLanguage in interface KKAdminIfKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminLanguage getLanguageByCode(java.lang.String code) throws KKAdminException
KKAdminIfgetLanguageByCode in interface KKAdminIfcode - the language codeKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminLanguage getLanguageById(int id) throws KKAdminException
KKAdminIfgetLanguageById in interface KKAdminIfid - the language idKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int getLanguageIdForLocale(java.lang.String locale)
throws KKAdminException
KKAdminIfgetLanguageIdForLocale in interface KKAdminIflocale - a 2 or 4 character locale (eg. en, de, es)KKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminLanguage getLanguageForLocale(java.lang.String locale) throws KKAdminException
KKAdminIfgetLanguageForLocale in interface KKAdminIflocale - a 2 or 4 character locale (eg. en, de, es)KKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminLanguage[] getAllLanguages() throws KKAdminException
KKAdminIfgetAllLanguages in interface KKAdminIfKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminLanguageSearchResult getLanguages(AdminLanguageSearch search) throws KKAdminException
KKAdminIfgetLanguages in interface KKAdminIfsearch - the search object that defines the search parameters and sort orderKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminAddressFormat[] getAllAddressFormats() throws KKAdminException
KKAdminIfgetAllAddressFormats in interface KKAdminIfKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminCurrency getDefaultCurrency() throws KKAdminException
KKAdminIfgetDefaultCurrency in interface KKAdminIfKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminCurrency getCurrency(java.lang.String currencyCode) throws KKAdminException
KKAdminIfgetCurrency in interface KKAdminIfcurrencyCode - the currency Code to look upKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminCurrencySearchResult getCurrencies(AdminCurrencySearch search) throws KKAdminException
KKAdminIfgetCurrencies in interface KKAdminIfsearch - the search object that defines the search parameters and sort order. If null all
currencies are returned ordered by the currency title.KKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminOrderStatusNameSearchResult getOrderStatusNames(AdminOrderStatusNameSearch search) throws KKAdminException
KKAdminIfAdminOrderStatusNameSearchResult object.getOrderStatusNames in interface KKAdminIfsearch - the search object that defines the search parameters and sort order. If
languageId is not set (or set to
AdminLanguageMgr.DEFAULT_LANG) the default language is used. If the
languageId is set to AdminLanguageMgr.ALL_LANGUAGES all
languages are returned.AdminOrderStatusNameSearchResultKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminCustomerGroupSearchResult getCustomerGroups(AdminCustomerGroupSearch search) throws KKAdminException
KKAdminIfgetCustomerGroups in interface KKAdminIfsearch - An AdminCustomerGroupSearch object containing the search criteriaKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminCountrySearchResult getCountries(AdminCountrySearch search, int offset, int count) throws KKAdminException
KKAdminIfgetCountries in interface KKAdminIfsearch - an AdminCountrySearch objectoffset - the offset in the databasecount - the number of records from the specified offsetKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminOrderStatusName[] getAllOrderStatuses(int languageId) throws KKAdminException
KKAdminIfgetAllOrderStatuses in interface KKAdminIflanguageId - the languageIdKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminCountry[] getAllCountriesFull() throws KKAdminException
KKAdminIfgetAllCountriesFull in interface KKAdminIfKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminTaxClass[] getAllTaxClassesFull() throws KKAdminException
KKAdminIfgetAllTaxClassesFull in interface KKAdminIfKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminTaxRateSearchResult getTaxRates(AdminTaxRateSearch search, int offset, int size) throws KKAdminException
KKAdminIfgetTaxRates in interface KKAdminIfsearch - the definition of the search - can be nulloffset - the offset in the databasesize - the number of records from the specified offsetKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminTaxRateSearchResult getAllTaxRates() throws KKAdminException
KKAdminIfgetAllTaxRates in interface KKAdminIfKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminZoneSearchResult getZones(AdminZoneSearch search, int offset, int size) throws KKAdminException
KKAdminIfgetZones in interface KKAdminIfsearch - the definition of the search - can be nulloffset - the offset in the databasesize - the number of records from the specified offsetKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminTaxClassSearchResult getTaxClasses(AdminTaxClassSearch search) throws KKAdminException
KKAdminIfgetTaxClasses in interface KKAdminIfsearch - the definition of the search - can be nullKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminAddressFormatSearchResult getAddressFormats(AdminAddressFormatSearch search) throws KKAdminException
KKAdminIfgetAddressFormats in interface KKAdminIfsearch - the definition of the search - can be nullKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminZone[] getZonesById(int countryId) throws KKAdminException
KKAdminIfgetZonesById in interface KKAdminIfcountryId - the countryIdKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminGeoZone[] getAllGeoZones() throws KKAdminException
KKAdminIfgetAllGeoZones in interface KKAdminIfKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminGeoZoneSearchResult getGeoZones(AdminGeoZoneSearch search, int offset, int size) throws KKAdminException
KKAdminIfgetGeoZones in interface KKAdminIfsearch - the definition of the search - can be nulloffset - the offset in the databasesize - the number of records from the specified offsetKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminSubZoneSearchResult getSubZones(AdminSubZoneSearch search, int offset, int size) throws KKAdminException
KKAdminIfgetSubZones in interface KKAdminIfsearch - the definition of the search - can be nulloffset - the offset in the databasesize - the number of records from the specified offsetKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminCategory getCategory(int categoryId, boolean getChildren, int languageId) throws KKAdminException
KKAdminIfgetCategory in interface KKAdminIfcategoryId - The numeric id of the categorygetChildren - the getChildrenlanguageId - the language Id - or it could be
com.konakartadmin.bl.AdminLanguageMgr.DEFAULT_LANG to use the default languageKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminCategory[] getCategoryTree(int languageId, boolean getNumProducts) throws KKAdminException
KKAdminIfgetCategoryTree in interface KKAdminIflanguageId - the language Id - or it could be
com.konakartadmin.bl.AdminLanguageMgr.DEFAULT_LANG to use the default languagegetNumProducts - the getNumProductsKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminCategory[] getTopLevelCategories(int languageId, AdminDataDescriptor dataDesc) throws KKAdminException
KKAdminIfgetTopLevelCategories in interface KKAdminIflanguageId - the language Id - or it could be
com.konakartadmin.bl.AdminLanguageMgr.DEFAULT_LANG to use the default languagedataDesc - Used to control the data offset, limit the number of categories returned and to
set constraints on the custom fields. May be set to null;KKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminManufacturer[] getAllManufacturers() throws KKAdminException
KKAdminIfgetAllManufacturers in interface KKAdminIfKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminManufacturer getManufacturer(int manufacturerId) throws KKAdminException
KKAdminIfgetManufacturer in interface KKAdminIfmanufacturerId - The numeric id of the manufacturerKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminProductOption[] getAllProductOptions(int languageId) throws KKAdminException
KKAdminIfgetAllProductOptions in interface KKAdminIflanguageId - specifies that the product options should be returned for this language. Can
specify com.konakartadmin.bl.AdminLanguageMgr.DEFAULT_LANG to specify the default
language, or specify com.konakartadmin.bl.AdminLanguageMgr.ALL_LANGUAGES to
specify all languagesKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminProductOptionValue[] getProductOptionValuesPerOption(int productOptionId, int languageId) throws KKAdminException
KKAdminIfgetProductOptionValuesPerOption in interface KKAdminIfproductOptionId - the productOptionIdlanguageId - the language Id - or it could be
com.konakartadmin.bl.AdminLanguageMgr.DEFAULT_LANG to use the default language or
specify com.konakartadmin.bl.AdminLanguageMgr.ALL_LANGUAGES to specify all
languagesKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminStore[] getStores() throws KKAdminException
KKAdminIfgetStores in interface KKAdminIfKKAdminException - an unexpected exception in the KonaKart Admin enginepublic java.lang.String login(java.lang.String user,
java.lang.String password)
throws KKAdminException
KKAdminIflogin in interface KKAdminIfuser - Admin usernamepassword - Admin passwordKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void logout(java.lang.String sessionId)
throws KKAdminException
KKAdminIflogout in interface KKAdminIfsessionId - The session Id of the logged in userKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void setEndpoint(java.lang.String wsEndpoint)
throws KKAdminException
KKAdminIfThe effect will be to set the web service endpoint for the proxy to the KonaKart engine.
setEndpoint in interface KKAdminIfwsEndpoint - A String representing the web service endpointKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminMessageSet getMsgs(java.lang.String languageCode) throws KKAdminException
KKAdminIfFor file-based messages (where the configuration parameter USE_DB_FOR_MESSAGES = false) the messages are retrieved from a message properties file on the classpath that best-matches the specified language parameter. The name of the file starts with 'AdminMessages' and may have a language code or locale specification appended to it, and '.properties' added to the end. An example of such a file would be AdminMessages_de.properties. It first tries to find a file that matches the language_code exactly (this could be a full locale description such as 'de_DE' or 'pt_BR') and if no such file is found it tries to find one that matches just the first two characters (in this case 'de' and 'pt' respectively). When the specified language code is 'en' a file without any language or locale specification is used instead.
For database-based messages the language code specified must be the locale specified in the database. By default these will be the full locale names (eg. en_GB, de_DE, pt_BR etc). file for the locale or language code.
getMsgs in interface KKAdminIflanguageCode - See above... Either specify the full language locale or the 2-character language
code. If null, the language code of the default language will be used.KKAdminException - an unexpected exception in the KonaKart Admin enginepublic java.lang.String getHelpMsg(java.lang.String msgKey,
java.lang.String languageCode)
throws KKAdminException
KKAdminIfFor file-based messages (where the configuration parameter USE_DB_FOR_MESSAGES = false) the message is retrieved from a message properties file on the classpath that best-matches the specified language parameter. The name of the file starts with 'AdminHelpMessages' and may have a language code or locale specification appended to it, and '.properties' added to the end. An example of such a file would be AdminHelpMessages_de.properties. It first tries to find a file that matches the language_code exactly (this could be a full locale description such as 'de_DE' or 'pt_BR') and if no such file is found it tries to find one that matches just the first two characters (in this case 'de' and 'pt' respectively). When the specified language code is 'en' a file without any language or locale specification is used instead.
For database-based messages the language code specified must be the locale specified in the database. By default these will be the full locale names (eg. en_GB, de_DE, pt_BR etc). file for the locale or language code.
For properties in the 'AdminHelpMessages' properties files that contain substitution definitions, this call will translate these into their substituted values.
getHelpMsg in interface KKAdminIfmsgKey - the key of the help message in the properties file. If null, a null help message
is returned.languageCode - the language code (if null it uses the current default language)KKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminCustomValidatorSet getCustomValidatorSet() throws KKAdminException
KKAdminIfgetCustomValidatorSet in interface KKAdminIfKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminSearchRule[] getSearchRules() throws KKAdminException
KKAdminIfgetSearchRules in interface KKAdminIfKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int checkSession(java.lang.String sessionId)
throws KKAdminException
KKAdminIfcheckSession in interface KKAdminIfsessionId - The session Id of the logged in userKKAdminException - an unexpected exception in the KonaKart Admin engine Thrown if the session is
invalidpublic boolean setConfigurationValue(java.lang.String sessionId,
java.lang.String key,
java.lang.String value)
throws KKAdminException
KKAdminIfsetConfigurationValue in interface KKAdminIfsessionId - The session Id of the logged in userkey - key whose value will be setvalue - value to setKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int deleteCurrency(java.lang.String sessionId,
int currId)
throws KKAdminException
KKAdminIfdeleteCurrency in interface KKAdminIfsessionId - The session Id of the logged in usercurrId - A currency idKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertCurrency(java.lang.String sessionId,
AdminCurrency curr)
throws KKAdminException
KKAdminIfinsertCurrency in interface KKAdminIfsessionId - The session Id of the logged in usercurr - A currency objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int updateCurrency(java.lang.String sessionId,
AdminCurrency curr)
throws KKAdminException
KKAdminIfupdateCurrency in interface KKAdminIfsessionId - The session Id of the logged in usercurr - A currency objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int deleteOrderStatusName(java.lang.String sessionId,
int id)
throws KKAdminException
KKAdminIfdeleteOrderStatusName in interface KKAdminIfsessionId - The session Id of the logged in userid - An OrderStatus idKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertOrderStatusName(java.lang.String sessionId,
AdminOrderStatusName obj)
throws KKAdminException
KKAdminIfinsertOrderStatusName in interface KKAdminIfsessionId - The session Id of the logged in userobj - An OrderStatusName objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertOrderStatusNames(java.lang.String sessionId,
AdminOrderStatusName[] ordStats)
throws KKAdminException
KKAdminIfinsertOrderStatusNames in interface KKAdminIfsessionId - The session Id of the logged in userordStats - An AdminOrderStatusName array objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int updateOrderStatusName(java.lang.String sessionId,
AdminOrderStatusName obj)
throws KKAdminException
KKAdminIfupdateOrderStatusName in interface KKAdminIfsessionId - The session Id of the logged in userobj - An OrderStatusName objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int deleteCountry(java.lang.String sessionId,
int id)
throws KKAdminException
KKAdminIfdeleteCountry in interface KKAdminIfsessionId - The session Id of the logged in userid - A Country idKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertCountry(java.lang.String sessionId,
AdminCountry country)
throws KKAdminException
KKAdminIfinsertCountry in interface KKAdminIfsessionId - The session Id of the logged in usercountry - An AdminCountry objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int updateCountry(java.lang.String sessionId,
AdminCountry country)
throws KKAdminException
KKAdminIfupdateCountry in interface KKAdminIfsessionId - The session Id of the logged in usercountry - An AdminCountry objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int deleteLanguage(java.lang.String sessionId,
int langId)
throws KKAdminException
KKAdminIfdeleteLanguage in interface KKAdminIfsessionId - The session Id of the logged in userlangId - A Language idKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertLanguage(java.lang.String sessionId,
AdminLanguage lang)
throws KKAdminException
KKAdminIfinsertLanguage in interface KKAdminIfsessionId - The session Id of the logged in userlang - A Language objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertCustomerGroup(java.lang.String sessionId,
AdminCustomerGroup custGroup)
throws KKAdminException
KKAdminIfinsertCustomerGroup in interface KKAdminIfsessionId - The session Id of the logged in usercustGroup - A Customer Group objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertCustomerGroups(java.lang.String sessionId,
AdminCustomerGroup[] custGroups)
throws KKAdminException
KKAdminIfinsertCustomerGroups in interface KKAdminIfsessionId - the sessionIdcustGroups - An array of AdminCustomerGroup objectsKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int updateLanguage(java.lang.String sessionId,
AdminLanguage lang)
throws KKAdminException
KKAdminIfupdateLanguage in interface KKAdminIfsessionId - The session Id of the logged in userlang - A Language objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic boolean sendEmail(java.lang.String sessionId,
AdminEmail adminEmailData)
throws KKAdminException
KKAdminIfsendEmail in interface KKAdminIfsessionId - The session Id of the logged in useradminEmailData - the Email object to fill out to define the email to sendKKAdminException - an unexpected exception in the KonaKart Admin engine typically when the email
could not be sentpublic int getOrdersCount(java.lang.String sessionId,
int orderStatus)
throws KKAdminException
KKAdminIfgetOrdersCount in interface KKAdminIfsessionId - The session Id of the logged in userorderStatus - the order status IdKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminOrderSearchResult getOrdersLite(java.lang.String sessionId, AdminOrderSearch _search, int offset, int size, int languageId) throws KKAdminException
KKAdminIfThe orders returned are sparsely-populated with:
The returned orders may be sorted by:
getOrdersLite in interface KKAdminIfsessionId - The session Id of the logged in user_search - the Orders search criteria object (String sessionId, can be null)offset - offset in the databasesize - max number of records to return from the offsetlanguageId - the language Id - or it could be
com.konakartadmin.bl.AdminLanguageMgr.DEFAULT_LANG to use the default languageKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminOrderSearchResult getOrders(java.lang.String sessionId, AdminOrderSearch _search, int offset, int size, int languageId) throws KKAdminException
KKAdminIffillOrderProducts is
set to true on the AdminOrderSearch object, the orders are populated with order products. For
performance reasons the default behaviour is not to populate the order products.
The returned orders may be sorted by:
getOrders in interface KKAdminIfsessionId - The session Id of the logged in user_search - the definition of the search for orders - can be nulloffset - the offset in the databasesize - the number of records from the specified offsetlanguageId - the language Id - or it could be
com.konakartadmin.bl.AdminLanguageMgr.DEFAULT_LANG to use the default languageKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminOrder getOrderForOrderId(java.lang.String sessionId, int orderId) throws KKAdminException
KKAdminIfgetOrderForOrderId in interface KKAdminIfsessionId - The session id of the logged in userorderId - The numeric id of the AdminOrder objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminOrder getOrderForOrderIdAndLangId(java.lang.String sessionId, int orderId, int languageId) throws KKAdminException
KKAdminIfgetOrderForOrderIdAndLangId in interface KKAdminIfsessionId - The session id of the logged in userorderId - The numeric id of the AdminOrder objectlanguageId - the language Id - or it could be
com.konakartadmin.bl.AdminLanguageMgr.DEFAULT_LANG to use the default languageKKAdminException - an unexpected exception in the KonaKart Admin engine@Deprecated public AdminOrder[] getOrdersCreatedSince(java.lang.String sessionId, java.util.Calendar since, int languageId) throws KKAdminException
KKAdminIfgetOrdersCreatedSince in interface KKAdminIfsessionId - The session Id of the logged in usersince - the date to use to define the range of orders to returnlanguageId - the language Id - or it could be
com.konakartadmin.bl.AdminLanguageMgr.DEFAULT_LANG to use the default languageKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void updateOrder(java.lang.String sessionId,
int orderId,
int orderStatus,
java.lang.String comments,
boolean notifyCustomer,
AdminOrderUpdate updateOrder)
throws KKAdminException
KKAdminIfupdateOrder in interface KKAdminIfsessionId - The session Id of the logged in userorderId - the order idorderStatus - the new Order Statuscomments - if not null, these comments are addednotifyCustomer - if true the customer will be notified by emailupdateOrder - contains order update data such as who updated the orderKKAdminException - an unexpected exception in the KonaKart Admin engine@Deprecated
public void updateOrderStatus(java.lang.String sessionId,
int orderId,
int orderStatus,
java.lang.String comments,
boolean notifyCustomer)
throws KKAdminException
KKAdminIfupdateOrderStatus in interface KKAdminIfsessionId - The session Id of the logged in userorderId - the order idorderStatus - the new Order Statuscomments - if not null, these comments are addednotifyCustomer - if true the customer will be notified by emailKKAdminException - an unexpected exception in the KonaKart Admin enginepublic java.lang.String getHtml(java.lang.String sessionId,
int htmlType,
int id,
int languageId,
java.lang.String arg1)
throws KKAdminException
KKAdminIf"HTML types" can be one of:
getHtml in interface KKAdminIfsessionId - The session Id of the logged in userhtmlType - the HTML type eg. KonakartAdminConstants.HTML_ORDER_DETAILid - a record Id the use is dependent on the htmlTypelanguageId - the languageId for the language that the HTML should be inarg1 - an argument whose use is dependent on the htmlTypeKKAdminException - an unexpected exception in the KonaKart Admin enginepublic PdfResult getPdf(java.lang.String sessionId, PdfOptions options) throws KKAdminException
KKAdminIfgetPdf in interface KKAdminIfsessionId - The session Id of the logged in useroptions - the options that define the PDF report to be produced and what is returned from
this interface.KKAdminException - an unexpected exception in the KonaKart Admin enginepublic int getCustomersCount(java.lang.String sessionId,
AdminCustomerSearch search)
throws KKAdminException
KKAdminIfgetCustomersCount in interface KKAdminIfsessionId - The session Id of the logged in usersearch - the definition of the search for customers - can be nullKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int getCustomersCountWhoHaventPlacedAnOrderSince(java.lang.String sessionId,
java.util.Calendar lastOrderDate)
throws KKAdminException
KKAdminIfgetCustomersCountWhoHaventPlacedAnOrderSince in interface KKAdminIfsessionId - The session id of the logged in userlastOrderDate - The date when the last order was placedKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int getCustomersCountWhoHavePlacedAnOrderSince(java.lang.String sessionId,
java.util.Calendar lastOrderDate)
throws KKAdminException
KKAdminIfgetCustomersCountWhoHavePlacedAnOrderSince in interface KKAdminIfsessionId - The session id of the logged in userlastOrderDate - The date when the last order was placedKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void updateCustomer(java.lang.String sessionId,
AdminCustomer customer)
throws KKAdminException
KKAdminIfupdateCustomer in interface KKAdminIfsessionId - The session Id of the logged in usercustomer - A customerKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void updateCustomerWithOptions(java.lang.String sessionId,
AdminCustomer customer,
AdminUpdateCustomerOptions options)
throws KKAdminException
KKAdminIfupdateCustomerWithOptions in interface KKAdminIfsessionId - The session Id of the logged in usercustomer - A customeroptions - Allows you to define whether KonaKart should check that the telephone number being
set is unique (does not belong to an existing registered customer).KKAdminException - an unexpected exception in the KonaKart Admin enginepublic int updateCustomerGroup(java.lang.String sessionId,
AdminCustomerGroup custGroup)
throws KKAdminException
KKAdminIfupdateCustomerGroup in interface KKAdminIfsessionId - The session Id of the logged in usercustGroup - A customer group objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int deleteCustomer(java.lang.String sessionId,
int custId)
throws KKAdminException
KKAdminIfdeleteCustomer in interface KKAdminIfsessionId - The session Id of the logged in usercustId - A customer idKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int deleteCustomerGroup(java.lang.String sessionId,
int custGroupId)
throws KKAdminException
KKAdminIfdeleteCustomerGroup in interface KKAdminIfsessionId - The session Id of the logged in usercustGroupId - The id of a customer group objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int deleteOrder(java.lang.String sessionId,
int ordId)
throws KKAdminException
KKAdminIfdeleteOrder in interface KKAdminIfsessionId - The session Id of the logged in userordId - Order id of the order to deleteKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminCustomerSearchResult getCustomers(java.lang.String sessionId, AdminCustomerSearch search, int offset, int size) throws KKAdminException
KKAdminIfgetCustomers in interface KKAdminIfsessionId - The session Id of the logged in usersearch - the definition of the search for customers - can be nulloffset - the offset in the databasesize - the number of records from the specified offsetKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminCustomerSearchResult getCustomersLite(java.lang.String sessionId, AdminCustomerSearch search, int offset, int size) throws KKAdminException
KKAdminIfgetCustomersLite in interface KKAdminIfsessionId - The session Id of the logged in usersearch - the definition of the search for customers - can be nulloffset - the offset in the databasesize - the number of records from the specified offsetKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminCustomer getCustomerForId(java.lang.String sessionId, int customerId) throws KKAdminException
KKAdminIfgetCustomerForId in interface KKAdminIfsessionId - The session Id of the logged in usercustomerId - The numeric id of the customerKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminCustomer getCustomerForIdWithOptions(java.lang.String sessionId, int customerId, AdminGetCustomerOptions options) throws KKAdminException
KKAdminIfgetCustomerForIdWithOptions in interface KKAdminIfsessionId - The session Id of the logged in usercustomerId - The numeric id of the customeroptions - Options allowing you to configure the API call in order to populate customer
children when implementing a hierarchical customer structure.KKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminProductNotification[] getProductNotificationsForCustomer(java.lang.String sessionId, int customerId) throws KKAdminException
KKAdminIfgetProductNotificationsForCustomer in interface KKAdminIfsessionId - session IdcustomerId - Id of the customer whose product notifications will be returnedKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int deleteTaxRate(java.lang.String sessionId,
int id)
throws KKAdminException
KKAdminIfdeleteTaxRate in interface KKAdminIfsessionId - The session Id of the logged in userid - A TaxRate idKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertTaxRate(java.lang.String sessionId,
AdminTaxRate insertObj)
throws KKAdminException
KKAdminIfinsertTaxRate in interface KKAdminIfsessionId - The session Id of the logged in userinsertObj - An AdminTaxRate objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int updateTaxRate(java.lang.String sessionId,
AdminTaxRate updateObj)
throws KKAdminException
KKAdminIfupdateTaxRate in interface KKAdminIfsessionId - The session Id of the logged in userupdateObj - An AdminTaxRate objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int deleteZone(java.lang.String sessionId,
int id)
throws KKAdminException
KKAdminIfdeleteZone in interface KKAdminIfsessionId - The session Id of the logged in userid - A Zone idKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertZone(java.lang.String sessionId,
AdminZone insertObj)
throws KKAdminException
KKAdminIfinsertZone in interface KKAdminIfsessionId - The session Id of the logged in userinsertObj - An AdminZone objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int updateZone(java.lang.String sessionId,
AdminZone updateObj)
throws KKAdminException
KKAdminIfupdateZone in interface KKAdminIfsessionId - The session Id of the logged in userupdateObj - An AdminZone objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int deleteTaxClass(java.lang.String sessionId,
int id)
throws KKAdminException
KKAdminIfdeleteTaxClass in interface KKAdminIfsessionId - The session Id of the logged in userid - A TaxClass idKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertTaxClass(java.lang.String sessionId,
AdminTaxClass insertObj)
throws KKAdminException
KKAdminIfinsertTaxClass in interface KKAdminIfsessionId - The session Id of the logged in userinsertObj - An AdminTaxClass objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int updateTaxClass(java.lang.String sessionId,
AdminTaxClass updateObj)
throws KKAdminException
KKAdminIfupdateTaxClass in interface KKAdminIfsessionId - The session Id of the logged in userupdateObj - An AdminTaxClass objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int deleteAddressFormat(java.lang.String sessionId,
int id)
throws KKAdminException
KKAdminIfdeleteAddressFormat in interface KKAdminIfsessionId - The session Id of the logged in userid - A AddressFormat idKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertAddressFormat(java.lang.String sessionId,
AdminAddressFormat insertObj)
throws KKAdminException
KKAdminIfinsertAddressFormat in interface KKAdminIfsessionId - The session Id of the logged in userinsertObj - An AdminAddressFormat objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int updateAddressFormat(java.lang.String sessionId,
AdminAddressFormat updateObj)
throws KKAdminException
KKAdminIfupdateAddressFormat in interface KKAdminIfsessionId - The session Id of the logged in userupdateObj - An AdminAddressFormat objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int deleteGeoZone(java.lang.String sessionId,
int id)
throws KKAdminException
KKAdminIfdeleteGeoZone in interface KKAdminIfsessionId - The session Id of the logged in userid - A GeoZone idKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertGeoZone(java.lang.String sessionId,
AdminGeoZone insertObj)
throws KKAdminException
KKAdminIfinsertGeoZone in interface KKAdminIfsessionId - The session Id of the logged in userinsertObj - An AdminGeoZone objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int updateGeoZone(java.lang.String sessionId,
AdminGeoZone updateObj)
throws KKAdminException
KKAdminIfupdateGeoZone in interface KKAdminIfsessionId - The session Id of the logged in userupdateObj - An AdminGeoZone objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int deleteSubZone(java.lang.String sessionId,
int id)
throws KKAdminException
KKAdminIfdeleteSubZone in interface KKAdminIfsessionId - The session Id of the logged in userid - A SubZone idKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertSubZone(java.lang.String sessionId,
AdminSubZone insertObj)
throws KKAdminException
KKAdminIfinsertSubZone in interface KKAdminIfsessionId - The session Id of the logged in userinsertObj - An AdminSubZone objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int updateSubZone(java.lang.String sessionId,
AdminSubZone updateObj)
throws KKAdminException
KKAdminIfupdateSubZone in interface KKAdminIfsessionId - The session Id of the logged in userupdateObj - An AdminSubZone objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic java.lang.String[] getConfigurationInfo(java.lang.String sessionId,
java.lang.String[] validationKeys)
throws KKAdminException
KKAdminIfgetConfigurationInfo in interface KKAdminIfsessionId - The session Id of the logged in uservalidationKeys - an array of configuration keysKKAdminException - an unexpected exception in the KonaKart Admin enginepublic KKConfiguration[] getAllConfigurations(java.lang.String sessionId) throws KKAdminException
KKAdminIfgetAllConfigurations in interface KKAdminIfsessionId - The session Id of the logged in userKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminConfigurationGroup[] getAllConfigurationGroups(java.lang.String sessionId) throws KKAdminException
KKAdminIfgetAllConfigurationGroups in interface KKAdminIfsessionId - The session Id of the logged in userKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void updateConfiguration(java.lang.String sessionId,
KKConfiguration newConf)
throws KKAdminException
KKAdminIfupdateConfiguration in interface KKAdminIfsessionId - The session Id of the logged in usernewConf - the KKConfiguration to updateKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void updateConfigurationGroup(java.lang.String sessionId,
AdminConfigurationGroup newConf)
throws KKAdminException
KKAdminIfupdateConfigurationGroup in interface KKAdminIfsessionId - The session Id of the logged in usernewConf - the AdminConfigurationGroup to updateKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminConfigurationGroup[] getConfigurationGroupsByTitle(java.lang.String sessionId, java.lang.String title) throws KKAdminException
KKAdminIfgetConfigurationGroupsByTitle in interface KKAdminIfsessionId - The session Id of the logged in usertitle - the titleKKAdminException - an unexpected exception in the KonaKart Admin enginepublic KKConfiguration getConfigurationByKey(java.lang.String sessionId, java.lang.String key) throws KKAdminException
KKAdminIfgetConfigurationByKey in interface KKAdminIfsessionId - The session Id of the logged in userkey - the Configuration key to search forKKAdminException - an unexpected exception in the KonaKart Admin enginepublic KKConfiguration[] getConfigurationsByGroup(java.lang.String sessionId, int configGroup) throws KKAdminException
KKAdminIfgetConfigurationsByGroup in interface KKAdminIfsessionId - The session Id of the logged in userconfigGroup - the Configuration Group IdKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void saveConfigs(java.lang.String sessionId,
KKConfiguration[] configs,
KKConfiguration[] origConfigs)
throws KKAdminException
KKAdminIfsaveConfigs in interface KKAdminIfsessionId - The session Id of the logged in userconfigs - Configuration array to saveorigConfigs - Original Configuration array to compare againstKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void insertConfigs(java.lang.String sessionId,
KKConfiguration[] configs)
throws KKAdminException
KKAdminIfinsertConfigs in interface KKAdminIfsessionId - The session Id of the logged in userconfigs - an array of KKConfiguration objects to insertKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void removeConfigs(java.lang.String sessionId,
java.lang.String[] configKeys)
throws KKAdminException
KKAdminIfremoveConfigs in interface KKAdminIfsessionId - The session Id of the logged in userconfigKeys - an array of configuration key Strings to removeKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminConfigData[] getConfigData(java.lang.String sessionId, java.lang.String key) throws KKAdminException
KKAdminIfgetConfigData in interface KKAdminIfsessionId - Session Id of the user.key - Only return the AdminConfigData items with this key (if null all AdminConfigData
items are returned).KKAdminException - an unexpected exception in the KonaKart Admin enginepublic void updateConfigData(java.lang.String sessionId,
AdminConfigData[] configs)
throws KKAdminException
KKAdminIfupdateConfigData in interface KKAdminIfsessionId - Session Id of the user.configs - The AdminConfigData items to updateKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int[] insertConfigData(java.lang.String sessionId,
AdminConfigData[] configs)
throws KKAdminException
KKAdminIfinsertConfigData in interface KKAdminIfsessionId - Session Id of the user.configs - The AdminConfigData items to insertKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void removeConfigData(java.lang.String sessionId,
int id)
throws KKAdminException
KKAdminIfremoveConfigData in interface KKAdminIfsessionId - Session Id of the user.id - The id of the AdminConfigData items to removeKKAdminException - an unexpected exception in the KonaKart Admin enginepublic KKModule[] getModules(java.lang.String sessionId, int moduleType) throws KKAdminException
KKAdminIfValid types are:
getModules in interface KKAdminIfsessionId - The session Id of the logged in usermoduleType - the Configuration Group IdKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int registerCustomer(java.lang.String sessionId,
AdminCustomerRegistration custReg)
throws KKAdminException
KKAdminIfregisterCustomer in interface KKAdminIfsessionId - The session Id of the logged in usercustReg - Customer Registration details.KKAdminException - an unexpected exception in the KonaKart Admin engine If an admin user or
registered customer already exists with the same eMail addresspublic int forceRegisterCustomer(java.lang.String sessionId,
AdminCustomerRegistration custReg)
throws KKAdminException
KKAdminIfThis method is intended to be used when interfacing to a SSO system for logging in admin users. The idea is that admin users are registered within KonaKart if the SSO system determines that they have adequate privileges. Once registered they are given a role and then logged in by calling other API calls. The information as to which role(s) they should be allocated is also determined from information retrieved from the SSO system. When the KonaKart session expires, the process is repeated and so the admin user has to be re-registered probably using very similar information. The registerCustomer() API call would throw an exception, whereas this API call deletes the existing admin user and registers a new one.
forceRegisterCustomer in interface KKAdminIfsessionId - The session Id of the logged in usercustReg - Customer Registration detailsKKAdminException - an unexpected exception in the KonaKart Admin engine if a registered customer
already exists with the same eMail addresspublic void resetCustomerPassword(java.lang.String sessionId,
int custId)
throws KKAdminException
KKAdminIfresetCustomerPassword in interface KKAdminIfsessionId - The session Id of the logged in usercustId - Customer IdKKAdminException - an unexpected exception in the KonaKart Admin engine if the customer is not
found, or problems resetting the password or sending the email.public void resetCustomerPasswordSpecifyingEmail(java.lang.String sessionId,
int custId,
java.lang.String eMailAddress)
throws KKAdminException
KKAdminIfThis API call should only be used when the emailAddress attribute of the AdminCustomer doesn't specify where the eMail should be sent.
resetCustomerPasswordSpecifyingEmail in interface KKAdminIfsessionId - the sessionIdcustId - Customer IdeMailAddress - The eMail address to override the one from the customer objectKKAdminException - an unexpected exception in the KonaKart Admin engine if the customer is not
found, or problems resetting the password or sending the email.public void setCustomerPassword(java.lang.String sessionId,
int custId,
java.lang.String newPassword)
throws KKAdminException
KKAdminIfsetCustomerPassword in interface KKAdminIfsessionId - The session Id of the logged in usercustId - Customer IdnewPassword - New password (as entered by the user)KKAdminException - an unexpected exception in the KonaKart Admin enginepublic void changePassword(java.lang.String sessionId,
java.lang.String currentPassword,
java.lang.String newPassword)
throws KKAdminException
KKAdminIfchangePassword in interface KKAdminIfsessionId - The session Id of the logged in usercurrentPassword - current PasswordnewPassword - new PasswordKKAdminException - an unexpected exception in the KonaKart Admin engine if the current password
doesn't match or the newPassword cannot be validatedpublic boolean checkPasswordValidity(java.lang.String sessionId,
java.lang.String password,
int userId)
throws KKAdminException
KKAdminIfcheckPasswordValidity in interface KKAdminIfsessionId - The session Id of the logged in userpassword - the new Password to check for validityuserId - the user that the password belongs to. If this is specified as -1 no password
validity checks related to the user are carried out.KKAdminException - an unexpected exception in the KonaKart Admin engine if theres's an unexpected
problem or the password is found to be invalid. If the password is found to be
invalid the msgKey attribute of the KKAdminException will contain a message
catalogue that references a message that explains why.public void changeUserPassword(java.lang.String user,
java.lang.String currentPassword,
java.lang.String newPassword)
throws KKAdminException
KKAdminIfchangeUserPassword in interface KKAdminIfuser - The username of the user whose password should be changed.currentPassword - current PasswordnewPassword - new PasswordKKAdminException - an unexpected exception in the KonaKart Admin engine if the user cannot be logged
in, current password doesn't match or the newPassword cannot be validatedpublic int insertProduct(java.lang.String sessionId,
AdminProduct product)
throws KKAdminException
KKAdminIfinsertProduct in interface KKAdminIfsessionId - The session Id of the logged in userproduct - An AdminProduct objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertProductWithOptions(java.lang.String sessionId,
AdminProduct product,
AdminProductMgrOptions mgrOptions)
throws KKAdminException
KKAdminIfinsertProductWithOptions in interface KKAdminIfsessionId - The session Id of the logged in userproduct - An AdminProduct objectmgrOptions - Allows you to define whether the quantity and prices can have different values
depending on the catalogId. May be set to null.KKAdminException - an unexpected exception in the KonaKart Admin enginepublic void editProduct(java.lang.String sessionId,
AdminProduct product)
throws KKAdminException
KKAdminIfeditProduct in interface KKAdminIfsessionId - The session Id of the logged in userproduct - AdminProduct objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void editProductWithOptions(java.lang.String sessionId,
AdminProduct product,
AdminProductMgrOptions mgrOptions)
throws KKAdminException
KKAdminIfeditProductWithOptions in interface KKAdminIfsessionId - The session Id of the logged in userproduct - AdminProduct objectmgrOptions - Allows you to define whether the quantity and prices can have different values
depending on the catalogId. May be set to null.KKAdminException - an unexpected exception in the KonaKart Admin enginepublic boolean doesProductExist(java.lang.String sessionId,
int productId)
throws KKAdminException
KKAdminIfdoesProductExist in interface KKAdminIfsessionId - The session Id of the logged in userproductId - The id of the productKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminProduct getProduct(java.lang.String sessionId, int productId) throws KKAdminException
KKAdminIfgetProduct in interface KKAdminIfsessionId - The session Id of the logged in userproductId - The numeric id of the productKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminProduct getProductWithOptions(java.lang.String sessionId, int productId, AdminProductMgrOptions mgrOptions) throws KKAdminException
KKAdminIfgetProductWithOptions in interface KKAdminIfsessionId - The session Id of the logged in userproductId - The numeric id of the productmgrOptions - It defines whether to use prices and quantity for the catalog defined by the
catalogId.KKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminProducts searchForProducts(java.lang.String sessionId, AdminDataDescriptor dataDesc, AdminProductSearch prodSearch, int languageId) throws KKAdminException
KKAdminIfThe AdminDataDescriptor allows you to:
showInvisible to trueshowInactive to trueThe AdminProductSearch product allows you to enter additional search parameters.
The Products may be sorted by :
searchForProducts in interface KKAdminIfsessionId - The session id of the logged in userdataDesc - Used to control the data offset, limit the number of items returned and set the
sort orderprodSearch - An object containing the search criterialanguageId - the language Id - or it could be
com.konakartadmin.bl.AdminLanguageMgr.DEFAULT_LANG to use the default languageKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminProducts searchForProductsWithOptions(java.lang.String sessionId, AdminDataDescriptor dataDesc, AdminProductSearch prodSearch, int languageId, AdminProductMgrOptions mgrOptions) throws KKAdminException
KKAdminIfThe AdminDataDescriptor allows you to:
showInvisible to trueshowInactive to trueThe AdminProductSearch product allows you to enter additional search parameters.
The Products may be sorted by :
The MgrOptions object defines whether to use prices and quantity for the catalog defined by the catalogId.
searchForProductsWithOptions in interface KKAdminIfsessionId - The session id of the logged in userdataDesc - Used to control the data offset, limit the number of items returned and set the
sort orderprodSearch - An object containing the search criterialanguageId - the language Id - or it could be
com.konakartadmin.bl.AdminLanguageMgr.DEFAULT_LANG to use the default languagemgrOptions - It defines whether to use prices and quantity for the catalog defined by the
catalogId.KKAdminException - an unexpected exception in the KonaKart Admin enginepublic void deleteProduct(java.lang.String sessionId,
int productId)
throws KKAdminException
KKAdminIfdeleteProduct in interface KKAdminIfsessionId - The session Id of the logged in userproductId - The numeric id of the productKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void deleteProducts(java.lang.String sessionId,
AdminCommonOptions options)
throws KKAdminException
KKAdminIfdeleteProducts in interface KKAdminIfsessionId - The session Id of the logged in useroptions - An AdminCommonOptions object. Set the ids of the products to delete in the ids
attribute.KKAdminException - an unexpected exception in the KonaKart Admin enginepublic void deleteCategoryTree(java.lang.String sessionId,
int categoryId,
int options)
throws KKAdminException
KKAdminIfThe options can be set to AdminCategoryMgr.DELETE_CHILDREN or AdminCategoryMgr.ATTACH_CHILDREN_TO_PARENT . In the first case, the category and all of its children (String sessionId, categories and products) are deleted. In the second case, only the category referenced by categoryId is deleted and all of its children are attached to its parent. However, if the category is a top level category, then the products directly associated with that category will be deleted since there is no parent category to attach them to.
deleteCategoryTree in interface KKAdminIfsessionId - The session Id of the logged in usercategoryId - The numeric id of the categoryoptions - Can be set to AdminCategoryMgr.DELETE_CHILDREN or
AdminCategoryMgr.ATTACH_CHILDREN_TO_PARENTKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void deleteSingleCategory(java.lang.String sessionId,
int categoryId)
throws KKAdminException
KKAdminIfdeleteSingleCategory in interface KKAdminIfsessionId - The session Id of the logged in usercategoryId - The numeric id of the categoryKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void editCategory(java.lang.String sessionId,
AdminCategory cat)
throws KKAdminException
KKAdminIfeditCategory in interface KKAdminIfsessionId - The session Id of the logged in usercat - An AdminCategory objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertCategory(java.lang.String sessionId,
AdminCategory cat)
throws KKAdminException
KKAdminIfinsertCategory in interface KKAdminIfsessionId - The session Id of the logged in usercat - An AdminCategory objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void moveCategory(java.lang.String sessionId,
int categoryId,
int newParentId)
throws KKAdminException
KKAdminIfmoveCategory in interface KKAdminIfsessionId - The session Id of the logged in usercategoryId - The numeric id of the categorynewParentId - the newParentIdKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void deleteManufacturer(java.lang.String sessionId,
int manufacturerId,
boolean deleteProducts)
throws KKAdminException
KKAdminIfdeleteManufacturer in interface KKAdminIfsessionId - The session Id of the logged in usermanufacturerId - The numeric id of the manufacturerdeleteProducts - Set to true to delete all of the products associated with the manufacturerKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void editManufacturer(java.lang.String sessionId,
AdminManufacturer manu)
throws KKAdminException
KKAdminIfmanu parameter.editManufacturer in interface KKAdminIfsessionId - The session Id of the logged in usermanu - AdminManufacturer objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertManufacturer(java.lang.String sessionId,
AdminManufacturer manu)
throws KKAdminException
KKAdminIfinsertManufacturer in interface KKAdminIfsessionId - The session Id of the logged in usermanu - An AdminManufacturer objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void deleteReview(java.lang.String sessionId,
int reviewId)
throws KKAdminException
KKAdminIfdeleteReview in interface KKAdminIfsessionId - The session Id of the logged in userreviewId - NUmeric id of the reviewKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void deleteReviewsPerCustomer(java.lang.String sessionId,
int customerId)
throws KKAdminException
KKAdminIfdeleteReviewsPerCustomer in interface KKAdminIfsessionId - The session Id of the logged in usercustomerId - The customer idKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void deleteVendorReviewsPerCustomer(java.lang.String sessionId,
int customerId)
throws KKAdminException
KKAdminIfdeleteVendorReviewsPerCustomer in interface KKAdminIfsessionId - The session Id of the logged in usercustomerId - The customer idKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void deleteVendorReview(java.lang.String sessionId,
int reviewId)
throws KKAdminException
KKAdminIfdeleteVendorReview in interface KKAdminIfsessionId - The session Id of the logged in userreviewId - NUmeric id of the reviewKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void editReview(java.lang.String sessionId,
AdminReview review)
throws KKAdminException
KKAdminIfeditReview in interface KKAdminIfsessionId - The session Id of the logged in userreview - AdminReview objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminReviews getAllReviews(java.lang.String sessionId, AdminDataDescriptor dataDesc) throws KKAdminException
KKAdminIfgetAllReviews in interface KKAdminIfsessionId - The session Id of the logged in userdataDesc - Used to control the data offset, limit the number of items returned and set the
sort orderKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminReview getReview(java.lang.String sessionId, int reviewId) throws KKAdminException
KKAdminIfgetReview in interface KKAdminIfsessionId - The session Id of the logged in userreviewId - The numeric id of the AdminReview objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminReviews getReviewsPerProduct(java.lang.String sessionId, AdminDataDescriptor dataDesc, int productId) throws KKAdminException
KKAdminIfgetReviewsPerProduct in interface KKAdminIfsessionId - The session Id of the logged in userdataDesc - Used to control the data offset, limit the number of items returned and set the
sort orderproductId - The numeric id of the productKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminReviews getReviews(java.lang.String sessionId, AdminDataDescriptor dataDesc, AdminReviewSearch revSearch) throws KKAdminException
KKAdminIfgetReviews in interface KKAdminIfsessionId - The session Id of the logged in userdataDesc - Used to control the data offset, limit the number of items returned and set the
sort orderrevSearch - The search criteriaKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertReview(java.lang.String sessionId,
AdminReview review)
throws KKAdminException
KKAdminIfinsertReview in interface KKAdminIfsessionId - The session Id of the logged in userreview - The AdminReview objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertSpecial(java.lang.String sessionId,
AdminSpecial special)
throws KKAdminException
KKAdminIfinsertSpecial in interface KKAdminIfsessionId - The session Id of the logged in userspecial - The AdminSpecial objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminSpecial getSpecial(java.lang.String sessionId, int specialId) throws KKAdminException
KKAdminIfgetSpecial in interface KKAdminIfsessionId - The session Id of the logged in userspecialId - The numeric id of the AdminSpecial objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void deleteSpecial(java.lang.String sessionId,
int specialId)
throws KKAdminException
KKAdminIfdeleteSpecial in interface KKAdminIfsessionId - The session Id of the logged in userspecialId - The numeric id of the specialKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void editSpecial(java.lang.String sessionId,
AdminSpecial special)
throws KKAdminException
KKAdminIfeditSpecial in interface KKAdminIfsessionId - The session Id of the logged in userspecial - AdminSpecial objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminProducts getAllSpecials(java.lang.String sessionId, AdminDataDescriptor dataDesc, int languageId) throws KKAdminException
KKAdminIfThe Specials may be sorted by :
getAllSpecials in interface KKAdminIfsessionId - The session Id of the logged in userdataDesc - Used to control the data offset, limit the number of items returned and set the
sort orderlanguageId - the language Id - or it could be
com.konakartadmin.bl.AdminLanguageMgr.DEFAULT_LANG to use the default languageKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminProducts getSpecialsPerCategory(java.lang.String sessionId, AdminDataDescriptor dataDesc, int categoryId, boolean searchInSubCats, int languageId) throws KKAdminException
KKAdminIfThe Specials may be sorted by :
getSpecialsPerCategory in interface KKAdminIfsessionId - The session Id of the logged in userdataDesc - Used to control the data offset, limit the number of items returned and set the
sort ordercategoryId - The numeric id of the categorysearchInSubCats - Determines whether products are searched for in the sub-categories of the
specified categorylanguageId - the language Id - or it could be
com.konakartadmin.bl.AdminLanguageMgr.DEFAULT_LANG to use the default languageKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void deleteProductOptions(java.lang.String sessionId,
int productOptionId)
throws KKAdminException
KKAdminIfdeleteProductOptions in interface KKAdminIfsessionId - The session Id of the logged in userproductOptionId - The numeric id of the productOptionKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void deleteProductOptionValues(java.lang.String sessionId,
int productOptionValueId)
throws KKAdminException
KKAdminIfdeleteProductOptionValues in interface KKAdminIfsessionId - The session Id of the logged in userproductOptionValueId - The numeric id of the productOptionValueKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminProductOption[] getProductOptionsPerId(java.lang.String sessionId, int productOptionId) throws KKAdminException
KKAdminIfgetProductOptionsPerId in interface KKAdminIfsessionId - The session Id of the logged in userproductOptionId - The numeric id of the AdminProductOptionKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminProductOption[] getProductOptionsPerName(java.lang.String sessionId, java.lang.String name, int langId) throws KKAdminException
KKAdminIfgetProductOptionsPerName in interface KKAdminIfsessionId - The session Id of the logged in username - Product Option NamelangId - Language Id specifies that the product option values should be returned for this
language. Can specify AdminLanguageMgr.DEFAULT_LANG to specify the default
language.KKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminProductOptionValue[] getAllProductOptionValues(java.lang.String sessionId, int languageId) throws KKAdminException
KKAdminIfgetAllProductOptionValues in interface KKAdminIfsessionId - The session Id of the logged in userlanguageId - specifies that the product option values should be returned for this language. Can
specify AdminLanguageMgr.DEFAULT_LANG to specify the default language, or specify
AdminLanguageMgr.ALL_LANGUAGES to specify all languagesKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminProductOptionValue[] getProductOptionValuesPerId(java.lang.String sessionId, int productOptionValueId) throws KKAdminException
KKAdminIfgetProductOptionValuesPerId in interface KKAdminIfsessionId - The session Id of the logged in userproductOptionValueId - the productOptionValueIdKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminProductOptionValue[] getProductOptionValuesPerName(java.lang.String sessionId, java.lang.String name, int languageId) throws KKAdminException
KKAdminIfgetProductOptionValuesPerName in interface KKAdminIfsessionId - The session Id of the logged in username - product option value namelanguageId - language id (can use AdminLanguageMgr.DEFAULT_LANG to get the default language)KKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminProdOptionValToProdOption[] getProductOptionValueToProductOptions(java.lang.String sessionId, AdminProdOptionValToProdOption prodOptValToProdOpt) throws KKAdminException
KKAdminIfgetProductOptionValueToProductOptions in interface KKAdminIfsessionId - The session Id of the logged in userprodOptValToProdOpt - the AdminProdOptionValToProdOption to look up. Only uses the optionId and
OptionValueId in this objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void insertProductOption(java.lang.String sessionId,
AdminProductOption productOption)
throws KKAdminException
KKAdminIfinsertProductOption in interface KKAdminIfsessionId - The session Id of the logged in userproductOption - An AdminProductOption objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void editProductOption(java.lang.String sessionId,
AdminProductOption productOption)
throws KKAdminException
KKAdminIfeditProductOption in interface KKAdminIfsessionId - The session Id of the logged in userproductOption - AdminProductOption objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertProductsOptionsValuesToProductsOptions(java.lang.String sessionId,
AdminProdOptionValToProdOption prodOptValToProdOpt)
throws KKAdminException
KKAdminIfinsertProductsOptionsValuesToProductsOptions in interface KKAdminIfsessionId - The session Id of the logged in userprodOptValToProdOpt - a AdminProdOptionValToProdOption object to insert. The optionId and optionValueId
defined in the object must be valid otherwise an exception is thrown.KKAdminException - an unexpected exception in the KonaKart Admin enginepublic void insertProductOptionValue(java.lang.String sessionId,
AdminProductOptionValue productOptionValue,
int productOptionId)
throws KKAdminException
KKAdminIfinsertProductOptionValue in interface KKAdminIfsessionId - The session Id of the logged in userproductOptionValue - An AdminProductOptionValue objectproductOptionId - The product option id for inserting a record into the
Products_Options_Values_To_Products_Options table. If this is set to -1, no such
join record is inserted.KKAdminException - an unexpected exception in the KonaKart Admin enginepublic void editProductOptionValue(java.lang.String sessionId,
AdminProductOptionValue productOptionValue)
throws KKAdminException
KKAdminIfeditProductOptionValue in interface KKAdminIfsessionId - The session Id of the logged in userproductOptionValue - AdminProductOptionValue objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int getNextProductOptionId(java.lang.String sessionId)
throws KKAdminException
KKAdminIfgetNextProductOptionId in interface KKAdminIfsessionId - The session Id of the logged in userKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int getNextProductOptionValuesId(java.lang.String sessionId)
throws KKAdminException
KKAdminIfgetNextProductOptionValuesId in interface KKAdminIfsessionId - The session Id of the logged in userKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminProductAttribute[] getProductAttributesPerProduct(java.lang.String sessionId, int productId) throws KKAdminException
KKAdminIfgetProductAttributesPerProduct in interface KKAdminIfsessionId - The session Id of the logged in userproductId - The numeric id of the productKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void deleteProductAttribute(java.lang.String sessionId,
int productAttributeId)
throws KKAdminException
KKAdminIfdeleteProductAttribute in interface KKAdminIfsessionId - The session Id of the logged in userproductAttributeId - The numeric id of the product attributeKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void deleteProductAttributesPerProduct(java.lang.String sessionId,
int productId)
throws KKAdminException
KKAdminIfdeleteProductAttributesPerProduct in interface KKAdminIfsessionId - The session Id of the logged in userproductId - The numeric id of the productKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void editProductAttribute(java.lang.String sessionId,
AdminProductAttribute prodAttr)
throws KKAdminException
KKAdminIfeditProductAttribute in interface KKAdminIfsessionId - The session Id of the logged in userprodAttr - AdminProductAttribute objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertProductAttribute(java.lang.String sessionId,
AdminProductAttribute prodAttr)
throws KKAdminException
KKAdminIfinsertProductAttribute in interface KKAdminIfsessionId - The session Id of the logged in userprodAttr - An AdminProductAttribute objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertProductOptionValues(java.lang.String sessionId,
AdminProductOptionValue[] productOptionValues,
int productOptionId)
throws KKAdminException
KKAdminIfinsertProductOptionValues in interface KKAdminIfsessionId - The session Id of the logged in userproductOptionValues - An array of AdminProductOptionValue objectsproductOptionId - The numeric id of the AdminProductOption objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertProductOptions(java.lang.String sessionId,
AdminProductOption[] productOptions)
throws KKAdminException
KKAdminIfinsertProductOptions in interface KKAdminIfsessionId - The session Id of the logged in userproductOptions - An array of AdminProductOption objectsKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminIpnHistories searchForIpnHistory(java.lang.String sessionId, AdminDataDescriptor dataDesc, AdminIpnSearch ipnSearch) throws KKAdminException
KKAdminIfsearchForIpnHistory in interface KKAdminIfsessionId - The session Id of the logged in userdataDesc - Used to control the data offset, limit the number of items returned and set the
sort orderipnSearch - An object containing the search criteriaKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertIpnHistory(java.lang.String sessionId,
AdminIpnHistory ipnHistory)
throws KKAdminException
KKAdminIfinsertIpnHistory in interface KKAdminIfsessionId - The session Id of the logged in useripnHistory - the AdminIpnHistory record to insert into the databaseKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int deleteExpiredSessions(java.lang.String sessionId)
throws KKAdminException
KKAdminIfdeleteExpiredSessions in interface KKAdminIfsessionId - The session Id of the logged in userKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminFile[] getConfigFiles(java.lang.String sessionId) throws KKAdminException
KKAdminIfgetConfigFiles in interface KKAdminIfsessionId - The session Id of the logged in userKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminReport[] getReports(java.lang.String sessionId) throws KKAdminException
KKAdminIfgetReports in interface KKAdminIfsessionId - The session Id of the logged in userKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void reloadReports(java.lang.String sessionId)
throws KKAdminException
KKAdminIfreloadReports in interface KKAdminIfsessionId - The session Id of the logged in userKKAdminException - an unexpected exception in the KonaKart Admin enginepublic java.lang.String getFileContents(java.lang.String sessionId,
java.lang.String fileName)
throws KKAdminException
KKAdminIfgetFileContents in interface KKAdminIfsessionId - The session Id of the logged in userfileName - the filename in the server's contextKKAdminException - an unexpected exception in the KonaKart Admin engine if the file's not present or
can't be read, or it's not a text filepublic byte[] getFileContentsAsByteArray(java.lang.String sessionId,
java.lang.String fileName)
throws KKAdminException
KKAdminIfgetFileContentsAsByteArray in interface KKAdminIfsessionId - The session Id of the logged in userfileName - the filename in the server's contextKKAdminException - an unexpected exception in the KonaKart Admin engine if the file's not present or
can't be readpublic java.lang.String tailFile(java.lang.String sessionId,
java.lang.String fileName,
int offset)
throws KKAdminException
KKAdminIftailFile in interface KKAdminIfsessionId - The session Id of the logged in userfileName - the filename in the server's contextoffset - the offset from the start of the file in bytesKKAdminException - an unexpected exception in the KonaKart Admin engine if the file's not present or
can't be read, or it's not a text filepublic void saveFileContents(java.lang.String sessionId,
java.lang.String fileName,
java.lang.String fileContents)
throws KKAdminException
KKAdminIfsaveFileContents in interface KKAdminIfsessionId - The session Id of the logged in userfileName - the filename in the server's contextfileContents - the file contents to writeKKAdminException - an unexpected exception in the KonaKart Admin engine on any Security or IO
problems that prevent us from saving the data to the file.public boolean deleteFile(java.lang.String sessionId,
java.lang.String fileName)
throws KKAdminException
KKAdminIfdeleteFile in interface KKAdminIfsessionId - The session Id of the logged in userfileName - the filename in the server's contextKKAdminException - an unexpected exception in the KonaKart Admin engine if the file's not present or
can't be deletedpublic boolean copyFile(java.lang.String sessionId,
java.lang.String srcFileName,
java.lang.String dstFileName)
throws KKAdminException
KKAdminIfcopyFile in interface KKAdminIfsessionId - The session Id of the logged in usersrcFileName - the filename in the server's context to copy fromdstFileName - the filename in the server's context to copy toKKAdminException - an unexpected exception in the KonaKart Admin engine if the source file's not
present or can't be copiedpublic boolean copyFiles(java.lang.String sessionId,
java.lang.String[] srcFileNames,
java.lang.String[] dstFileNames)
throws KKAdminException
KKAdminIfcopyFiles in interface KKAdminIfsessionId - The session Id of the logged in usersrcFileNames - an array of filenames in the server's context to copy fromdstFileNames - an array of filenames in the server's context to copy toKKAdminException - an unexpected exception in the KonaKart Admin engine if any of the source file
are not present or can't be copiedpublic boolean renameFile(java.lang.String sessionId,
java.lang.String srcFileName,
java.lang.String dstFileName)
throws KKAdminException
KKAdminIfrenameFile in interface KKAdminIfsessionId - The session Id of the logged in usersrcFileName - the filename in the server's context to rename fromdstFileName - the filename in the server's context to rename toKKAdminException - an unexpected exception in the KonaKart Admin engine if the source file's not
present or can't be renamedpublic boolean renameFiles(java.lang.String sessionId,
java.lang.String[] srcFileNames,
java.lang.String[] dstFileNames)
throws KKAdminException
KKAdminIfrenameFiles in interface KKAdminIfsessionId - The session Id of the logged in usersrcFileNames - an array of filenames in the server's context to rename fromdstFileNames - an array of filenames in the server's context to rename toKKAdminException - an unexpected exception in the KonaKart Admin engine if any of the source file
are not present or can't be renamedpublic void addCategoriesToPromotion(java.lang.String sessionId,
AdminCategory[] categories,
int promotionId,
int rule)
throws KKAdminException
KKAdminIfaddCategoriesToPromotion in interface KKAdminIfsessionId - The session id of the logged in usercategories - An array of Admin category objectspromotionId - The numeric id of the promotionrule - An integer defining the rule for adding the categoriesKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void addCouponsToPromotion(java.lang.String sessionId,
AdminCoupon[] coupons,
int promotionId)
throws KKAdminException
KKAdminIfaddCouponsToPromotion in interface KKAdminIfsessionId - The session id of the logged in usercoupons - An array of AdminCoupon objectspromotionId - The numeric id of the promotionKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void addPromotionsToCoupon(java.lang.String sessionId,
AdminPromotion[] promotions,
int couponId)
throws KKAdminException
KKAdminIfaddPromotionsToCoupon in interface KKAdminIfsessionId - The session id of the logged in userpromotions - An array of AdminPromotion objectscouponId - The numeric id of the couponKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void addCustomersToPromotion(java.lang.String sessionId,
AdminCustomer[] customers,
int promotionId,
int rule,
int maxUse)
throws KKAdminException
KKAdminIfaddCustomersToPromotion in interface KKAdminIfsessionId - The session id of the logged in usercustomers - An array of AdminCustomer objectspromotionId - The numeric id of the promotionrule - An integer defining the rule for adding the customersmaxUse - -1 for unlimited useKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void addCustomerGroupsToPromotion(java.lang.String sessionId,
int[] groupIds,
int promotionId,
int rule)
throws KKAdminException
KKAdminIfaddCustomerGroupsToPromotion in interface KKAdminIfsessionId - The session id of the logged in usergroupIds - An array of integers containing the group idspromotionId - The numeric id of the promotionrule - An integer defining the rule for adding the customersKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void addCustomersToPromotionPerOrdersMade(java.lang.String sessionId,
java.util.Calendar lastOrderDate,
boolean havePlacedOrder,
int promotionId,
int rule,
int maxUse)
throws KKAdminException
KKAdminIfaddCustomersToPromotionPerOrdersMade in interface KKAdminIfsessionId - The session id of the logged in userlastOrderDate - The last time a customer placed an orderhavePlacedOrder - If true we add customers that have placed an order. Otherwise, those that haven't.promotionId - The numeric id of the promotionrule - An integer defining the rule for adding the customersmaxUse - -1 for unlimited useKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void addManufacturersToPromotion(java.lang.String sessionId,
AdminManufacturer[] manufacturers,
int promotionId,
int rule)
throws KKAdminException
KKAdminIfaddManufacturersToPromotion in interface KKAdminIfsessionId - The session id of the logged in usermanufacturers - An array of AdminManufacturer objectspromotionId - The numeric id of the promotionrule - An integer defining the rule for adding the manufacturersKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void addExpressionsToPromotion(java.lang.String sessionId,
AdminExpression[] expressions,
int promotionId)
throws KKAdminException
KKAdminIfaddExpressionsToPromotion in interface KKAdminIfsessionId - The session id of the logged in userexpressions - An array of AdminExpression objectspromotionId - The numeric id of the promotionKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void addProductsToPromotion(java.lang.String sessionId,
AdminProduct[] products,
int promotionId,
int rule)
throws KKAdminException
KKAdminIfaddProductsToPromotion in interface KKAdminIfsessionId - The session id of the logged in userproducts - An array of AdminProduct objectspromotionId - The numeric id of the promotionrule - An integer defining the rule for adding the productsKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void addGiftCertificatesToPromotion(java.lang.String sessionId,
AdminProduct[] giftCertificates,
int promotionId)
throws KKAdminException
KKAdminIfaddGiftCertificatesToPromotion in interface KKAdminIfsessionId - The session id of the logged in usergiftCertificates - An array of AdminProduct gift certificate objectspromotionId - The numeric id of the promotionKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void deletePromotion(java.lang.String sessionId,
int promotionId)
throws KKAdminException
KKAdminIfdeletePromotion in interface KKAdminIfsessionId - The session id of the logged in userpromotionId - The numeric id of the promotionKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void deletePromotionWithOptions(java.lang.String sessionId,
int promotionId,
AdminDeletePromotionOptions options)
throws KKAdminException
KKAdminIfdeletePromotionWithOptions in interface KKAdminIfsessionId - The session id of the logged in userpromotionId - The numeric id of the promotionoptions - Used to configure the functionality when deleting a promotion. Allows you to
decide whether to delete associated coupons and whether to perform a check to
determine whether they are being used by any other promotion before deletion.KKAdminException - an unexpected exception in the KonaKart Admin enginepublic void deleteCoupon(java.lang.String sessionId,
int couponId)
throws KKAdminException
KKAdminIfdeleteCoupon in interface KKAdminIfsessionId - The session id of the logged in usercouponId - The numeric id of the couponKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void editCoupon(java.lang.String sessionId,
AdminCoupon coupon)
throws KKAdminException
KKAdminIfeditCoupon in interface KKAdminIfsessionId - The session id of the logged in usercoupon - An Admin coupon objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void editPromotion(java.lang.String sessionId,
AdminPromotion promotion)
throws KKAdminException
KKAdminIf
In order to not modify the timesUsed attribute of the promotion, it must be set
to -1.
editPromotion in interface KKAdminIfsessionId - The session id of the logged in userpromotion - AdminPromotion objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminCoupon[] getCouponsPerPromotion(java.lang.String sessionId, int promotionId) throws KKAdminException
KKAdminIfgetCouponsPerPromotion in interface KKAdminIfsessionId - The session id of the logged in userpromotionId - The numeric id of the promotionKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminCouponSearchResult getCoupons(java.lang.String sessionId, AdminCouponSearch search, int offset, int size) throws KKAdminException
KKAdminIfgetCoupons in interface KKAdminIfsessionId - The session id of the logged in usersearch - the search object that defines the search parameters and sort orderoffset - the offset in the databasesize - the number of records from the specified offsetKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminCategory[] getCategoriesPerPromotion(java.lang.String sessionId, int promotionId, int languageId) throws KKAdminException
KKAdminIfgetCategoriesPerPromotion in interface KKAdminIfsessionId - The session id of the logged in userpromotionId - The numeric id of the promotionlanguageId - the language Id - or it could be
com.konakartadmin.bl.AdminLanguageMgr.DEFAULT_LANG to use the default languageKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminCustomerGroup[] getCustomerGroupsPerPromotion(java.lang.String sessionId, int promotionId, int languageId) throws KKAdminException
KKAdminIfgetCustomerGroupsPerPromotion in interface KKAdminIfsessionId - The session id of the logged in userpromotionId - The numeric id of the promotionlanguageId - the language Id - or it could be
com.konakartadmin.bl.AdminLanguageMgr.DEFAULT_LANG to use the default languageKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminManufacturer[] getManufacturersPerPromotion(java.lang.String sessionId, int promotionId) throws KKAdminException
KKAdminIfgetManufacturersPerPromotion in interface KKAdminIfsessionId - The session id of the logged in userpromotionId - The numeric id of the promotionKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminProducts getProductsPerPromotion(java.lang.String sessionId, AdminProductSearch search, int offset, int size) throws KKAdminException
KKAdminIfgetProductsPerPromotion in interface KKAdminIfsessionId - The session id of the logged in usersearch - the search object that defines the search parameters and sort orderoffset - the offset in the databasesize - the number of records from the specified offsetKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminProducts getGiftCertificatesPerPromotion(java.lang.String sessionId, AdminProductSearch search, int offset, int size) throws KKAdminException
KKAdminIfgetGiftCertificatesPerPromotion in interface KKAdminIfsessionId - The session id of the logged in usersearch - the search object that defines the search parameters and sort orderoffset - the offset in the databasesize - the number of records from the specified offsetKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminPromotion getPromotion(java.lang.String sessionId, int id, boolean includeCoupons, boolean includeStats) throws KKAdminException
KKAdminIfgetPromotion in interface KKAdminIfsessionId - The session id of the logged in userid - The numeric id of the AdminPromotion objectincludeCoupons - If true we add a coupon array to the promotion if any coupons existincludeStats - If true we calculate how many manufacturers, products, categories, customers,
expressions and coupons are included or excluded from the promotionKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminPromotionSearchResult getPromotions(java.lang.String sessionId, AdminPromotionSearch search, int offset, int size) throws KKAdminException
KKAdminIfgetPromotions in interface KKAdminIfsessionId - The session id of the logged in usersearch - the search object that defines the search parameters and sort orderoffset - the offset in the databasesize - the number of records from the specified offsetKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int getPromotionsCount(java.lang.String sessionId,
AdminPromotionSearch search)
throws KKAdminException
KKAdminIfgetPromotionsCount in interface KKAdminIfsessionId - The session id of the logged in usersearch - the search object that defines the search parameters and sort orderKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminPromotion[] getPromotionsPerCoupon(java.lang.String sessionId, int couponId) throws KKAdminException
KKAdminIfgetPromotionsPerCoupon in interface KKAdminIfsessionId - The session id of the logged in usercouponId - The numeric id of the couponKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertCouponForPromotion(java.lang.String sessionId,
AdminCoupon coupon,
int promotionId)
throws KKAdminException
KKAdminIfinsertCouponForPromotion in interface KKAdminIfsessionId - The session id of the logged in usercoupon - An AdminCoupon objectpromotionId - The numeric id of the promotionKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertCoupon(java.lang.String sessionId,
AdminCoupon coupon)
throws KKAdminException
KKAdminIfinsertCoupon in interface KKAdminIfsessionId - The session id of the logged in usercoupon - An AdminCoupon objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertPromotion(java.lang.String sessionId,
AdminPromotion prom)
throws KKAdminException
KKAdminIfinsertPromotion in interface KKAdminIfsessionId - The session id of the logged in userprom - The AdminPromotion objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void removeCategoriesFromPromotion(java.lang.String sessionId,
AdminCategory[] categories,
int promotionId)
throws KKAdminException
KKAdminIfremoveCategoriesFromPromotion in interface KKAdminIfsessionId - The session id of the logged in usercategories - An array of AdminCategory objectspromotionId - The numeric id of the promotionKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void removeCouponsFromPromotion(java.lang.String sessionId,
AdminCoupon[] coupons,
int promotionId)
throws KKAdminException
KKAdminIfremoveCouponsFromPromotion in interface KKAdminIfsessionId - The session id of the logged in usercoupons - An array of AdminCoupon objectspromotionId - The numeric id of the promotionKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void removePromotionsFromCoupon(java.lang.String sessionId,
AdminPromotion[] promotions,
int couponId)
throws KKAdminException
KKAdminIfremovePromotionsFromCoupon in interface KKAdminIfsessionId - The session id of the logged in userpromotions - An array of AdminPromotion objectscouponId - The numeric id of the couponKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void removeCustomersFromPromotion(java.lang.String sessionId,
AdminCustomer[] customers,
int promotionId)
throws KKAdminException
KKAdminIfremoveCustomersFromPromotion in interface KKAdminIfsessionId - The session id of the logged in usercustomers - An array of AdminCustomer objectspromotionId - The numeric id of the promotionKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void removeCustomerGroupsFromPromotion(java.lang.String sessionId,
int[] groupIds,
int promotionId)
throws KKAdminException
KKAdminIfremoveCustomerGroupsFromPromotion in interface KKAdminIfsessionId - The session id of the logged in usergroupIds - An array of customer group idspromotionId - The numeric id of the promotionKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void removeManufacturersFromPromotion(java.lang.String sessionId,
AdminManufacturer[] manufacturers,
int promotionId)
throws KKAdminException
KKAdminIfremoveManufacturersFromPromotion in interface KKAdminIfsessionId - The session id of the logged in usermanufacturers - An array of AdminManufacturer objectspromotionId - The numeric id of the promotionKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void removeExpressionsFromPromotion(java.lang.String sessionId,
AdminExpression[] expressions,
int promotionId)
throws KKAdminException
KKAdminIfremoveExpressionsFromPromotion in interface KKAdminIfsessionId - The session id of the logged in userexpressions - An array of AdminExpression objectspromotionId - The numeric id of the promotionKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void removeProductsFromPromotion(java.lang.String sessionId,
AdminProduct[] products,
int promotionId)
throws KKAdminException
KKAdminIfremoveProductsFromPromotion in interface KKAdminIfsessionId - The session id of the logged in userproducts - An array of AdminProduct objectspromotionId - The numeric id of the promotionKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void removeGiftCertificatesFromPromotion(java.lang.String sessionId,
AdminProduct[] giftCertificates,
int promotionId)
throws KKAdminException
KKAdminIfremoveGiftCertificatesFromPromotion in interface KKAdminIfsessionId - The session id of the logged in usergiftCertificates - An array of AdminProduct objectspromotionId - The numeric id of the promotionKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminProducts getRelatedProducts(java.lang.String sessionId, AdminDataDescriptor dataDesc, int productId, int relationType, int languageId) throws KKAdminException
KKAdminIfValid values for relationType are:
getRelatedProducts in interface KKAdminIfsessionId - The session id of the logged in userdataDesc - Used to control the data offset, limit the number of items returned and set the
sort orderproductId - The numeric id of the productrelationType - the relationTypelanguageId - the language Id - or it could be
com.konakartadmin.bl.AdminLanguageMgr.DEFAULT_LANG to use the default languageKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminProducts getRelatedProductsWithOptions(java.lang.String sessionId, AdminDataDescriptor dataDesc, int productId, int relationType, int languageId, AdminProductMgrOptions mgrOptions) throws KKAdminException
KKAdminIfValid values for relationType are:
getRelatedProductsWithOptions in interface KKAdminIfsessionId - The session id of the logged in userdataDesc - Used to control the data offset, limit the number of items returned and set the
sort orderproductId - The numeric id of the productrelationType - the relationTypelanguageId - the language Id - or it could be
com.konakartadmin.bl.AdminLanguageMgr.DEFAULT_LANG to use the default languagemgrOptions - Allows you to define whether the quantity and prices can have different values
depending on the catalogId. May be set to null.KKAdminException - an unexpected exception in the KonaKart Admin enginepublic void removeRelatedProduct(java.lang.String sessionId,
int productIdFrom,
int productIdTo,
int relationType)
throws KKAdminException
KKAdminIfValid values for relationType are:
removeRelatedProduct in interface KKAdminIfsessionId - The session id of the logged in userproductIdFrom - the productId the relation generates fromproductIdTo - the productId the relation points torelationType - the relationTypeKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void removeRelatedProducts(java.lang.String sessionId,
int productId,
int relationType)
throws KKAdminException
KKAdminIfValid values for relationType are:
removeRelatedProducts in interface KKAdminIfsessionId - The session id of the logged in userproductId - The numeric id of the productrelationType - the relationTypeKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void addRelatedProducts(java.lang.String sessionId,
AdminProduct[] products,
int productId,
int relationType)
throws KKAdminException
KKAdminIfbundledProdQuantity of the products in the AdminProduct array, defines
the number of times it is present in the bundle.addRelatedProducts in interface KKAdminIfsessionId - The session id of the logged in userproducts - An array of AdminProduct objectsproductId - The numeric id of the productrelationType - The type of relationship that the array of AdminProducts has with the product
identified by productIdKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void addRelatedProductsWithOptions(java.lang.String sessionId,
AdminProduct[] products,
int productId,
int relationType,
AdminProductMgrOptions mgrOptions)
throws KKAdminException
KKAdminIfbundledProdQuantity of the products in the AdminProduct array, defines
the number of times it is present in the bundle.
The mgrOptions object may be used to set the relationship custom attributes. It contains two
attributes - relationCustom1 and relationCustom2 which if set, will
be used to populate the custom attributes of the product to product relationship. It may be
set to null.
addRelatedProductsWithOptions in interface KKAdminIfsessionId - The session id of the logged in userproducts - An array of AdminProduct objectsproductId - The numeric id of the productrelationType - The type of relationship that the array of AdminProducts has with the product
identified by productIdmgrOptions - The options object allows you to set relationCustom1 and relationCustom2
attributes that are set on the product to product relationship. It may be set to
null.KKAdminException - an unexpected exception in the KonaKart Admin enginepublic java.lang.String readFromUrl(java.lang.String sessionId,
java.lang.String url)
throws KKAdminException
KKAdminIfreadFromUrl in interface KKAdminIfsessionId - The session id of the logged in userurl - The urlKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void editOrderReturn(java.lang.String sessionId,
AdminOrderReturn orderRet)
throws KKAdminException
KKAdminIfeditOrderReturn in interface KKAdminIfsessionId - The session id of the logged in userorderRet - AdminOrderReturn objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertOrderReturn(java.lang.String sessionId,
AdminOrderReturn orderRet)
throws KKAdminException
KKAdminIfinsertOrderReturn in interface KKAdminIfsessionId - The session id of the logged in userorderRet - An AdminOrderReturn objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void deleteOrderReturn(java.lang.String sessionId,
int orderRetId)
throws KKAdminException
KKAdminIfdeleteOrderReturn in interface KKAdminIfsessionId - The session id of the logged in userorderRetId - The id of the AdminOrderReturn objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminOrderReturnSearchResult getOrderReturns(java.lang.String sessionId, AdminOrderReturnSearch retSearch, int offset, int size) throws KKAdminException
KKAdminIfgetOrderReturns in interface KKAdminIfsessionId - The session id of the logged in userretSearch - An object that defines the search parametersoffset - the offset in the databasesize - the number of records from the specified offsetKKAdminException - an unexpected exception in the KonaKart Admin enginepublic java.lang.String getSku(java.lang.String sessionId,
AdminOrderProduct orderProd)
throws KKAdminException
KKAdminIfgetSku in interface KKAdminIfsessionId - The session id of the logged in userorderProd - An AdminOrderProduct objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic java.lang.String[] getSkus(java.lang.String sessionId,
AdminOrderProduct[] orderProds)
throws KKAdminException
KKAdminIfgetSkus in interface KKAdminIfsessionId - The session id of the logged in userorderProds - An array of AdminOrderProduct objectsKKAdminException - an unexpected exception in the KonaKart Admin enginepublic boolean doesCustomerExistForEmail(java.lang.String sessionId,
java.lang.String emailAddr)
throws KKAdminException
KKAdminIfdoesCustomerExistForEmail in interface KKAdminIfsessionId - The session id of the logged in useremailAddr - The email address of the customerKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminAuditSearchResult getAuditData(java.lang.String sessionId, AdminAuditSearch retSearch, int offset, int size) throws KKAdminException
KKAdminIfgetAuditData in interface KKAdminIfsessionId - The session id of the logged in userretSearch - An object that defines the search parametersoffset - the offset in the databasesize - the number of records from the specified offsetKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int importAudit(java.lang.String sessionId,
AdminAudit audit)
throws KKAdminException
KKAdminIfimportAudit in interface KKAdminIfsessionId - The session id of the logged in useraudit - the auditKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void deleteAuditData(java.lang.String sessionId,
AdminAuditSearch delSearch)
throws KKAdminException
KKAdminIfdeleteAuditData in interface KKAdminIfsessionId - The session id of the logged in userdelSearch - AdminAuditSearch object to filter the datato be deletedKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminRole[] getRolesPerSessionId(java.lang.String sessionId) throws KKAdminException
KKAdminIfgetRolesPerSessionId in interface KKAdminIfsessionId - The session id of the logged in userKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminRole[] getRolesPerUser(java.lang.String sessionId, int userId) throws KKAdminException
KKAdminIfgetRolesPerUser in interface KKAdminIfsessionId - The session id of the logged in useruserId - The numeric id of the userKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void addRolesToUser(java.lang.String sessionId,
AdminRole[] roles,
int userId)
throws KKAdminException
KKAdminIfaddRolesToUser in interface KKAdminIfsessionId - The session id of the logged in userroles - An array of AdminRole objectsuserId - The numeric id of the userKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void removeRolesFromUser(java.lang.String sessionId,
AdminRole[] roles,
int userId)
throws KKAdminException
KKAdminIfremoveRolesFromUser in interface KKAdminIfsessionId - The session id of the logged in userroles - An array of AdminRole objectsuserId - The numeric user idKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void removePanelsFromRole(java.lang.String sessionId,
AdminPanel[] panels,
int roleId)
throws KKAdminException
KKAdminIfremovePanelsFromRole in interface KKAdminIfsessionId - The session id of the logged in userpanels - An array of AdminPanel objectsroleId - The id of the RoleKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void removeApiCallsFromRole(java.lang.String sessionId,
AdminApiCall[] apiCalls,
int roleId)
throws KKAdminException
KKAdminIfremoveApiCallsFromRole in interface KKAdminIfsessionId - The session id of the logged in userapiCalls - An array of AdminApiCall objectsroleId - The id of the RoleKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void addPanelsToRole(java.lang.String sessionId,
AdminPanel[] panels,
int roleId)
throws KKAdminException
KKAdminIfaddPanelsToRole in interface KKAdminIfsessionId - The session id of the logged in userpanels - An array of AdminPanel objectsroleId - The numeric id of the RoleKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void addApiCallsToRole(java.lang.String sessionId,
AdminApiCall[] apiCalls,
int roleId)
throws KKAdminException
KKAdminIfaddApiCallsToRole in interface KKAdminIfsessionId - The session id of the logged in userapiCalls - An array of AdminApiCall objectsroleId - The id of the RoleKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminPanel[] getPanelsPerRole(java.lang.String sessionId, int roleId) throws KKAdminException
KKAdminIfgetPanelsPerRole in interface KKAdminIfsessionId - The session id of the logged in userroleId - The id of the RoleKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminApiCall[] getApiCallsPerRole(java.lang.String sessionId, int roleId) throws KKAdminException
KKAdminIfgetApiCallsPerRole in interface KKAdminIfsessionId - The session id of the logged in userroleId - The id of the RoleKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminPanel[] getAllPanels(java.lang.String sessionId) throws KKAdminException
KKAdminIfgetAllPanels in interface KKAdminIfsessionId - The session id of the logged in userKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminApiCall[] getAllApiCalls(java.lang.String sessionId) throws KKAdminException
KKAdminIfgetAllApiCalls in interface KKAdminIfsessionId - The session id of the logged in userKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminRole[] getAllRoles(java.lang.String sessionId) throws KKAdminException
KKAdminIfgetAllRoles in interface KKAdminIfsessionId - The session id of the logged in userKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void editRole(java.lang.String sessionId,
AdminRole role)
throws KKAdminException
KKAdminIfeditRole in interface KKAdminIfsessionId - The session id of the logged in userrole - AdminRole objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertRole(java.lang.String sessionId,
AdminRole role)
throws KKAdminException
KKAdminIfinsertRole in interface KKAdminIfsessionId - The session id of the logged in userrole - The AdminRole objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void deleteRole(java.lang.String sessionId,
int roleId)
throws KKAdminException
KKAdminIfdeleteRole in interface KKAdminIfsessionId - The session id of the logged in userroleId - The id of the RoleKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void deletePanel(java.lang.String sessionId,
int panelId)
throws KKAdminException
KKAdminIfdeletePanel in interface KKAdminIfsessionId - The session id of the logged in userpanelId - The numeric id of the panelKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void deleteApiCall(java.lang.String sessionId,
int apiCallId)
throws KKAdminException
KKAdminIfdeleteApiCall in interface KKAdminIfsessionId - The session id of the logged in userapiCallId - The numeric id of the ApiCallKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void editPanel(java.lang.String sessionId,
AdminPanel panel)
throws KKAdminException
KKAdminIfeditPanel in interface KKAdminIfsessionId - The session id of the logged in userpanel - AdminPanel objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void editApiCall(java.lang.String sessionId,
AdminApiCall apiCall)
throws KKAdminException
KKAdminIfeditApiCall in interface KKAdminIfsessionId - The session id of the logged in userapiCall - An AdminApiCall objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminPanel getPanel(java.lang.String sessionId, int panelId) throws KKAdminException
KKAdminIfgetPanel in interface KKAdminIfsessionId - The session id of the logged in userpanelId - The numeric id of the AdminPanel objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminApiCall getApiCall(java.lang.String sessionId, int apiCallId) throws KKAdminException
KKAdminIfgetApiCall in interface KKAdminIfsessionId - The session id of the logged in userapiCallId - The numeric id of the AdminApiCall objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminRole getRole(java.lang.String sessionId, int roleId) throws KKAdminException
KKAdminIfgetRole in interface KKAdminIfsessionId - The session id of the logged in userroleId - The id of the RoleKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertPanel(java.lang.String sessionId,
AdminPanel panel)
throws KKAdminException
KKAdminIfinsertPanel in interface KKAdminIfsessionId - The session id of the logged in userpanel - An AdminPanel objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertApiCall(java.lang.String sessionId,
AdminApiCall apiCall)
throws KKAdminException
KKAdminIfinsertApiCall in interface KKAdminIfsessionId - The session id of the logged in userapiCall - An AdminApiCall objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void insertDigitalDownload(java.lang.String sessionId,
int customerId,
int productId)
throws KKAdminException
KKAdminIfproductId 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.
insertDigitalDownload in interface KKAdminIfsessionId - The session id of the logged in usercustomerId - The numeric id of the customerproductId - The numeric id of the productKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void sendTemplateEmailToCustomers(java.lang.String sessionId,
AdminCustomerSearch custSearch,
java.lang.String templateName,
java.lang.Object obj1,
java.lang.Object obj2,
java.lang.Object obj3,
java.lang.Object obj4,
java.lang.Object obj5,
int numEmailThreads)
throws KKAdminException
KKAdminIfThe email is generated by the template called templateName and the objects obj1-obj5 are passed to the template. The current AdminCustomer object is also passed to the Velocity template with the name "cust". The subject of the eMail is picked up from the first line of the template. obj1-obj5 can be any object that you wish to extract data from to place into the eMail. For example you could look up a number of special offers from the database and set obj1 to an array of products containing these special offers.
The individual emails are sent using a thread pool with a maximum number of threads that is defined by numEmailThreads.
Note that this method is not available via the SOAP Web Service interface because of problems with the serialization of parameters of type object. Please use sendTemplateEmailToCustomers1() instead.
A log called SendTemplateEmail.log is created, containing a list of the eMail addresses used.
sendTemplateEmailToCustomers in interface KKAdminIfsessionId - The session id of the logged in usercustSearch - The AdminCustomerSearch object which determines the customers that are selected.templateName - The name of the template. The "country code" and ".vm" will be appended
automatically. i.e. If the template name is newsletter and the country code is en,
then we will look for a file called newsletter_en.vm.obj1 - This object will be passed to the velocity template with the name "obj1".obj2 - This object will be passed to the velocity template with the name "obj2".obj3 - This object will be passed to the velocity template with the name "obj3".obj4 - This object will be passed to the velocity template with the name "obj4".obj5 - This object will be passed to the velocity template with the name "obj5".numEmailThreads - The maximum number of concurrent threads used by the thread pool to send the
eMails. If set to 0 or to a negative value, it is ignored.KKAdminException - an unexpected exception in the KonaKart Admin enginepublic void sendTemplateEmailToCustomersWithOptions(java.lang.String sessionId,
AdminCustomerSearch custSearch,
java.lang.String templateName,
java.lang.Object obj1,
java.lang.Object obj2,
java.lang.Object obj3,
java.lang.Object obj4,
java.lang.Object obj5,
int numEmailThreads,
AdminEmailOptions options)
throws KKAdminException
KKAdminIfA log called SendTemplateEmail.log is created, containing a list of the eMail addresses used.
sendTemplateEmailToCustomersWithOptions in interface KKAdminIfsessionId - The session id of the logged in usercustSearch - The AdminCustomerSearch object which determines the customers that are selected.templateName - The name of the template. The "country code" and ".vm" will be appended
automatically. i.e. If the template name is newsletter and the country code is en,
then we will look for a file called newsletter_en.vm.obj1 - This object will be passed to the velocity template with the name "obj1".obj2 - This object will be passed to the velocity template with the name "obj2".obj3 - This object will be passed to the velocity template with the name "obj3".obj4 - This object will be passed to the velocity template with the name "obj4".obj5 - This object will be passed to the velocity template with the name "obj5".numEmailThreads - The maximum number of concurrent threads used by the thread pool to send the
eMails. If set to 0 or to a negative value, it is ignored.options - An object used to configure options used when sending eMails from the AdminAppKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void sendTemplateEmailToCustomers1(java.lang.String sessionId,
AdminCustomerSearch custSearch,
java.lang.String templateName,
java.lang.String message,
AdminProduct[] products,
AdminOrder[] orders,
AdminManufacturer[] manufacturers,
AdminCategory[] categories,
int numEmailThreads)
throws KKAdminException
KKAdminIfsendTemplateEmailToCustomers() and is just a more specific implementation where
arrays of defined objects are passed to the Velocity template rather than java.lang.Object
which cannot be serialized for use in a Web Service interface.
The email is generated by the template called templateName and the message, arrays of products, orders, manufacturers and categories are passed to the template. The current AdminCustomer object is also passed to the Velocity template with the name "cust". The subject of the eMail is picked up from the first line of the template. The message and arrays passed to the template can be set to null if not required.
The individual emails are sent using a thread pool with a maximum number of threads that is defined by numEmailThreads.
A log called SendTemplateEmail.log is created, containing a list of the eMail addresses used.
sendTemplateEmailToCustomers1 in interface KKAdminIfsessionId - The session id of the logged in usercustSearch - The AdminCustomerSearch object which determines the customers that are selected.templateName - The name of the template. The "country code" and ".vm" will be appended
automatically. i.e. If the template name is newsletter and the country code is en,
then we will look for a file called newsletter_en.vm.message - This message will be passed to the velocity template with the name "obj1".products - This products will be passed to the velocity template with the name "obj2".orders - This orders will be passed to the velocity template with the name "obj3".manufacturers - This manufacturers will be passed to the velocity template with the name "obj4".categories - This categories will be passed to the velocity template with the name "obj5".numEmailThreads - The maximum number of concurrent threads used by the thread pool to send the
eMails. If set to 0 or to a negative value, it is ignored.KKAdminException - an unexpected exception in the KonaKart Admin enginepublic void sendTemplateEmailToCustomers1WithOptions(java.lang.String sessionId,
AdminCustomerSearch custSearch,
java.lang.String templateName,
java.lang.String message,
AdminProduct[] products,
AdminOrder[] orders,
AdminManufacturer[] manufacturers,
AdminCategory[] categories,
int numEmailThreads,
AdminEmailOptions options)
throws KKAdminException
KKAdminIfA log called SendTemplateEmail.log is created, containing a list of the eMail addresses used.
sendTemplateEmailToCustomers1WithOptions in interface KKAdminIfsessionId - The session id of the logged in usercustSearch - The AdminCustomerSearch object which determines the customers that are selected.templateName - The name of the template. The "country code" and ".vm" will be appended
automatically. i.e. If the template name is newsletter and the country code is en,
then we will look for a file called newsletter_en.vm.message - This message will be passed to the velocity template with the name "obj1".products - This products will be passed to the velocity template with the name "obj2".orders - This orders will be passed to the velocity template with the name "obj3".manufacturers - This manufacturers will be passed to the velocity template with the name "obj4".categories - This categories will be passed to the velocity template with the name "obj5".numEmailThreads - The maximum number of concurrent threads used by the thread pool to send the
eMails. If set to 0 or to a negative value, it is ignored.options - An object used to configure options used when sending eMails from the AdminAppKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void insertProductNotification(java.lang.String sessionId,
AdminProductNotification apn)
throws KKAdminException
KKAdminIfinsertProductNotification in interface KKAdminIfsessionId - The session id of the logged in userapn - An AdminProductNotification objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void deleteProductNotification(java.lang.String sessionId,
AdminProductNotification apn)
throws KKAdminException
KKAdminIfdeleteProductNotification in interface KKAdminIfsessionId - The session id of the logged in userapn - An AdminProductNotification objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminCustomer getCustomerForEmail(java.lang.String sessionId, java.lang.String emailAddress) throws KKAdminException
KKAdminIfgetCustomerForEmail in interface KKAdminIfsessionId - The session id of the logged in useremailAddress - The eMail address of the customerKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminCustomer getCustomerForEmailWithOptions(java.lang.String sessionId, java.lang.String emailAddress, AdminGetCustomerOptions options) throws KKAdminException
KKAdminIfgetCustomerForEmailWithOptions in interface KKAdminIfsessionId - The session id of the logged in useremailAddress - The eMail address of the customeroptions - Options allowing you to configure the API call in order to populate customer
children when implementing a hierarchical customer structure.KKAdminException - an unexpected exception in the KonaKart Admin enginepublic void editOrder(java.lang.String sessionId,
AdminOrder order)
throws KKAdminException
KKAdminIf
This method only allows you to edit certain attributes of an order. In order to change the
order status you must use updateOrder().
The attributes that can be modified are:
Attributes containing null values will be ignored. In order to clear a String attribute, you must set it to an empty string.
editOrder in interface KKAdminIfsessionId - The session Id of the logged in userorder - The AdminOrder object to be editedKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void setCreditCardDetailsOnOrder(java.lang.String sessionId,
AdminCreditCard creditCard)
throws KKAdminException
KKAdminIf
This method only allows you to update the credit card details on an order. In order to change
the order status you must use updateOrderStatus().
The Credit Card details are only saved if the ability to save credit card details is enabled in the configuration of the store.
The orderId must be specified as the id on the AdminCreditCard object.
The following Credit Card attributes can be saved (on the CreditCard object):
setCreditCardDetailsOnOrder in interface KKAdminIfsessionId - The session Id of the logged in usercreditCard - An AdminCreditCard object containing all of the credit card detailsKKAdminException - an unexpected exception in the KonaKart Admin enginepublic java.lang.String custom(java.lang.String input1,
java.lang.String input2)
throws KKAdminException
KKAdminIfThere 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!
custom in interface KKAdminIfinput1 - The first input String - can be anything you chooseinput2 - The second input String - can be anything you chooseKKAdminException - an unexpected exception in the KonaKart Admin enginepublic java.lang.String customSecure(java.lang.String sessionId,
java.lang.String input1,
java.lang.String input2)
throws KKAdminException
KKAdminIfThere 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!
customSecure in interface KKAdminIfsessionId - The session id of the logged in userinput1 - The first input String - can be anything you chooseinput2 - The second input String - can be anything you chooseKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminProduct getBundleProductDetails(java.lang.String sessionId, int bundleId, AdminProduct[] bundledProducts, AdminDiscount discount) throws KKAdminException
KKAdminIfgetBundleProductDetails in interface KKAdminIfsessionId - The session id of the logged in userbundleId - If set to a positive value, we search for all of the products in the bundle,
starting from this id of the bundle product.bundledProducts - If bundleId is less than zero, we use the products in this array otherwise it is
ignored. Each product should have the bundledProdQuantity attribute set to the
number of times that it appears in the bundle. If a product in the bundle has a
certain configuration (i.e. Size = small, color = red) then the
encodedOptionValues attribute should contain the encoded option values. The format
of the encodeOptionValues is 1{2}3{4} where the first optionId / valueId pair have
ids of 1,2 and the 2nd optionId / valueId pair have ids of 3,4.discount - The discount to apply which can be an amount or a percentageKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void deleteTag(java.lang.String sessionId,
int id)
throws KKAdminException
KKAdminIfdeleteTag in interface KKAdminIfsessionId - session Id of logged in Admin userid - the id of the AdminTag to deleteKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void deleteTagGroup(java.lang.String sessionId,
int id)
throws KKAdminException
KKAdminIfdeleteTagGroup in interface KKAdminIfsessionId - session Id of logged in Admin userid - the id of the AdminTagGroup to deleteKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminTagGroupSearchResult getTagGroups(java.lang.String sessionId, AdminSearch search, int offset, int size) throws KKAdminException
KKAdminIfgetTagGroups in interface KKAdminIfsessionId - session Id of logged in Admin usersearch - the generic Admin search object that defines the tag group objects to search for.
If null we use the default AdminSearch objectoffset - starting offset in database - so that you can page through resultssize - size of the group that will be returned - the maximum number of records returnedKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminTagSearchResult getTags(java.lang.String sessionId, AdminSearch search, int offset, int size) throws KKAdminException
KKAdminIfgetTags in interface KKAdminIfsessionId - session Id of logged in Admin usersearch - the generic Admin search object that defines the tag objects to search for. If
null we use the default AdminSearch object.offset - starting offset in database - so that you can page through resultssize - size of the group that will be returned - the maximum number of records returnedKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminTagGroupToTag[] getTagGroupToTags(java.lang.String sessionId, AdminSearch search, int offset, int size) throws KKAdminException
KKAdminIfgetTagGroupToTags in interface KKAdminIfsessionId - session Id of logged in Admin usersearch - the generic Admin search object that defines the tag objects to search for. If
null we use the default AdminSearch object. If id is not -1 this is used to define
the tag Group Id. If id2 is not -1 this is used to define the tag Id.offset - starting offset in database - so that you can page through resultssize - size of the group that will be returned - the maximum number of records returnedKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertTag(java.lang.String sessionId,
AdminTag tag)
throws KKAdminException
KKAdminIfinsertTag in interface KKAdminIfsessionId - session Id of logged in Admin usertag - the new AdminTag object to insert - do not fill out the Id (set it to -1) as this
will be createdKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertTags(java.lang.String sessionId,
AdminTag[] tag)
throws KKAdminException
KKAdminIfinsertTags in interface KKAdminIfsessionId - session Id of logged in Admin usertag - the array of AdminTag objects to insert - do not fill out the Id on these (set
them to -1) as this will be created. It is assumed that all of these tags will
have the same ID, and there will be one for each language.KKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertTagGroup(java.lang.String sessionId,
AdminTagGroup tagGroup)
throws KKAdminException
KKAdminIfinsertTagGroup in interface KKAdminIfsessionId - session Id of logged in Admin usertagGroup - the new AdminTagGroup object to insert - do not fill out the Id (set it to -1) as
this will be createdKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertTagGroups(java.lang.String sessionId,
AdminTagGroup[] tagGroup)
throws KKAdminException
KKAdminIfinsertTagGroups in interface KKAdminIfsessionId - session Id of logged in Admin usertagGroup - the new AdminTagGroup object to insert - do not fill out the Id on these (set
these to -1) as this will be created. It is assumed that all of these tagGroups
will have the same ID, and there will be one for each language.KKAdminException - an unexpected exception in the KonaKart Admin enginepublic void insertTagGroupToTags(java.lang.String sessionId,
AdminTagGroupToTag tagGroupToTag)
throws KKAdminException
KKAdminIfinsertTagGroupToTags in interface KKAdminIfsessionId - session Id of logged in Admin usertagGroupToTag - the tagGroupToTagKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int updateTag(java.lang.String sessionId,
AdminTag tag)
throws KKAdminException
KKAdminIfupdateTag in interface KKAdminIfsessionId - session Id of logged in Admin usertag - the AdminTag object to updateKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int updateTagGroup(java.lang.String sessionId,
AdminTagGroup tagGroup)
throws KKAdminException
KKAdminIfupdateTagGroup in interface KKAdminIfsessionId - session Id of logged in Admin usertagGroup - the AdminTagGroup object to updateKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void addTagGroupsToCategory(java.lang.String sessionId,
AdminTagGroup[] tagGroups,
int categoryId)
throws KKAdminException
KKAdminIfaddTagGroupsToCategory in interface KKAdminIfsessionId - session Id of logged in Admin usertagGroups - Array of AdminTagGroup objectscategoryId - The id of the categoryKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void addCategoriesToTagGroups(java.lang.String sessionId,
int tagGroupId,
int[] categories)
throws KKAdminException
KKAdminIfaddCategoriesToTagGroups in interface KKAdminIfsessionId - session Id of logged in Admin usertagGroupId - the tag group Id to link to the categoriescategories - an array of category Ids to link to the Tag GroupKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void addTagsToProduct(java.lang.String sessionId,
AdminTag[] tags,
int productId)
throws KKAdminException
KKAdminIfaddTagsToProduct in interface KKAdminIfsessionId - session Id of logged in Admin usertags - Array of AdminTag objectsproductId - The id of the productKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminTagGroup[] getTagGroupsPerCategory(java.lang.String sessionId, int categoryId, int languageId) throws KKAdminException
KKAdminIfgetTagGroupsPerCategory in interface KKAdminIfsessionId - session Id of logged in Admin usercategoryId - The id of the categorylanguageId - the language Id - or it could be
com.konakartadmin.bl.AdminLanguageMgr.DEFAULT_LANG to use the default languageKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int[] getCategoriesPerTagGroup(java.lang.String sessionId,
int tagGroupId)
throws KKAdminException
KKAdminIfgetCategoriesPerTagGroup in interface KKAdminIfsessionId - session Id of logged in Admin usertagGroupId - The id of the tag GroupKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminCategoryToTagGroup[] getCategoriesToTagGroups(java.lang.String sessionId) throws KKAdminException
KKAdminIfgetCategoriesToTagGroups in interface KKAdminIfsessionId - session Id of logged in Admin userKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminTag[] getTagsPerProduct(java.lang.String sessionId, int productId, int languageId) throws KKAdminException
KKAdminIfgetTagsPerProduct in interface KKAdminIfsessionId - session Id of logged in Admin userproductId - The id of the productlanguageId - the language Id - or it could be
com.konakartadmin.bl.AdminLanguageMgr.DEFAULT_LANG to use the default languageKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void removeTagGroupsFromCategory(java.lang.String sessionId,
AdminTagGroup[] tagGroups,
int categoryId)
throws KKAdminException
KKAdminIfremoveTagGroupsFromCategory in interface KKAdminIfsessionId - session Id of logged in Admin usertagGroups - Array of AdminTagGroup objectscategoryId - The id of the categoryKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void removeTagsFromProduct(java.lang.String sessionId,
AdminTag[] tags,
int productId)
throws KKAdminException
KKAdminIfremoveTagsFromProduct in interface KKAdminIfsessionId - session Id of logged in Admin usertags - Array of AdminTag objectsproductId - The id of the productKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void updateCachedConfigurations(java.lang.String sessionId)
throws KKAdminException
KKAdminIfupdateCachedConfigurations in interface KKAdminIfsessionId - session Id of logged in Admin userKKAdminException - an unexpected exception in the KonaKart Admin engine@Deprecated
public void publishProducts(java.lang.String sessionId,
AdminPublishConfig adminPublishConfig)
throws KKAdminException
KKAdminIfpublishProducts in interface KKAdminIfsessionId - Session IdadminPublishConfig - Defines the data feed parametersKKAdminException - an unexpected exception in the KonaKart Admin enginepublic java.lang.String getKonakartPropertyValue(java.lang.String sessionId,
java.lang.String section,
java.lang.String propertyName)
throws KKAdminException
KKAdminIfgetKonakartPropertyValue in interface KKAdminIfsessionId - The session Id of the logged in usersection - Properties file section e.g. the first part of the property name ("konakart" or
"torque"). Use constants in KonakartAdminConstants, eg.
KonakartAdminConstants.PROPERTY_FILE_SECTION_KONAKART or
KonakartAdminConstants.PROPERTY_FILE_SECTION_TORQUE etcpropertyName - property nameKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void addAllProductsToSearchEngine(java.lang.String sessionId,
boolean async)
throws KKAdminException
KKAdminIfThere are configuration parameters in konakartadmin.properties that can be modified to maximise performance based on the available resources.
addAllProductsToSearchEngine in interface KKAdminIfsessionId - Session Idasync - When set to true, control is immediately returned to the caller and the operation
proceeds asynchronously.KKAdminException - an unexpected exception in the KonaKart Admin enginepublic void addProductToSearchEngine(java.lang.String sessionId,
int productId)
throws KKAdminException
KKAdminIfaddProductToSearchEngine in interface KKAdminIfsessionId - Session IdproductId - The numeric id of the productKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void removeAllProductsFromSearchEngine(java.lang.String sessionId,
boolean async)
throws KKAdminException
KKAdminIfremoveAllProductsFromSearchEngine in interface KKAdminIfsessionId - Session Idasync - When set to true, control is immediately returned to the caller and the operation
proceeds asynchronously on the search engine.KKAdminException - an unexpected exception in the KonaKart Admin enginepublic void removeProductFromSearchEngine(java.lang.String sessionId,
int productId)
throws KKAdminException
KKAdminIfremoveProductFromSearchEngine in interface KKAdminIfsessionId - Session IdproductId - The numeric id of the productKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertConfigurationGroup(java.lang.String sessionId,
AdminConfigurationGroup configGroup)
throws KKAdminException
KKAdminIfinsertConfigurationGroup in interface KKAdminIfsessionId - The session Id of the logged in userconfigGroup - an AdminConfigurationGroup object to insertKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertConfiguration(java.lang.String sessionId,
KKConfiguration config)
throws KKAdminException
KKAdminIfinsertConfiguration in interface KKAdminIfsessionId - The session Id of the logged in userconfig - a KKConfiguration object to insertKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void removeMallStore(java.lang.String sessionId,
java.lang.String storeId)
throws KKAdminException
KKAdminIfMulti-Store Single DB only
removeMallStore in interface KKAdminIfsessionId - The session Id of the logged in userstoreId - the StoreId of the store to deleteKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void deleteMallStore(java.lang.String sessionId,
java.lang.String storeId)
throws KKAdminException
KKAdminIfMulti-Store Single DB only
deleteMallStore in interface KKAdminIfsessionId - The session Id of the logged in userstoreId - the StoreId of the store to deleteKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminStoreSearchResult getMallStores(AdminStoreSearch search, int offset, int size) throws KKAdminException
KKAdminIfgetMallStores in interface KKAdminIfsearch - search definition for storesoffset - offset in results (for paging)size - maximum number of records to return from the offset (for paging)KKAdminException - an unexpected exception in the KonaKart Admin enginepublic void insertMallStore(java.lang.String sessionId,
AdminStore store)
throws KKAdminException
KKAdminIfMulti-Store Single DB only
insertMallStore in interface KKAdminIfsessionId - The session Id of the logged in userstore - a new Store object to insert (all attributes should be filled in, including
storeId)KKAdminException - an unexpected exception in the KonaKart Admin enginepublic void cloneStore(java.lang.String sessionId,
AdminNewStoreOptions options,
java.lang.String storeToCloneId,
AdminStore newStore)
throws KKAdminException
KKAdminIfMulti-Store Single DB only.
cloneStore in interface KKAdminIfsessionId - The session Id of the logged in useroptions - Some options for defining how to execute the clonestoreToCloneId - the store the will be cloned to make the new storenewStore - the new storeKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void updateMallStore(java.lang.String sessionId,
AdminStore store)
throws KKAdminException
KKAdminIfMulti-Store Single DB only
updateMallStore in interface KKAdminIfsessionId - The session Id of the logged in userstore - The AdminStore object to updateKKAdminException - an unexpected exception in the KonaKart Admin enginepublic boolean doesMallStoreExist(java.lang.String storeId)
throws KKAdminException
KKAdminIfMulti-Store Single DB only
doesMallStoreExist in interface KKAdminIfstoreId - The StoreId of the store to checkKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void setProductQuantity(java.lang.String sessionId,
java.lang.String sku,
int id,
int quantity,
int operation)
throws KKAdminException
KKAdminIfThe product may be identified by the product id or the SKU. When set to a valid value, the SKU is used and the product id is ignored. When the SKU is set to null, the product id is used to identify the product. Note that the SKU should always be used in cases where a single product has many variations such as color and size.
The quantity parameter may be used to set the new quantity, to reduce the
quantity by its value or to increase the quantity by its value. In other words it can replace
the current quantity, be subtracted or added to the current quantity. The
operation parameter determines which operation is performed.
Valid values are:
setProductQuantity in interface KKAdminIfsessionId - Session Idsku - The SKU of the product. If set to null, the product id is used.id - The product id. Only used if the SKU is set to null.quantity - The new quantityoperation - Determines whether to set, add or subtract the quantity. See above for valid
values.KKAdminException - an unexpected exception in the KonaKart Admin enginepublic void setProductQuantityWithOptions(java.lang.String sessionId,
java.lang.String sku,
int id,
int quantity,
int operation,
AdminProductMgrOptions mgrOptions)
throws KKAdminException
KKAdminIfThe product may be identified by the product id or the SKU. When set to a valid value, the SKU is used and the product id is ignored. When the SKU is set to null, the product id is used to identify the product. Note that the SKU should always be used in cases where a single product has many variations such as color and size.
The quantity parameter may be used to set the new quantity, to reduce the
quantity by its value or to increase the quantity by its value. In other words it can replace
the current quantity, be subtracted or added to the current quantity. The
operation parameter determines which operation is performed.
Valid values are:
The mgrOptions object allows you to define whether the quantity can have different values depending on the catalogId. It may be set to null.
setProductQuantityWithOptions in interface KKAdminIfsessionId - Session Idsku - The SKU of the product. If set to null, the product id is used.id - The product id. Only used if the SKU is set to null.quantity - The new quantityoperation - Determines whether to set, add or subtract the quantity. See above for valid
values.mgrOptions - Allows you to define whether the quantity can have different values depending on
the catalogId. May be set to null.KKAdminException - an unexpected exception in the KonaKart Admin enginepublic void setProductVariantQuantityWithOptions(java.lang.String sessionId,
java.lang.String sku,
int id,
int quantity,
int operation,
java.lang.String variantCode,
AdminProductMgrOptions mgrOptions)
throws KKAdminException
KKAdminIfThe product may be identified by the product id or the SKU. When set to a valid value, the SKU is used and the product id is ignored. When the SKU is set to null, the product id is used to identify the product. Note that the SKU should always be used in cases where a single product has many variations such as color and size.
The quantity parameter may be used to set the new quantity, to reduce the
quantity by its value or to increase the quantity by its value. In other words it can replace
the current quantity, be subtracted or added to the current quantity. The
operation parameter determines which operation is performed.
Valid values are:
The mgrOptions object allows you to define whether the quantity can have different values depending on the catalogId. It may be set to null.
setProductVariantQuantityWithOptions in interface KKAdminIfsessionId - Session Idsku - The SKU of the product. If set to null, the product id is used.id - The product id. Only used if the SKU is set to null.quantity - The new quantityoperation - Determines whether to set, add or subtract the quantity. See above for valid
values.variantCode - the variantCode to identify the specific product variant to usemgrOptions - Allows you to define whether the quantity can have different values depending on
the catalogId. May be set to null.KKAdminException - an unexpected exception in the KonaKart Admin enginepublic void setProductAvailability(java.lang.String sessionId,
java.lang.String sku,
int id,
java.util.Calendar dateAvailable)
throws KKAdminException
KKAdminIfThe product may be identified by the product id or the SKU. When set to a valid value, the SKU is used and the product id is ignored. When the SKU is set to null, the product id is used to identify the product. Note that the SKU should always be used in cases where a single product has many variations such as color and size.
setProductAvailability in interface KKAdminIfsessionId - Session Idsku - The SKU of the product. If set to null, the product id is used.id - The product id. Only used if the SKU is set to null.dateAvailable - The date when the product will be availableKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void setProductAvailabilityWithOptions(java.lang.String sessionId,
java.lang.String sku,
int id,
java.util.Calendar dateAvailable,
AdminProductMgrOptions mgrOptions)
throws KKAdminException
KKAdminIfThe product may be identified by the product id or the SKU. When set to a valid value, the SKU is used and the product id is ignored. When the SKU is set to null, the product id is used to identify the product. Note that the SKU should always be used in cases where a single product has many variations such as color and size.
The mgrOptions object allows you to define whether the availability date can have different values depending on the catalogId. It may be set to null.
setProductAvailabilityWithOptions in interface KKAdminIfsessionId - Session Idsku - The SKU of the product. If set to null, the product id is used.id - The product id. Only used if the SKU is set to null.dateAvailable - The date when the product will be availablemgrOptions - Allows you to define whether the availability date can have different values
depending on the catalogId. May be set to null.KKAdminException - an unexpected exception in the KonaKart Admin enginepublic java.util.Calendar getProductAvailability(java.lang.String sessionId,
java.lang.String sku,
int id)
throws KKAdminException
KKAdminIfThe product may be identified by the product id or the SKU. When set to a valid value, the SKU is used and the product id is ignored. When the SKU is set to null, the product id is used to identify the product. Note that the SKU should always be used in cases where a single product has many variations such as color and size.
getProductAvailability in interface KKAdminIfsessionId - Session Idsku - The SKU of the product. If set to null, the product id is used.id - The product id. Only used if the SKU is set to null.KKAdminException - an unexpected exception in the KonaKart Admin enginepublic java.util.Calendar getProductAvailabilityWithOptions(java.lang.String sessionId,
java.lang.String sku,
int id,
AdminProductMgrOptions mgrOptions)
throws KKAdminException
KKAdminIfThe product may be identified by the product id or the SKU. When set to a valid value, the SKU is used and the product id is ignored. When the SKU is set to null, the product id is used to identify the product. Note that the SKU should always be used in cases where a single product has many variations such as color and size.
The mgrOptions object allows you to define whether the availability date can have different values depending on the catalogId. It may be set to null.
getProductAvailabilityWithOptions in interface KKAdminIfsessionId - Session Idsku - The SKU of the product. If set to null, the product id is used.id - The product id. Only used if the SKU is set to null.mgrOptions - Allows you to define whether the availability date can have different values
depending on the catalogId. May be set to null.KKAdminException - an unexpected exception in the KonaKart Admin enginepublic int getProductQuantity(java.lang.String sessionId,
java.lang.String sku,
int id)
throws KKAdminException
KKAdminIfThe product may be identified by the product id or the SKU. When set to a valid value, the SKU is used and the product id is ignored. When the SKU is set to null, the product id is used to identify the product. Note that the SKU should always be used in cases where a single product has many variations such as color and size.
getProductQuantity in interface KKAdminIfsessionId - Session Idsku - The SKU of the product. If set to null, the product id is used.id - The product id. Only used if the SKU is set to null.KKAdminException - an unexpected exception in the KonaKart Admin enginepublic int getProductQuantityWithOptions(java.lang.String sessionId,
java.lang.String sku,
int id,
AdminProductMgrOptions mgrOptions)
throws KKAdminException
KKAdminIfThe product may be identified by the product id or the SKU. When set to a valid value, the SKU is used and the product id is ignored. When the SKU is set to null, the product id is used to identify the product. Note that the SKU should always be used in cases where a single product has many variations such as color and size.
The mgrOptions object allows you to define whether the quantity can have different values depending on the catalogId. It may be set to null.
getProductQuantityWithOptions in interface KKAdminIfsessionId - Session Idsku - The SKU of the product. If set to null, the product id is used.id - The product id. Only used if the SKU is set to null.mgrOptions - Allows you to define whether the quantity can have different values depending on
the catalogId. May be set to null.KKAdminException - an unexpected exception in the KonaKart Admin enginepublic void addCustomDataToSession(java.lang.String sessionId,
java.lang.String data,
int position)
throws KKAdminException
KKAdminIfaddCustomDataToSession in interface KKAdminIfsessionId - The sessionIddata - The data to be savedposition - This must be in the range of 1-5 to identify custom1 to custom5KKAdminException - an unexpected exception in the KonaKart Admin enginepublic java.lang.String getCustomDataFromSession(java.lang.String sessionId,
int position)
throws KKAdminException
KKAdminIfgetCustomDataFromSession in interface KKAdminIfsessionId - The sessionIdposition - This must be in the range of 1-5 to identify custom1 to custom5KKAdminException - an unexpected exception in the KonaKart Admin enginepublic java.lang.String execute(java.lang.String sessionId,
java.lang.String className,
java.lang.String methodName,
java.lang.String[] paramArray)
throws KKAdminException
KKAdminIfThe purpose of this API call is to run batch jobs which may be easily run from a scheduler such as Quartz. The java class is instantiated through reflection. This means that it lends itself nicely to custom batch jobs created by KonaKart administrators. Note that if the class has a constructor with a single parameter of type KKAdminIf then this constructor will be called and will be passed an instantiated Admin Eng object.
For example:
public AdminOrderBatchMgr(KKAdminIf eng) throws Exception
{
super.init(eng);
}
execute in interface KKAdminIfsessionId - The sessionIdclassName - The fully qualified classNamemethodName - The name of the method to be executedparamArray - The parameters passed to the methodKKAdminException - an unexpected exception in the KonaKart Admin enginepublic boolean runBatchJob(java.lang.String sessionId,
java.lang.String group,
java.lang.String name,
java.lang.String[] paramArray)
throws KKAdminException
KKAdminIfThe batch job must be defined as one the existing batch jobs in the system.
For Quartz jobs, the paramAray is not actually used but it is provided should these parameters be required for overriding the implementation of this method in a custom engine.
runBatchJob in interface KKAdminIfsessionId - The sessionIdgroup - The group of the batch job to be runname - The name of the batch job to be executedparamArray - A generic set of Strings that can be used for custom purposes.KKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminProductToStore[] getProductsToStores(java.lang.String sessionId, AdminDataDescriptor dataDesc, AdminSearch search) throws KKAdminException
KKAdminIfgetProductsToStores in interface KKAdminIfsessionId - The session id of the logged in userdataDesc - Used to control the data offset, limit the number of items returned and set the
sort order Used to control the data offset, limit the number of items returned and
set the sort order. You can specify any two of the following to define the sort
order: AdminDataDescriptor.ORDER_BY_STOREID_ASCENDING,
AdminDataDescriptor.ORDER_BY_STOREID_DESCENDING,
AdminDataDescriptor.ORDER_BY_ID_ASCENDING,
AdminDataDescriptor.ORDER_BY_ID_DESCENDINGsearch - Defines the records to be returned. Populate the id with the productId (or set to
KonaKartAdminConstant.NOT_SET to get all products or set an array of product Ids
in the ids attribute to retrieve records for all of the products specified in the
array) and the name with the storeId (or leave null for all stores).KKAdminException - an unexpected exception in the KonaKart Admin enginepublic void insertProductsToStores(java.lang.String sessionId,
AdminProductToStore[] productToStores)
throws KKAdminException
KKAdminIfinsertProductsToStores in interface KKAdminIfsessionId - The session id of the logged in userproductToStores - an array of AdminProductToStore objects to insert into the databaseKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void removeProductsToStores(java.lang.String sessionId,
AdminProductToStore[] productToStores)
throws KKAdminException
KKAdminIfremoveProductsToStores in interface KKAdminIfsessionId - The session id of the logged in userproductToStores - an array of AdminProductToStore objects to delete from the databaseKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertOrder(java.lang.String sessionId,
AdminOrder order)
throws KKAdminException
KKAdminIfinsertOrder in interface KKAdminIfsessionId - The session id of the logged in userorder - The order to be insertedKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminWishLists getWishLists(java.lang.String sessionId, AdminWishListSearch search, int offset, int size) throws KKAdminException
KKAdminIfgetWishLists in interface KKAdminIfsessionId - session Id of logged in Admin usersearch - the AdminWishListSearch object that defines the wish list objects to search for.
If null we use the default AdminWishListSearch object.offset - starting offset in database - so that you can page through resultssize - size of the group that will be returned - the maximum number of records returnedKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertWishList(java.lang.String sessionId,
AdminWishList wishList)
throws KKAdminException
KKAdminIfinsertWishList in interface KKAdminIfsessionId - The session id of the logged in userwishList - The wish listKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void deleteWishList(java.lang.String sessionId,
int wishListId)
throws KKAdminException
KKAdminIfdeleteWishList in interface KKAdminIfsessionId - The session id of the logged in userwishListId - Id of the wish list itemKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertWishListItem(java.lang.String sessionId,
AdminWishListItem wishListItem)
throws KKAdminException
KKAdminIfinsertWishListItem in interface KKAdminIfsessionId - The session id of the logged in userwishListItem - The wish list itemKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void deleteWishListItem(java.lang.String sessionId,
int wishListItemId)
throws KKAdminException
KKAdminIfdeleteWishListItem in interface KKAdminIfsessionId - The session id of the logged in userwishListItemId - Id of the wish list itemKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminAddress getAddressById(java.lang.String sessionId, int addressId) throws KKAdminException
KKAdminIfgetAddressById in interface KKAdminIfsessionId - session Id of logged in Admin useraddressId - the id of the address to retrieveKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminAddressSearchResult getAddresses(java.lang.String sessionId, AdminAddressSearch search, int offset, int size) throws KKAdminException
KKAdminIfgetAddresses in interface KKAdminIfsessionId - session Id of logged in Admin usersearch - the search criteriaoffset - the offset in the record set to start fromsize - the maximum number of records to returnKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void deleteAddress(java.lang.String sessionId,
int addressId)
throws KKAdminException
KKAdminIfdeleteAddress in interface KKAdminIfsessionId - session Id of logged in Admin useraddressId - the id of the address to deleteKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertAddress(java.lang.String sessionId,
AdminAddress address)
throws KKAdminException
KKAdminIfinsertAddress in interface KKAdminIfsessionId - session Id of logged in Admin useraddress - an AdminAddress objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void updateAddress(java.lang.String sessionId,
AdminAddress address)
throws KKAdminException
KKAdminIfupdateAddress in interface KKAdminIfsessionId - session Id of logged in Admin useraddress - the AdminAddress object to updateKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertCustomerTag(java.lang.String sessionId,
AdminCustomerTag tag)
throws KKAdminException
KKAdminIfThe following customer tag attributes are compulsory:
The id of the new object is returned.
insertCustomerTag in interface KKAdminIfsessionId - The session id of the logged in usertag - The AdminCustomerTag object to be insertedKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminCustomerTagSearchResult getCustomerTags(java.lang.String sessionId, AdminCustomerTagSearch search, int offset, int size) throws KKAdminException
KKAdminIfConstraints may be added for:
The returned objects may be ordered by:
getCustomerTags in interface KKAdminIfsessionId - The session id of the logged in usersearch - The search object that defines the search parameters and sort orderoffset - The offset in the dbsize - The number of records from the specified offsetKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int updateCustomerTag(java.lang.String sessionId,
AdminCustomerTag tag)
throws KKAdminException
KKAdminIfupdateCustomerTag in interface KKAdminIfsessionId - The session id of the logged in usertag - The AdminCustomerTag object used for the updateKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int deleteCustomerTag(java.lang.String sessionId,
int id)
throws KKAdminException
KKAdminIfdeleteCustomerTag in interface KKAdminIfsessionId - The session id of the logged in userid - The id of the deleted customer tagKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminCustomerTag getCustomerTag(java.lang.String sessionId, int id) throws KKAdminException
KKAdminIfid parameter, or Null if the
customer tag doesn't exist in the DB.getCustomerTag in interface KKAdminIfsessionId - The session id of the logged in userid - The id of the AdminCustomerTag objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void deleteCustomerTagForCustomer(java.lang.String sessionId,
int customerId,
java.lang.String tagName)
throws KKAdminException
KKAdminIftagName for the customer
referenced by customerId.deleteCustomerTagForCustomer in interface KKAdminIfsessionId - The session id of the logged in usercustomerId - The id of the customertagName - The name of the customer tagKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminCustomerTag getCustomerTagForCustomer(java.lang.String sessionId, int customerId, java.lang.String tagName) throws KKAdminException
KKAdminIftagName parameter, or Null if the
customer tag doesn't exist in the DB. The value attribute of the customer tag
contains the value for the customer referenced by customerId.getCustomerTagForCustomer in interface KKAdminIfsessionId - The session id of the logged in usercustomerId - The id of the customertagName - The name of the customer tagKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminCustomerTag getCustomerTagForName(java.lang.String sessionId, java.lang.String tagName) throws KKAdminException
KKAdminIftagName parameter, or Null if the
customer tag doesn't exist in the DB.getCustomerTagForName in interface KKAdminIfsessionId - The session id of the logged in usertagName - The name of the customer tagKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminCustomerTag[] getCustomerTagsForCustomer(java.lang.String sessionId, int customerId) throws KKAdminException
KKAdminIfcustomerId parameter. The value attribute of the customer tags
contains the value for the customer referenced by customerId.
An empty array is returned if no tags exist.
getCustomerTagsForCustomer in interface KKAdminIfsessionId - The session id of the logged in usercustomerId - The id of the customerKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void insertCustomerTagForCustomer(java.lang.String sessionId,
int customerId,
AdminCustomerTag tag)
throws KKAdminException
KKAdminIfcustomerId. 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().
insertCustomerTagForCustomer in interface KKAdminIfsessionId - The session id of the logged in usercustomerId - The id of the customertag - The customer tag objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int deleteExpression(java.lang.String sessionId,
int id)
throws KKAdminException
KKAdminIfid.deleteExpression in interface KKAdminIfsessionId - The session id of the logged in userid - The id of the AdminExpression object to be deletedKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int deleteExpressionVariable(java.lang.String sessionId,
int id)
throws KKAdminException
KKAdminIfid.deleteExpressionVariable in interface KKAdminIfsessionId - The session id of the logged in userid - The id of the AdminExpressionVariable object to be deletedKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminExpression getExpression(java.lang.String sessionId, int id) throws KKAdminException
KKAdminIfid parameter, or Null if the
AdminExpression doesn't exist in the DB.getExpression in interface KKAdminIfsessionId - The session id of the logged in userid - The id of the AdminExpression objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminExpression getExpressionForName(java.lang.String sessionId, java.lang.String expName) throws KKAdminException
KKAdminIfexpName parameter, or Null if the
AdminExpression doesn't exist in the DB.getExpressionForName in interface KKAdminIfsessionId - The session id of the logged in userexpName - The name of the AdminExpression objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminExpressionVariable getExpressionVariable(java.lang.String sessionId, int id) throws KKAdminException
KKAdminIfid parameter, or Null if the
AdminExpressionVariable doesn't exist in the DB.getExpressionVariable in interface KKAdminIfsessionId - The session id of the logged in userid - The id of the AdminExpressionVariable objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminExpressionVariable[] getExpressionVariablesForExpression(java.lang.String sessionId, int expressionId) throws KKAdminException
KKAdminIfid parameter. An empty array is returned if no objects are found.getExpressionVariablesForExpression in interface KKAdminIfsessionId - The session id of the logged in userexpressionId - The AdminExpression id for the AdminExpressionVariable objectsKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminExpressionSearchResult getExpressions(java.lang.String sessionId, AdminExpressionSearch search, int offset, int size) throws KKAdminException
KKAdminIfConstraints may be added for:
The returned objects may be ordered by:
getExpressions in interface KKAdminIfsessionId - The session id of the logged in usersearch - The search object that defines the search parameters and sort orderoffset - The offset in the dbsize - The number of records from the specified offsetKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertExpressionVariables(java.lang.String sessionId,
AdminExpressionVariable[] expVarArray)
throws KKAdminException
KKAdminIfinsertExpressionVariables in interface KKAdminIfsessionId - The session id of the logged in userexpVarArray - The AdminExpressionVariable array of objects to be insertedKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int updateExpression(java.lang.String sessionId,
AdminExpression exp)
throws KKAdminException
KKAdminIfupdateExpression in interface KKAdminIfsessionId - The session id of the logged in userexp - The AdminExpression object to be updatedKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int updateExpressionVariable(java.lang.String sessionId,
AdminExpressionVariable expVar)
throws KKAdminException
KKAdminIfupdateExpressionVariable in interface KKAdminIfsessionId - The session id of the logged in userexpVar - The AdminExpressionVariable object to be updatedKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertExpression(java.lang.String sessionId,
AdminExpression exp)
throws KKAdminException
KKAdminIfname attribute of the
AdminExpression is required.insertExpression in interface KKAdminIfsessionId - The session id of the logged in userexp - The AdminExpression object to be insertedKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void deleteExpressionVariablesForExpression(java.lang.String sessionId,
int expressionId)
throws KKAdminException
KKAdminIfexpressionId.deleteExpressionVariablesForExpression in interface KKAdminIfsessionId - The session id of the logged in userexpressionId - The id of the AdminExpression objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminExpression[] getExpressionsPerPromotion(java.lang.String sessionId, int promotionId) throws KKAdminException
KKAdminIfpromotionIdgetExpressionsPerPromotion in interface KKAdminIfsessionId - The session id of the logged in userpromotionId - The numeric id of the promotionKKAdminException - an unexpected exception in the KonaKart Admin enginepublic boolean evaluateExpression(java.lang.String sessionId,
int customerId,
int expressionId,
java.lang.String expressionName)
throws KKAdminException
KKAdminIfcustomerId. 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.evaluateExpression in interface KKAdminIfsessionId - The session id of the logged in usercustomerId - The id of the customerexpressionId - the expressionIdexpressionName - the expressionNameKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int importDigitalDownload(java.lang.String sessionId,
AdminDigitalDownload digDownload)
throws KKAdminException
KKAdminIfcustomerId and productId) the record is updated.
Before inserting, the record is validated to ensure that the product referred to by the
productId is indeed a Digital Download or Gift Certificate product.
importDigitalDownload in interface KKAdminIfsessionId - The session id of the logged in userdigDownload - the Digital Download object to importKKAdminException - an unexpected exception in the KonaKart Admin engine if the digital download
record specified is invalid or there are database problemspublic AdminDigitalDownloadSearchResult searchDigitalDownloads(java.lang.String sessionId, AdminDigitalDownloadSearch search, int offset, int size) throws KKAdminException
KKAdminIfsearchDigitalDownloads in interface KKAdminIfsessionId - The session id of the logged in usersearch - search definition for digital downloadsoffset - offset in results (for paging)size - maximum number of records to return from the offset (for paging)KKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminRewardPointSearchResult getRewardPoints(java.lang.String sessionId, AdminRewardPointSearch search, int offset, int size) throws KKAdminException
KKAdminIfgetRewardPoints in interface KKAdminIfsessionId - The session id of the logged in usersearch - Object containing search constraints and sort order detailsoffset - offset in results (for paging)size - maximum number of records to return from the offset (for paging)KKAdminException - an unexpected exception in the KonaKart Admin enginepublic int pointsAvailable(java.lang.String sessionId,
int customerId)
throws KKAdminException
KKAdminIfcustomerId parameter.pointsAvailable in interface KKAdminIfsessionId - The session id of the logged in usercustomerId - The id of the customerKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int deletePoints(java.lang.String sessionId,
int customerId,
int points,
java.lang.String code,
java.lang.String description)
throws KKAdminException
KKAdminIfcustomerId parameter.deletePoints in interface KKAdminIfsessionId - The session id of the logged in usercustomerId - The id of the customerpoints - The number of points to be deletedcode - An optional code to categorize the reason for redeeming the pointsdescription - An optional description describing how the points were redeemedKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int addPoints(java.lang.String sessionId,
int customerId,
int points,
java.lang.String code,
java.lang.String description)
throws KKAdminException
KKAdminIfcustomerId parameter.addPoints in interface KKAdminIfsessionId - The session id of the logged in usercustomerId - The id of the customerpoints - The number of points to be addedcode - An optional code to categorize the reason for awarding the pointsdescription - An optional description describing why the points were awardedKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminFile[] getFiles(java.lang.String sessionId, java.lang.String directory, java.lang.String extension) throws KKAdminException
KKAdminIfgetFiles in interface KKAdminIfsessionId - The session id of the logged in userdirectory - The directory containing the filesextension - The extension of the files to return in the array (strictly it matches on the
string at the end of the filename - so ".pdf" and "pdf" would both work but could
return different results). If null, all files are returned.KKAdminException - an unexpected exception in the KonaKart Admin enginepublic int deletePaymentSchedule(java.lang.String sessionId,
int id)
throws KKAdminException
KKAdminIfdeletePaymentSchedule in interface KKAdminIfsessionId - The session id of the logged in userid - The id of the payment schedule object to deleteKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int deleteSubscription(java.lang.String sessionId,
int id)
throws KKAdminException
KKAdminIfdeleteSubscription in interface KKAdminIfsessionId - The session id of the logged in userid - The id of the subscription object to deleteKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminPaymentSchedule getPaymentSchedule(java.lang.String sessionId, int id) throws KKAdminException
KKAdminIfid parameter, or Null if the payment
schedule object doesn't exist in the DB.getPaymentSchedule in interface KKAdminIfsessionId - The session id of the logged in userid - The id of the payment schedule objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminSubscription getSubscription(java.lang.String sessionId, int id) throws KKAdminException
KKAdminIfid parameter, or Null if the
subscription object doesn't exist in the DB.getSubscription in interface KKAdminIfsessionId - The session id of the logged in userid - The id of the subscription objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminPaymentScheduleSearchResult getPaymentSchedules(java.lang.String sessionId, AdminPaymentScheduleSearch search, int offset, int size) throws KKAdminException
KKAdminIfgetPaymentSchedules in interface KKAdminIfsessionId - The session id of the logged in usersearch - The object containing the search constraintsoffset - the offset in the dbsize - the number of records from the specified offsetKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminSubscriptionSearchResult getSubscriptions(java.lang.String sessionId, AdminSubscriptionSearch search, int offset, int size) throws KKAdminException
KKAdminIfgetSubscriptions in interface KKAdminIfsessionId - The session id of the logged in usersearch - The object containing the search constraintsoffset - the offset in the dbsize - the number of records from the specified offsetKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertPaymentSchedule(java.lang.String sessionId,
AdminPaymentSchedule ps)
throws KKAdminException
KKAdminIfinsertPaymentSchedule in interface KKAdminIfsessionId - The session id of the logged in userps - the psKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertSubscription(java.lang.String sessionId,
AdminSubscription subscription)
throws KKAdminException
KKAdminIfinsertSubscription in interface KKAdminIfsessionId - The session id of the logged in usersubscription - the subscriptionKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int updatePaymentSchedule(java.lang.String sessionId,
AdminPaymentSchedule ps)
throws KKAdminException
KKAdminIfupdatePaymentSchedule in interface KKAdminIfsessionId - The session id of the logged in userps - An AdminPaymentSchedule objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int updateSubscription(java.lang.String sessionId,
AdminSubscription subscription)
throws KKAdminException
KKAdminIfupdateSubscription in interface KKAdminIfsessionId - The session id of the logged in usersubscription - An AdminSubscription objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic boolean checkDataIntegrity(java.lang.String sessionId,
AdminDataIntegrityOptions dataIntegrityOptions)
throws KKAdminException
KKAdminIfcheckDataIntegrity in interface KKAdminIfsessionId - The session id of the logged in userdataIntegrityOptions - Defines the options to use for the data integrity checkKKAdminException - an unexpected exception in the KonaKart Admin enginepublic com.konakart.app.ExportOrderResponse exportOrder(java.lang.String sessionId,
com.konakart.app.ExportOrderOptions options)
throws KKAdminException
KKAdminIfexportOrder in interface KKAdminIfsessionId - The session id of the logged in useroptions - Defines the options to use for the export of the OrderKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminKkMsgSearchResult searchMsg(AdminKkMsgSearch search, int groupSize, int offset) throws KKAdminException
KKAdminIfsearchMsg in interface KKAdminIfsearch - the AdminKkMsgSearch object that defines the search criteriagroupSize - a maximum of this many messages will be returned by each call (the group size)offset - the offset in the record set that match the criteria from which records are
returnedKKAdminException - an unexpected exception in the KonaKart Admin enginepublic java.lang.String getMsgValue(java.lang.String key,
int type,
java.lang.String locale)
throws KKAdminException
KKAdminIfgetMsgValue in interface KKAdminIfkey - the message keytype - the message type (Use KKConstants.MSG_TYP_APPLICATION for application messages,
KKConstants.MSG_TYP_ADMIN_APP for Admin App messages,
KKConstants.MSG_TYP_Admin_HELP for Admin App Help messages)locale - the message locale (eg. "en_GB"). If this is null the default locale for the store
is used.KKAdminException - an unexpected exception in the KonaKart Admin enginepublic void deleteMsg(java.lang.String sessionId,
java.lang.String key,
int type,
java.lang.String locale)
throws KKAdminException
KKAdminIfdeleteMsg in interface KKAdminIfsessionId - The session id of the logged in userkey - the message keytype - the message type (Use KKConstants.MSG_TYP_APPLICATION for application messages,
KKConstants.MSG_TYP_ADMIN_APP for Admin App messages,
KKConstants.MSG_TYP_Admin_HELP for Admin App Help messages)locale - the message locale (eg. "en_GB"). If this is null the default locale for the store
is used.KKAdminException - an unexpected exception in the KonaKart Admin enginepublic void insertMsg(java.lang.String sessionId,
java.lang.String key,
int type,
java.lang.String locale,
java.lang.String value)
throws KKAdminException
KKAdminIfinsertMsg in interface KKAdminIfsessionId - The session id of the logged in userkey - the message keytype - the message type (Use KKConstants.MSG_TYP_APPLICATION for application messages,
KKConstants.MSG_TYP_ADMIN_APP for Admin App messages,
KKConstants.MSG_TYP_Admin_HELP for Admin App Help messages)locale - the message locale (eg. "en_GB"). If this is null the default locale for the store
is used.value - the value of the message to be insertedKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void updateMsg(java.lang.String sessionId,
java.lang.String key,
int type,
java.lang.String locale,
java.lang.String value)
throws KKAdminException
KKAdminIfupdateMsg in interface KKAdminIfsessionId - The session id of the logged in userkey - the message keytype - the message type (Use KKConstants.MSG_TYP_APPLICATION for application messages,
KKConstants.MSG_TYP_ADMIN_APP for Admin App messages,
KKConstants.MSG_TYP_Admin_HELP for Admin App Help messages)locale - the message locale (eg. "en_GB"). If this is null the default locale for the store
is used.value - the new value for the messageKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void importMsgs(java.lang.String sessionId,
int type,
java.lang.String locale,
java.lang.String msgString,
boolean replace)
throws KKAdminException
KKAdminIfimportMsgs in interface KKAdminIfsessionId - The session id of the logged in usertype - the message type (Use KKConstants.MSG_TYP_APPLICATION for application messages,
KKConstants.MSG_TYP_ADMIN_APP for Admin App messages,
KKConstants.MSG_TYP_Admin_HELP for Admin App Help messages)locale - the message locale (eg. "en_GB"). If this is null the default locale for the store
is used.msgString - A String containing the messages to import in the format of a java properties filereplace - if true all the current messages for the specified type and locale are removed
before importing the new messages. If false the new messages are appended and if a
message key already exists it is replaced by the new message value being imported.KKAdminException - an unexpected exception in the KonaKart Admin enginepublic java.lang.String exportMsgs(int type,
java.lang.String locale)
throws KKAdminException
KKAdminIfexportMsgs in interface KKAdminIftype - the message type (Use KKConstants.MSG_TYP_APPLICATION for application messages,
KKConstants.MSG_TYP_ADMIN_APP for Admin App messages,
KKConstants.MSG_TYP_Admin_HELP for Admin App Help messages)locale - the message locale (eg. "en_GB"). If this is null the default locale for the store
is used.KKAdminException - an unexpected exception in the KonaKart Admin enginepublic void addAddressesToProduct(java.lang.String sessionId,
AdminAddress[] addresses,
int productId)
throws KKAdminException
KKAdminIfaddAddressesToProduct in interface KKAdminIfsessionId - The session id of the logged in useraddresses - The array of address to be addedproductId - The numeric id of the productKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void removeAddressFromProduct(java.lang.String sessionId,
int addressId,
int productId)
throws KKAdminException
KKAdminIfremoveAddressFromProduct in interface KKAdminIfsessionId - The session id of the logged in useraddressId - The numeric id of the addressproductId - The numeric id of the productKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int getProductCountPerAddress(java.lang.String sessionId,
int addressId)
throws KKAdminException
KKAdminIfgetProductCountPerAddress in interface KKAdminIfsessionId - The session id of the logged in useraddressId - The numeric id of the addressKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminManufacturerSearchResult getManufacturers(java.lang.String sessionId, AdminManufacturerSearch search, int offset, int size) throws KKAdminException
KKAdminIfConstraints may be added for:
The returned objects may be ordered by:
getManufacturers in interface KKAdminIfsessionId - The session id of the logged in usersearch - The search object that defines the search parameters and sort orderoffset - The offset in the dbsize - The number of records from the specified offsetKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminProductOptionSearchResult getProductOptions(java.lang.String sessionId, AdminProductOptionSearch search, int offset, int size) throws KKAdminException
KKAdminIfgetProductOptions in interface KKAdminIfsessionId - The session Id of the logged in usersearch - The search parameters. The languageId determines in which language the product
options are returned. It can be set to AdminLanguageMgr.DEFAULT_LANG to specify
the default language, or to AdminLanguageMgr.ALL_LANGUAGES to specify all
languages.offset - the offset in the dbsize - the number of records from the specified offsetKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int deleteProdAttrDesc(java.lang.String sessionId,
int id)
throws KKAdminException
KKAdminIfdeleteProdAttrDesc in interface KKAdminIfsessionId - The session id of the logged in userid - The id of the AdminProdAttrDesc object to be deletedKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int deleteProdAttrDescWithOptions(java.lang.String sessionId,
int id,
AdminProdAttrDescOptions options)
throws KKAdminException
KKAdminIfdeleteProdAttrDescWithOptions in interface KKAdminIfsessionId - The session id of the logged in userid - The id of the deleted AdminProdAttrDesc objectoptions - Can be used to configure the operation to update all products to remove the
deleted attribute from the products using it.KKAdminException - an unexpected exception in the KonaKart Admin enginepublic int deleteProdAttrTemplate(java.lang.String sessionId,
int id)
throws KKAdminException
KKAdminIfdeleteProdAttrTemplate in interface KKAdminIfsessionId - The session id of the logged in userid - The id of the AdminProdAttrTemplate object to be deletedKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminProdAttrDesc getProdAttrDesc(java.lang.String sessionId, int id) throws KKAdminException
KKAdminIfid parameter, or Null if the
AdminProdAttrDesc doesn't exist in the DB.getProdAttrDesc in interface KKAdminIfsessionId - The session id of the logged in userid - The id of the AdminProdAttrDesc to be fetchedKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminProdAttrDescSearchResult getProdAttrDescs(java.lang.String sessionId, AdminProdAttrDescSearch search, int offset, int size) throws KKAdminException
KKAdminIfgetProdAttrDescs in interface KKAdminIfsessionId - The session id of the logged in usersearch - An AdminProdAttrDescSearch containing search criteriaoffset - The offset in the dbsize - The number of records from the specified offsetKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminProdAttrDesc[] getProdAttrDescsForTemplate(java.lang.String sessionId, int templateId) throws KKAdminException
KKAdminIftemplateId parameter.
An empty array is returned if no AdminProdAttrDesc objects exist.
getProdAttrDescsForTemplate in interface KKAdminIfsessionId - The session id of the logged in usertemplateId - The id of the templateKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminProdAttrDesc[] getProdAttrDescsForTemplates(java.lang.String sessionId, AdminProdAttrTemplate[] templates) throws KKAdminException
KKAdminIftemplates parameter. The sort order of the AdminProdAttrDesc
objects matches the sort order of the templates within the templates array parameter.
An empty array is returned if no AdminProdAttrDesc objects exist.
getProdAttrDescsForTemplates in interface KKAdminIfsessionId - The session id of the logged in usertemplates - An array of AdminProdAttrTemplate objects. An empty array is returned if no
AdminProdAttrDesc objects exist.KKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminProdAttrTemplate getProdAttrTemplate(java.lang.String sessionId, int id) throws KKAdminException
KKAdminIfid parameter, or Null if the
AdminProdAttrTemplate doesn't exist in the DB. If the Template contains an array of
ProdAttrDesc objects, these are also fetched from the DB.getProdAttrTemplate in interface KKAdminIfsessionId - The session id of the logged in userid - The id of the AdminProdAttrTemplate object to be fetchedKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminProdAttrTemplateSearchResult getProdAttrTemplates(java.lang.String sessionId, AdminProdAttrTemplateSearch search, int offset, int size) throws KKAdminException
KKAdminIfgetProdAttrTemplates in interface KKAdminIfsessionId - The session id of the logged in usersearch - An AdminProdAttrTemplateSearch containing search criteriaoffset - The offset in the dbsize - The number of records from the specified offsetKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertProdAttrDesc(java.lang.String sessionId,
AdminProdAttrDesc attrDesc)
throws KKAdminException
KKAdminIfinsertProdAttrDesc in interface KKAdminIfsessionId - The session id of the logged in userattrDesc - The AdminProdAttrDesc to insertKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertProdAttrTemplate(java.lang.String sessionId,
AdminProdAttrTemplate template)
throws KKAdminException
KKAdminIfinsertProdAttrTemplate in interface KKAdminIfsessionId - The session id of the logged in usertemplate - The AdminProdAttrTemplate object to be insertedKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void removeProdAttrDescsFromTemplate(java.lang.String sessionId,
AdminProdAttrDesc[] attrDescs,
int templateId)
throws KKAdminException
KKAdminIfattrDescs is set
to null, all ProdAttrDesc objects are removed from the template.removeProdAttrDescsFromTemplate in interface KKAdminIfsessionId - The session id of the logged in userattrDescs - Array of AdminProdAttrDesc objectstemplateId - Id of the AdminProdAttrTemplateKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void addProdAttrDescsToTemplate(java.lang.String sessionId,
AdminProdAttrDesc[] attrDescs,
int templateId)
throws KKAdminException
KKAdminIfaddProdAttrDescsToTemplate in interface KKAdminIfsessionId - The session id of the logged in userattrDescs - Array of AdminProdAttrDesc objectstemplateId - Id of the AdminProdAttrTemplateKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int updateProdAttrDesc(java.lang.String sessionId,
AdminProdAttrDesc attrDesc)
throws KKAdminException
KKAdminIfupdateProdAttrDesc in interface KKAdminIfsessionId - The session id of the logged in userattrDesc - The AdminProdAttrDesc to updateKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int updateProdAttrTemplate(java.lang.String sessionId,
AdminProdAttrTemplate template)
throws KKAdminException
KKAdminIfupdateProdAttrTemplate in interface KKAdminIfsessionId - The session id of the logged in usertemplate - An AdminProdAttrTemplate objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int getTemplateCountPerProdAttrDesc(java.lang.String sessionId,
int attrDescId)
throws KKAdminException
KKAdminIfgetTemplateCountPerProdAttrDesc in interface KKAdminIfsessionId - The session id of the logged in userattrDescId - The id of the AdminProdAttrDesc objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int getProductCountPerProdAttrDesc(java.lang.String sessionId,
int attrDescId)
throws KKAdminException
KKAdminIfgetProductCountPerProdAttrDesc in interface KKAdminIfsessionId - The session id of the logged in userattrDescId - The id of the AdminProdAttrDesc objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int updateProductsUsingProdAttrDesc(java.lang.String sessionId,
int attrDescId)
throws KKAdminException
KKAdminIfWhen a Product Attribute Descriptor is modified, all of the products using the descriptor are not updated automatically. In order to update them, this API call must be called, passing in the id of the Product Attribute Descriptor that has been modified.
Depending on the number of products, the API call may take some time to complete.
updateProductsUsingProdAttrDesc in interface KKAdminIfsessionId - The session id of the logged in userattrDescId - The id of the AdminProdAttrDesc objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int updateProductsUsingTemplates(java.lang.String sessionId,
int[] templateIds)
throws KKAdminException
KKAdminIfWhen a Product Attribute Template is modified, all of the products using the template are not updated automatically. In order to update them, this API call must be called, passing in the id(s) of the templates that have been modified.
Depending on the number of products, the API call may take some time to complete.
updateProductsUsingTemplates in interface KKAdminIfsessionId - The session id of the logged in usertemplateIds - An array of template idsKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int getProductCountPerTemplate(java.lang.String sessionId,
int templateId)
throws KKAdminException
KKAdminIfgetProductCountPerTemplate in interface KKAdminIfsessionId - The session id of the logged in usertemplateId - The id of the AdminProdAttrTemplate objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic com.konakart.app.NameValue[] callPaymentModule(java.lang.String sessionId,
java.lang.String moduleClassName,
com.konakart.app.PaymentOptions options)
throws KKAdminException
KKAdminIfcom.konakartadmin.modules.AdminPaymentIf interface, is
instantiated and the execute method is called.callPaymentModule in interface KKAdminIfsessionId - The session id of the logged in usermoduleClassName - The full class name such as
com.konakartadmin.modules.payment.authorizenet.AdminPaymentoptions - An object containing all of the parameters required for the transactionKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminBookingSearchResult getBookings(java.lang.String sessionId, AdminBookingSearch search, int offset, int size, AdminBookableProductOptions options) throws KKAdminException
KKAdminIfgetBookings in interface KKAdminIfsessionId - The session id of the logged in usersearch - AdminBookingSearch object that defines the searchoffset - offsetsize - maximum number of records to return from the offset positionoptions - AdminBookableProduct optionsKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertBooking(java.lang.String sessionId,
AdminBooking booking,
AdminBookableProductOptions options)
throws KKAdminException
KKAdminIfinsertBooking in interface KKAdminIfsessionId - The session id of the logged in userbooking - The booking to insertoptions - AdminBookableProduct optionsKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void updateBooking(java.lang.String sessionId,
AdminBooking booking,
AdminBookableProductOptions options)
throws KKAdminException
KKAdminIfupdateBooking in interface KKAdminIfsessionId - The session id of the logged in userbooking - The booking to updateoptions - AdminBookableProduct optionsKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void deleteBooking(java.lang.String sessionId,
int bookingId,
AdminBookableProductOptions options)
throws KKAdminException
KKAdminIfdeleteBooking in interface KKAdminIfsessionId - The session id of the logged in userbookingId - bookingId of the booking to deleteoptions - AdminBookableProduct optionsKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void deleteCatalog(java.lang.String sessionId,
int catalogId)
throws KKAdminException
KKAdminIfdeleteCatalog in interface KKAdminIfsessionId - The session id of the logged in usercatalogId - The numeric id of the catalogKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void deleteCatalogWithOptions(java.lang.String sessionId,
int catalogId,
AdminDeleteCatalogOptions options)
throws KKAdminException
KKAdminIfdeleteCatalogWithOptions in interface KKAdminIfsessionId - The session id of the logged in usercatalogId - The numeric id of the catalogoptions - define whether or not to remove prices for this catalog as well.KKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminCatalogSearchResult getCatalogs(java.lang.String sessionId, AdminCatalogSearch search, int offset, int size) throws KKAdminException
KKAdminIfgetCatalogs in interface KKAdminIfsessionId - The session id of the logged in usersearch - AdminCatalogSearch object that defines the searchoffset - offsetsize - maximum number of records to return from the offset positionKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertCatalog(java.lang.String sessionId,
AdminCatalog catalog)
throws KKAdminException
KKAdminIfinsertCatalog in interface KKAdminIfsessionId - The session id of the logged in usercatalog - The AdminCatalog object to be insertedKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void updateCatalog(java.lang.String sessionId,
AdminCatalog catalog)
throws KKAdminException
KKAdminIfupdateCatalog in interface KKAdminIfsessionId - The session id of the logged in usercatalog - The AdminCatalog object to be updatedKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminCatalog getCatalogById(java.lang.String sessionId, int catalogId) throws KKAdminException
KKAdminIfgetCatalogById in interface KKAdminIfsessionId - The session id of the logged in usercatalogId - The numeric id of the catalogKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void deleteMiscItemType(java.lang.String sessionId,
int miTypeId,
boolean deleteChildren)
throws KKAdminException
KKAdminIfdeleteMiscItemType in interface KKAdminIfsessionId - The session id of the logged in usermiTypeId - the id of the miscellaneous item type object to deletedeleteChildren - if true all children (miscellaneous items with this miscellaneous item type) will
also be deleted.KKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminMiscItemType[] getMiscItemTypes(java.lang.String sessionId, AdminSearch search, int offset, int size) throws KKAdminException
KKAdminIfgetMiscItemTypes in interface KKAdminIfsessionId - session Id of logged in Admin usersearch - the generic Admin search object that defines the objects to search for. If null we
use the default AdminSearch object. If you specify the LanguageId in the search
object, only the MiscItemType for that specified language will be returned. If you
specify AdminLanguage.ALL_LANGUAGES for the languageId the search will be made on
the default language, and if MiscItemTypes are found, MiscItemTypes with these
MiscItemTypeIds for all of the languages are returned.offset - starting offset in database - so that you can page through resultssize - size of the group that will be returned - the maximum number of records returnedKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertMiscItemType(java.lang.String sessionId,
AdminMiscItemType[] miTypes)
throws KKAdminException
KKAdminIfinsertMiscItemType in interface KKAdminIfsessionId - The session id of the logged in usermiTypes - An array of AdminMiscItemType objects to insert. Typically you would insert one
AdminMiscItemType record for each language to maintain data integrity.KKAdminException - an unexpected exception in the KonaKart Admin enginepublic void updateMiscItemType(java.lang.String sessionId,
AdminMiscItemType[] miTypes)
throws KKAdminException
KKAdminIfupdateMiscItemType in interface KKAdminIfsessionId - The session id of the logged in usermiTypes - An array of AdminMiscItemType objects to update.KKAdminException - an unexpected exception in the KonaKart Admin enginepublic void deleteMiscItem(java.lang.String sessionId,
int miId)
throws KKAdminException
KKAdminIfdeleteMiscItem in interface KKAdminIfsessionId - The session id of the logged in usermiId - the id of the miscellaneous item object to deleteKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminMiscItemSearchResult getMiscItems(java.lang.String sessionId, AdminSearch search, int offset, int size) throws KKAdminException
KKAdminIfgetMiscItems in interface KKAdminIfsessionId - session Id of logged in Admin usersearch - the generic Admin search object that defines the objects to search for. If null we
use the default AdminSearch object.
AdminSearch criteria usage:
AdminSearch order by options:
offset - starting offset in database - so that you can page through resultssize - size of the group that will be returned - the maximum number of records returnedKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertMiscItems(java.lang.String sessionId,
AdminMiscItem[] mItems)
throws KKAdminException
KKAdminIfinsertMiscItems in interface KKAdminIfsessionId - The session id of the logged in usermItems - An array of AdminMiscItem objects to insert.KKAdminException - an unexpected exception in the KonaKart Admin enginepublic void updateMiscItems(java.lang.String sessionId,
AdminMiscItem[] mItems)
throws KKAdminException
KKAdminIfupdateMiscItems in interface KKAdminIfsessionId - The session id of the logged in usermItems - An array of AdminMiscItem objects to update.KKAdminException - an unexpected exception in the KonaKart Admin enginepublic int copyProductToStore(java.lang.String sessionId,
int productId,
java.lang.String storeIdFrom,
java.lang.String storeIdTo,
AdminCopyProductOptions options)
throws KKAdminException
KKAdminIfcopyProductToStore in interface KKAdminIfsessionId - session Id of logged in Admin userproductId - The numeric id of the product to copystoreIdFrom - The id of the source storestoreIdTo - The id of the destination storeoptions - Options to configure the copy operationKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminProducts getProductsToSynchronize(java.lang.String sessionId, java.lang.String storeIdFrom, java.lang.String storeIdTo, AdminDataDescriptor dataDesc, int languageId, AdminSynchProductsOptions options, AdminProductMgrOptions mgrOptions) throws KKAdminException
KKAdminIfgetProductsToSynchronize in interface KKAdminIfsessionId - session Id of logged in Admin userstoreIdFrom - The id of the source storestoreIdTo - The id of the destination storedataDesc - Used to control the data offset, limit the number of items returned and set the
sort order. May be null.languageId - the language Id - or it could be
com.konakartadmin.bl.AdminLanguageMgr.DEFAULT_LANG to use the default languageoptions - Defines the type of search and constraints.mgrOptions - It defines whether to use prices and quantity for the catalog defined by the
catalogId. May be null.KKAdminException - an unexpected exception in the KonaKart Admin enginepublic java.lang.String getKonaKartAdminVersion()
throws KKAdminException
KKAdminIfgetKonaKartAdminVersion in interface KKAdminIfKKAdminException - an unexpected exception in the KonaKart Admin enginepublic boolean scaleImage(java.lang.String sessionId,
AdminScaleOptions scaleOptions)
throws KKAdminException
KKAdminIfscaleImage in interface KKAdminIfsessionId - Session Id of the user.scaleOptions - The scaling optionsKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void addImage(java.lang.String sessionId,
AdminImageOptions options)
throws KKAdminException
KKAdminIfWhen adding product images it uses the same conventions as used in the Admin Application and gets these definitions from the konakartadmin_gwt.properties file. Once an image is added to a product using this API the image will appear for the product in the Admin Application just as if it had been added via an image upload in the Admin application.
See AdminImageOptions for details on the options for adding images.
addImage in interface KKAdminIfsessionId - Session Id of the user.options - The options that define which object the image should be added toKKAdminException - an unexpected exception in the KonaKart Admin engine if the image was not added
successfullypublic void removeImage(java.lang.String sessionId,
AdminImageOptions options)
throws KKAdminException
KKAdminIf
See AdminImageOptions for details on the options for removing images.
removeImage in interface KKAdminIfsessionId - Session Id of the user.options - The options that define which images should be removedKKAdminException - an unexpected exception in the KonaKart Admin engine for any unexpected problemspublic AdminJobStatusResponse getJobStatus(java.lang.String sessionId, AdminJobStatusRequest jobStatusRequest) throws KKAdminException
KKAdminIfgetJobStatus in interface KKAdminIfsessionId - Session Id of the user.jobStatusRequest - Defines the jobs to retrieve information aboutKKAdminException - an unexpected exception in the KonaKart Admin enginepublic boolean insertProductCategory(java.lang.String sessionId,
int prodId,
int catId)
throws KKAdminException
KKAdminIfinsertProductCategory in interface KKAdminIfsessionId - The session Id of the logged in userprodId - Product IDcatId - Category IDKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertOrderRefund(java.lang.String sessionId,
AdminOrderRefund orderRefund)
throws KKAdminException
KKAdminIfinsertOrderRefund in interface KKAdminIfsessionId - The session id of the logged in userorderRefund - An AdminOrderRefund objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void editOrderRefund(java.lang.String sessionId,
AdminOrderRefund orderRefund)
throws KKAdminException
KKAdminIfeditOrderRefund in interface KKAdminIfsessionId - The session id of the logged in userorderRefund - AdminOrderRefund objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void deleteOrderRefund(java.lang.String sessionId,
int orderRefundId)
throws KKAdminException
KKAdminIfdeleteOrderRefund in interface KKAdminIfsessionId - The session id of the logged in userorderRefundId - The id of the AdminOrderRefund objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminOrderRefundSearchResult getOrderRefunds(java.lang.String sessionId, AdminOrderRefundSearch retSearch, int offset, int size) throws KKAdminException
KKAdminIfgetOrderRefunds in interface KKAdminIfsessionId - The session id of the logged in userretSearch - An object that defines the search parametersoffset - the offset in the databasesize - the number of records from the specified offsetKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertKKEvent(java.lang.String sessionId,
com.konakart.app.KKEvent event)
throws KKAdminException
KKAdminIfinsertKKEvent in interface KKAdminIfsessionId - The session id of the logged in userevent - a KKEvent objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic com.konakart.app.KKEvent[] getKKEvents(java.lang.String sessionId,
com.konakart.app.KKEventSearch search,
com.konakart.app.DataDescriptor desc)
throws KKAdminException
KKAdminIfgetKKEvents in interface KKAdminIfsessionId - The session id of the logged in usersearch - KKEventSearch search object that defines the records to deletedesc - the descKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void deleteKKEvents(java.lang.String sessionId,
com.konakart.app.KKEventSearch search)
throws KKAdminException
KKAdminIfdeleteKKEvents in interface KKAdminIfsessionId - The session id of the logged in usersearch - KKEventSearch search object that defines the records to deleteKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminShipperSearchResult getShippers(java.lang.String sessionId, AdminShipperSearch search) throws KKAdminException
KKAdminIfgetShippers in interface KKAdminIfsessionId - The session id of the logged in usersearch - the searchKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminShipper getShipper(java.lang.String sessionId, int shipperId) throws KKAdminException
KKAdminIfgetShipper in interface KKAdminIfsessionId - The session id of the logged in usershipperId - the shipperIdKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int deleteShipper(java.lang.String sessionId,
int shipperId)
throws KKAdminException
KKAdminIfdeleteShipper in interface KKAdminIfsessionId - The session id of the logged in usershipperId - The id of the AdminShipper object to be deletedKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertShipper(java.lang.String sessionId,
AdminShipper shipper)
throws KKAdminException
KKAdminIfinsertShipper in interface KKAdminIfsessionId - The session id of the logged in usershipper - The AdminShipper object being insertedKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int updateShipper(java.lang.String sessionId,
AdminShipper shipper)
throws KKAdminException
KKAdminIfupdateShipper in interface KKAdminIfsessionId - The session id of the logged in usershipper - The AdminShipper object being updatedKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertOrderShipment(java.lang.String sessionId,
AdminOrderShipment orderShipment)
throws KKAdminException
KKAdminIfinsertOrderShipment in interface KKAdminIfsessionId - The session id of the logged in userorderShipment - The OrderShipment object being insertedKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void editOrderShipment(java.lang.String sessionId,
AdminOrderShipment orderShipment)
throws KKAdminException
KKAdminIfeditOrderShipment in interface KKAdminIfsessionId - The session id of the logged in userorderShipment - The OrderShipment object being editedKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void deleteOrderShipment(java.lang.String sessionId,
int orderShipmentId)
throws KKAdminException
KKAdminIfdeleteOrderShipment in interface KKAdminIfsessionId - The session id of the logged in userorderShipmentId - The id of the OrderShipment object to be deletedKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminOrderShipmentSearchResult getOrderShipments(java.lang.String sessionId, AdminOrderShipmentSearch shipSearch, int offset, int size) throws KKAdminException
KKAdminIfgetOrderShipments in interface KKAdminIfsessionId - The session id of the logged in usershipSearch - the shipSearchoffset - the offset in the databasesize - the number of records from the specified offsetKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertMiscPrices(java.lang.String sessionId,
AdminMiscPrice[] miscPrices)
throws KKAdminException
KKAdminIfinsertMiscPrices in interface KKAdminIfsessionId - Session Id of the user.miscPrices - the prices to insertKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void deleteMiscPrices(java.lang.String sessionId,
AdminMiscPriceSearch miscPriceSearch)
throws KKAdminException
KKAdminIfdeleteMiscPrices in interface KKAdminIfsessionId - Session Id of the user.miscPriceSearch - defines the AdminMiscPrice records to deleteKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminMiscPrice[] getMiscPrices(java.lang.String sessionId, AdminMiscPriceSearch miscPriceSearch) throws KKAdminException
KKAdminIfgetMiscPrices in interface KKAdminIfsessionId - Session Id of the user.miscPriceSearch - defines the AdminMiscPrice records to retrieve from the databaseKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void updateMiscPrices(java.lang.String sessionId,
AdminMiscPrice[] miscPrices)
throws KKAdminException
KKAdminIfupdateMiscPrices in interface KKAdminIfsessionId - Session Id of the user.miscPrices - the prices to updateKKAdminException - an unexpected exception in the KonaKart Admin enginepublic java.lang.String getRMACode(java.lang.String sessionId,
int orderId)
throws KKAdminException
KKAdminIfgetRMACode in interface KKAdminIfsessionId - Session Id of the user.orderId - Id of the orderKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void removeProductFromCatalog(java.lang.String sessionId,
int productId,
java.lang.String catalogId)
throws KKAdminException
KKAdminIfremoveProductFromCatalog in interface KKAdminIfsessionId - Session Id of the user.productId - The numeric id of the product to be removedcatalogId - Id of the catalog from which the product prices and quantities will be removedKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminContentSearchResult getContents(java.lang.String sessionId, AdminContentSearch search, AdminDataDescriptor dataDesc) throws KKAdminException
KKAdminIfgetContents in interface KKAdminIfsessionId - Session Id of the user.search - an AdminContentSearch objectdataDesc - an AdminDataDescriptor objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminContent getContent(java.lang.String sessionId, int contentId) throws KKAdminException
KKAdminIfgetContent in interface KKAdminIfsessionId - Session Id of the user.contentId - the id of the ContentKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertContent(java.lang.String sessionId,
AdminContent content)
throws KKAdminException
KKAdminIfinsertContent in interface KKAdminIfsessionId - Session Id of the user.content - an AdminContent objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void deleteContent(java.lang.String sessionId,
int contentId)
throws KKAdminException
KKAdminIfdeleteContent in interface KKAdminIfsessionId - Session Id of the user.contentId - the contentId of the AdminContent record to deleteKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void updateContent(java.lang.String sessionId,
AdminContent content)
throws KKAdminException
KKAdminIfupdateContent in interface KKAdminIfsessionId - Session Id of the user.content - an AdminContent objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminContentTypeSearchResult getContentTypes(java.lang.String sessionId, AdminContentTypeSearch search, AdminDataDescriptor dataDesc) throws KKAdminException
KKAdminIfgetContentTypes in interface KKAdminIfsessionId - Session Id of the user.search - an AdminContentTypeSearch objectdataDesc - an AdminDataDescriptor object. You can set the order using one of:
KKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminContentType getContentType(java.lang.String sessionId, int contentTypeId) throws KKAdminException
KKAdminIfgetContentType in interface KKAdminIfsessionId - Session Id of the user.contentTypeId - the contentTypeId of the AdminContentTypeKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertContentType(java.lang.String sessionId,
AdminContentType contentType)
throws KKAdminException
KKAdminIfinsertContentType in interface KKAdminIfsessionId - Session Id of the user.contentType - an AdminContentType objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void deleteContentType(java.lang.String sessionId,
int contentTypeId)
throws KKAdminException
KKAdminIfdeleteContentType in interface KKAdminIfsessionId - Session Id of the user.contentTypeId - the contentTypeId of the AdminContentType record to deleteKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void updateContentType(java.lang.String sessionId,
AdminContentType content)
throws KKAdminException
KKAdminIfupdateContentType in interface KKAdminIfsessionId - Session Id of the user.content - an AdminContentType objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic java.lang.String getCouponCode(java.lang.String sessionId,
java.lang.String options)
throws KKAdminException
KKAdminIfgetCouponCode in interface KKAdminIfsessionId - Session Id of the user.options - Optional parameter that may be used to control how the coupon code is generatedKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void createMailingList(java.lang.String sessionId,
AdminCustomerSearch search,
AdminMailListOptions listOptions)
throws KKAdminException
KKAdminIfcreateMailingList in interface KKAdminIfsessionId - Session Id of the user.search - Customer search object - defines the set of customers to be included in the
mailing list to be createdlistOptions - Mailing List Options - defines options about the mailing list to be created such
as its format and its name.KKAdminException - an unexpected exception in the KonaKart Admin enginepublic void addCatalogRules(java.lang.String sessionId,
java.lang.String catalogId,
AdminCatalogRule[] rules)
throws KKAdminException
KKAdminIfcreateCatalogPricesFromRules() using the rules to make price
adjustments to products within selected categories and to include or exclude products from
selected categories.
For each category a rule allows you to:
addCatalogRules in interface KKAdminIfsessionId - Session Id of the user.catalogId - The alphanumeric catalog identifier to which the rules applyrules - An array of rulesKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminCatalogRule[] getCatalogRules(java.lang.String sessionId, java.lang.String catalogId) throws KKAdminException
KKAdminIfcreateCatalogPricesFromRules() to automatically create the catalog using the
rules to make price adjustments to products within selected categories and to include or
exclude products from selected categories.
For each category a rule allows you to:
getCatalogRules in interface KKAdminIfsessionId - Session Id of the user.catalogId - The alphanumeric catalog identifierKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminCreateCatalogPricesResult createCatalogPricesFromRules(java.lang.String sessionId, java.lang.String catalogId, AdminCreateCatalogPriceOptions options) throws KKAdminException
KKAdminIfaddCatalogRules() method. The rules are used to make price
adjustments to products within selected categories and to include or exclude products from
selected categories.createCatalogPricesFromRules in interface KKAdminIfsessionId - Session Id of the user.catalogId - Id of the catalogoptions - The options object allows you to configure the following functionality:
KKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminFilterSearchResult getFilters(java.lang.String sessionId, AdminFilterSearch search, AdminDataDescriptor dataDesc) throws KKAdminException
KKAdminIfgetFilters in interface KKAdminIfsessionId - Session Id of the user.search - an AdminFilterSearch objectdataDesc - an AdminDataDescriptor object
The returned filters may be sorted by:
KKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminFilter[] getFiltersForCustomer(java.lang.String sessionId, int custId) throws KKAdminException
KKAdminIfgetFiltersForCustomer in interface KKAdminIfsessionId - Session Id of the user.custId - an AdminFilterSearch objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminFilter getFilter(java.lang.String sessionId, int Id) throws KKAdminException
KKAdminIfgetFilter in interface KKAdminIfsessionId - Session Id of the user.Id - the id of the FilterKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertFilter(java.lang.String sessionId,
AdminFilter filter)
throws KKAdminException
KKAdminIfinsertFilter in interface KKAdminIfsessionId - Session Id of the user.filter - the AdminFilter record to insertKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void updateFilter(java.lang.String sessionId,
AdminFilter filter)
throws KKAdminException
KKAdminIfupdateFilter in interface KKAdminIfsessionId - Session Id of the user.filter - an AdminFilter objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void deleteFilter(java.lang.String sessionId,
int id)
throws KKAdminException
KKAdminIfdeleteFilter in interface KKAdminIfsessionId - Session Id of the user.id - the Id of the AdminFilter record to deleteKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void deleteFiltersForCustomer(java.lang.String sessionId,
int custId)
throws KKAdminException
KKAdminIfdeleteFiltersForCustomer in interface KKAdminIfsessionId - Session Id of the user.custId - the userId of the customer whose AdminFilter records to deleteKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void addChildrenToCustomer(java.lang.String sessionId,
int parentId,
AdminCustomer[] children)
throws KKAdminException
KKAdminIfaddChildrenToCustomer in interface KKAdminIfsessionId - Session Id of the user.parentId - ParentId set on the AdminCustomer children objects passed in as a parameterchildren - An array of AdminCustomer objectsKKAdminException - an unexpected exception in the KonaKart Admin enginepublic java.util.Calendar getStoreTime()
throws KKAdminException
KKAdminIfgetStoreTime in interface KKAdminIfKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertVendor(java.lang.String sessionId,
AdminVendor vendor)
throws KKAdminException
KKAdminIfinsertVendor in interface KKAdminIfsessionId - The session Id of the logged in uservendor - the vendorKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminVendorSearchResult getVendors(java.lang.String sessionId, AdminVendorSearch vendorSearch, int offset, int size) throws KKAdminException
KKAdminIfgetVendors in interface KKAdminIfsessionId - The session Id of the logged in uservendorSearch - The definition of the search for vendors - can be nulloffset - The offset in the databasesize - The number of records from the specified offsetKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void updateVendor(java.lang.String sessionId,
AdminVendor vendor)
throws KKAdminException
KKAdminIfupdateVendor in interface KKAdminIfsessionId - The session Id of the logged in uservendor - The vendorKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminVendor getVendorForId(java.lang.String sessionId, int vendorId) throws KKAdminException
KKAdminIfgetVendorForId in interface KKAdminIfsessionId - The session Id of the logged in uservendorId - the vendorIdKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void deleteVendor(java.lang.String sessionId,
int vendorId)
throws KKAdminException
KKAdminIfdeleteVendor in interface KKAdminIfsessionId - The session Id of the logged in uservendorId - the vendorIdKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminReviews getVendorReviews(java.lang.String sessionId, AdminDataDescriptor dataDesc, AdminReviewSearch revSearch) throws KKAdminException
KKAdminIfgetVendorReviews in interface KKAdminIfsessionId - The session Id of the logged in userdataDesc - Used to control the data offset, limit the number of items returned and set the
sort orderrevSearch - The search criteriaKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminReview getVendorReview(java.lang.String sessionId, int reviewId) throws KKAdminException
KKAdminIfgetVendorReview in interface KKAdminIfsessionId - The session Id of the logged in userreviewId - The numeric id of the AdminReview objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminReviews getReviewsPerVendor(java.lang.String sessionId, AdminDataDescriptor dataDesc, int vendorId) throws KKAdminException
KKAdminIfgetReviewsPerVendor in interface KKAdminIfsessionId - The session Id of the logged in userdataDesc - Used to control the data offset, limit the number of items returned and set the
sort ordervendorId - The numeric id of the vendorKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void addVendorToStore(java.lang.String sessionId,
int vendorId,
java.lang.String vendorStoreId)
throws KKAdminException
KKAdminIfvendorId of zero is accepted and represents the case where the store has no
associated vendor.addVendorToStore in interface KKAdminIfsessionId - The session Id of the logged in uservendorId - The numeric vendor idvendorStoreId - The store id for the VendorKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void insertCatalogPrices(java.lang.String sessionId,
AdminProductPrice[] prices,
AdminInsertCatalogPriceOptions options)
throws KKAdminException
KKAdminIfThe options object allows you:
singleTransaction attribute is set to true,
the prices are updated / inserted within a single database transaction and a rollback is
performed if an exception is caught. When false, the API call terminates as soon as an
exception is caught, but no rollback is performed. The default is false.insertKKEvent
attribute is set to true, a product update event is inserted for all products which have had
price changes. The event ensures that the product is removed from the cache in order to pick
up the new prices. The default is false.insertCatalogPrices in interface KKAdminIfsessionId - The session Id of the logged in userprices - An array of AdminProductPrice objectsoptions - Allows you to manage the transaction and events. May be left empty for default
behaviour.KKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminCloneCustomerResult cloneCustomer(java.lang.String sessionId, int cloneCustId, java.lang.String[] stores) throws KKAdminException
KKAdminIfPoints to note:
cloneCustomer in interface KKAdminIfsessionId - The session Id of the logged in user which must have Super User privileges.cloneCustId - The id of the customer to be clonedstores - An array of destination store ids where the customer will be clonedKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminDeleteCustomerResult deleteCustomerMultiStore(java.lang.String sessionId, int customerId, java.lang.String[] stores) throws KKAdminException
KKAdminIfIf the stores array contains the id of the KKAdmin Engine store, then the customer is also deleted from that store.
deleteCustomerMultiStore in interface KKAdminIfsessionId - The session Id of the logged in user which must have Super User privileges.customerId - The id of the customer to be deletedstores - An array of store ids where the customer will be deletedKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminStore[] getStoresForCustomer(java.lang.String sessionId, java.lang.String emailAddress) throws KKAdminException
KKAdminIfIt is used to search for a customer using the email address, across multiple stores. The stores where the customer is present, are returned in an array in alphabetical order. It searches all stores regardless of their state (enabled, under maintenance or deleted). This state information is available on the returned AdminStore objects.
getStoresForCustomer in interface KKAdminIfsessionId - The session Id of the logged in user which must have Super User privileges.emailAddress - The email address of the customer being searchedKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminSuggestionSearchResult getSuggestions(java.lang.String sessionId, AdminSuggestion _suggestion, AdminDataDescriptor dataDesc) throws KKAdminException
KKAdminIfThe suggestions that are retrieved are defined by the suggestion parameter. The where clause for the select will be created by using the values in the suggestion parameter.
getSuggestions in interface KKAdminIfsessionId - The session Id of the logged in user_suggestion - Used to define the searchdataDesc - data descriptor for defining generic search parameters such as size and offsetKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void insertSuggestions(java.lang.String sessionId,
AdminSuggestion[] suggestions)
throws KKAdminException
KKAdminIfFor Product Suggestion types the boughtProductId attribute must be set on the AdminSuggestion objects.
For Customer Suggestion types the customerId attribute must be set on the AdminSuggestion objects.
insertSuggestions in interface KKAdminIfsessionId - The session Id of the logged in usersuggestions - An array of AdminSuggestion objectsKKAdminException - an unexpected exception in the KonaKart Admin enginepublic void deleteSuggestions(java.lang.String sessionId,
AdminSuggestion suggestion)
throws KKAdminException
KKAdminIfdeleteSuggestions in interface KKAdminIfsessionId - The session Id of the logged in usersuggestion - An AdminSuggestion object that is used to specify the records to delete.KKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminOrderReturnStatusSearchResult getOrderReturnStatuses(AdminOrderReturnStatusSearch search) throws KKAdminException
KKAdminIfAdminOrderReturnStatusSearchResult object.getOrderReturnStatuses in interface KKAdminIfsearch - the search object that defines the search parameters and sort order. If
languageId is not set (or set to
AdminLanguageMgr.DEFAULT_LANG) the default language is used. If the
languageId is set to AdminLanguageMgr.ALL_LANGUAGES all
languages are returned.AdminOrderReturnStatusSearchResultKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int deleteOrderReturnStatus(java.lang.String sessionId,
int id)
throws KKAdminException
KKAdminIfdeleteOrderReturnStatus in interface KKAdminIfsessionId - The session Id of the logged in userid - An OrderStatus idKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertOrderReturnStatus(java.lang.String sessionId,
AdminOrderReturnStatus status)
throws KKAdminException
KKAdminIfinsertOrderReturnStatus in interface KKAdminIfsessionId - The session Id of the logged in userstatus - An OrderReturnStatus objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int insertOrderReturnStatuses(java.lang.String sessionId,
AdminOrderReturnStatus[] statuses)
throws KKAdminException
KKAdminIfinsertOrderReturnStatuses in interface KKAdminIfsessionId - The session Id of the logged in userstatuses - An array of AdminOrderReturnStatus objectsKKAdminException - an unexpected exception in the KonaKart Admin enginepublic int updateOrderReturnStatus(java.lang.String sessionId,
AdminOrderReturnStatus status)
throws KKAdminException
KKAdminIfupdateOrderReturnStatus in interface KKAdminIfsessionId - The session Id of the logged in userstatus - An OrderReturnStatus objectKKAdminException - an unexpected exception in the KonaKart Admin enginepublic AdminOrderReturnStatus[] getAllOrderReturnStatuses(int languageId) throws KKAdminException
KKAdminIfgetAllOrderReturnStatuses in interface KKAdminIflanguageId - the languageIdKKAdminException - an unexpected exception in the KonaKart Admin engineCopyright © 2018 DS Data Systems UK Ltd.