A B C D E F G I K L M N O P R S T U W Y Z

A

addAddressToCustomer(String, AddressIf) - Method in interface com.konakart.appif.KKEngIf

The Address object is added to the customer defined by the sessionId.

addProductNotificationToCustomer(String, int) - Method in interface com.konakart.appif.KKEngIf

Adds a product notification to the list of notifications for the customer.

AddressIf - Interface in com.konakart.appif

Used to contain the address of a customer.

addTax(BigDecimal, int, int, int) - Method in interface com.konakart.appif.KKEngIf

Calculates the final cost (including tax) for a product with a certain taxClassId and cost, delivered to a country (countryId) and zone (zoneId).

addToBasket(String, int, BasketIf) - Method in interface com.konakart.appif.KKEngIf

Saves the Basket object in the database for a customer.

AddToBasketOptionsIf - Interface in com.konakart.appif

An object used to contain options used when adding items to the basket.

addToBasketWithOptions(String, int, BasketIf, AddToBasketOptionsIf) - Method in interface com.konakart.appif.KKEngIf

If options is set to null, this method is identical to addToBasket().

Authorizenet - Class in com.konakart.bl.modules.payment.authorizenet

Authorize.Net module.

Authorizenet() - Constructor for class com.konakart.bl.modules.payment.authorizenet.Authorizenet

Constructor

B

BaseModule - Class in com.konakart.bl.modules

Base class for all modules.

BaseModule() - Constructor for class com.konakart.bl.modules.BaseModule

BaseOrderTotalModule - Class in com.konakart.bl.modules.ordertotal

BaseOrderTotalModule() - Constructor for class com.konakart.bl.modules.ordertotal.BaseOrderTotalModule

basePackage - Static variable in class com.konakart.bl.modules.BaseModule

Base package

BasePaymentModule - Class in com.konakart.bl.modules.payment

Base class for Payment Modules.

BasePaymentModule() - Constructor for class com.konakart.bl.modules.payment.BasePaymentModule

BaseShippingModule - Class in com.konakart.bl.modules.shipping

The Base class for shipping modules

BaseShippingModule() - Constructor for class com.konakart.bl.modules.shipping.BaseShippingModule

BasketIf - Interface in com.konakart.appif

One basket object corresponds to an item in the shopping cart.

C

CategoryIf - Interface in com.konakart.appif

Describes a category of products.

changeDeliveryAddress(String, OrderIf, AddressIf) - Method in interface com.konakart.appif.KKEngIf

The delivery address of the order is changed and the tax rates for the various products within the order are re-calculated.

changeOrderStatus(String, int, int, boolean, String) - Method in interface com.konakart.appif.KKEngIf

The state of the order referenced by the orderId parameter is changed, and an orders_status_history record is added to the order to keep track of the change.

changePassword(String, String, String) - Method in interface com.konakart.appif.KKEngIf

Ensures that the current password is correct, and then changes it to the new password.

checkForProducts(ShippingInfo) - Method in class com.konakart.bl.modules.shipping.BaseShippingModule

If there are no products it throws an exception since shipping isn't required.

checkSession(String) - Method in interface com.konakart.appif.KKEngIf

The given sessionId is checked to see whether it exists and whether it is has timed out.

checkZone(PaymentInfo, int) - Method in class com.konakart.bl.modules.payment.BasePaymentModule

Ensures that the zone is within one of the Geo Zones contained in the DeliveryInfo object.

checkZone(ShippingInfo, int) - Method in class com.konakart.bl.modules.shipping.BaseShippingModule

Ensures that the zone is within one of the Geo Zones contained in the ShippingInfo object.

Chronopay - Class in com.konakart.bl.modules.payment.chronopay

Chronopay IPN module

Chronopay() - Constructor for class com.konakart.bl.modules.payment.chronopay.Chronopay

Constructor

Cod - Class in com.konakart.bl.modules.payment.cod

Cash On Delivery Module.

Cod() - Constructor for class com.konakart.bl.modules.payment.cod.Cod

Constructor

com.konakart.appif - package com.konakart.appif

com.konakart.bl.modules - package com.konakart.bl.modules

com.konakart.bl.modules.ordertotal - package com.konakart.bl.modules.ordertotal

com.konakart.bl.modules.ordertotal.productdiscount - package com.konakart.bl.modules.ordertotal.productdiscount

com.konakart.bl.modules.ordertotal.shipping - package com.konakart.bl.modules.ordertotal.shipping

com.konakart.bl.modules.ordertotal.subtotal - package com.konakart.bl.modules.ordertotal.subtotal

com.konakart.bl.modules.ordertotal.tax - package com.konakart.bl.modules.ordertotal.tax

com.konakart.bl.modules.ordertotal.total - package com.konakart.bl.modules.ordertotal.total

com.konakart.bl.modules.ordertotal.totaldiscount - package com.konakart.bl.modules.ordertotal.totaldiscount

com.konakart.bl.modules.payment - package com.konakart.bl.modules.payment

com.konakart.bl.modules.payment.authorizenet - package com.konakart.bl.modules.payment.authorizenet

com.konakart.bl.modules.payment.chronopay - package com.konakart.bl.modules.payment.chronopay

com.konakart.bl.modules.payment.cod - package com.konakart.bl.modules.payment.cod

com.konakart.bl.modules.payment.epaybg - package com.konakart.bl.modules.payment.epaybg

com.konakart.bl.modules.payment.payjunction - package com.konakart.bl.modules.payment.payjunction

com.konakart.bl.modules.payment.paypal - package com.konakart.bl.modules.payment.paypal

com.konakart.bl.modules.payment.usaepay - package com.konakart.bl.modules.payment.usaepay

com.konakart.bl.modules.payment.worldpay - package com.konakart.bl.modules.payment.worldpay

com.konakart.bl.modules.payment.yourpay - package com.konakart.bl.modules.payment.yourpay

com.konakart.bl.modules.shipping - package com.konakart.bl.modules.shipping

com.konakart.bl.modules.shipping.digitaldownload - package com.konakart.bl.modules.shipping.digitaldownload

com.konakart.bl.modules.shipping.flat - package com.konakart.bl.modules.shipping.flat

com.konakart.bl.modules.shipping.free - package com.konakart.bl.modules.shipping.free

com.konakart.bl.modules.shipping.freeproduct - package com.konakart.bl.modules.shipping.freeproduct

com.konakart.bl.modules.shipping.item - package com.konakart.bl.modules.shipping.item

com.konakart.bl.modules.shipping.table - package com.konakart.bl.modules.shipping.table

com.konakart.bl.modules.shipping.ups - package com.konakart.bl.modules.shipping.ups

com.konakart.bl.modules.shipping.zones - package com.konakart.bl.modules.shipping.zones

CountryIf - Interface in com.konakart.appif

Describes a country for use within KonaKart.

CouponIf - Interface in com.konakart.appif

The Coupon class contains information about the coupon which can be used to activate promotions on an order.

createAndSaveOrder(String, String, CustomerRegistrationIf, BasketIf[], String, String, int) - Method in interface com.konakart.appif.KKEngIf

A high level call to simplify the process of creating a KonaKart order.

createOrder(String, BasketIf[], int) - Method in interface com.konakart.appif.KKEngIf

An order object is returned with all addresses populated with the default address of the customer referenced by sessionId.

CreateOrderOptionsIf - Interface in com.konakart.appif

An object used to contain options used when creating an order from an array of basket items.

createOrderWithOptions(String, BasketIf[], CreateOrderOptionsIf, int) - Method in interface com.konakart.appif.KKEngIf

If options is set to null, this method is identical to createOrder().

CurrencyIf - Interface in com.konakart.appif

Describes a currency for use within KonaKart.

custom(String, String) - Method in interface com.konakart.appif.KKEngIf

A custom interface that you have to provide an implementation for.

CustomerGroupIf - Interface in com.konakart.appif

Details of a KonaKart customer group.

CustomerIf - Interface in com.konakart.appif

Details of a KonaKart customer.

CustomerRegistrationIf - Interface in com.konakart.appif

Contains information required to register a customer.

Note the behaviour of the State field.

CustomerSearchIf - Interface in com.konakart.appif

Contains information required to search for a customer.

customSecure(String, String, String) - Method in interface com.konakart.appif.KKEngIf

A custom interface that you have to provide an implementation for.

D

DataDescriptorIf - Interface in com.konakart.appif

Contains information required to manage engine calls that return an array of data.

DbPortabilityIf - Interface in com.konakart.appif

For defining database-specific rules

deleteAddressFromCustomer(String, int) - Method in interface com.konakart.appif.KKEngIf

The address defined by the sessionId and addressId is deleted.

deleteOrderIdForSecretKey(String) - Method in interface com.konakart.appif.KKEngIf

The secret key is removed from the system.

deleteProductNotificationFromCustomer(String, int) - Method in interface com.konakart.appif.KKEngIf

Deletes a product notification from the list of notifications for the customer.

DigitalDownload - Class in com.konakart.bl.modules.shipping.digitaldownload

This shipping module returns an exception if the order contains any physical products (whether they have free shipping or not).

DigitalDownload() - Constructor for class com.konakart.bl.modules.shipping.digitaldownload.DigitalDownload

Constructor

DigitalDownloadIf - Interface in com.konakart.appif

The Digital Download class contains information about which customers are enabled to download products.

doesCustomerExistForEmail(String) - Method in interface com.konakart.appif.KKEngIf

Determine whether a customer has already registered with a certain eMail address as their user name.

E

editConfiguration(String, String) - Method in interface com.konakart.appif.KKEngIf

Edits an existing configuration.

editCustomer(String, CustomerIf) - Method in interface com.konakart.appif.KKEngIf

The Customer object will replace the existing customer object in the database.

editCustomerAddress(String, AddressIf) - Method in interface com.konakart.appif.KKEngIf

The Address object will replace the existing address object in the database with the same id.

Epaybg - Class in com.konakart.bl.modules.payment.epaybg

Epaybg IPN module

Epaybg() - Constructor for class com.konakart.bl.modules.payment.epaybg.Epaybg

Constructor

F

Flat - Class in com.konakart.bl.modules.shipping.flat

This shipping module implements a flat rate which is set in the configuration property MODULE_SHIPPING_FLAT_COST .

Flat() - Constructor for class com.konakart.bl.modules.shipping.flat.Flat

Constructor

forceRegisterCustomer(CustomerRegistrationIf) - Method in interface com.konakart.appif.KKEngIf

This API Call is used rather than registerCustomer() when you want to provide a store that doesn't force customer registration.

Free - Class in com.konakart.bl.modules.shipping.free

This shipping module implements a free rate regardless of zone.

Free() - Constructor for class com.konakart.bl.modules.shipping.free.Free

Constructor

FreeProduct - Class in com.konakart.bl.modules.shipping.freeproduct

This shipping module returns an exception if the order contains any physical products that require paid shipping so that the actual shipping cost is taken care of by another module.

FreeProduct() - Constructor for class com.konakart.bl.modules.shipping.freeproduct.FreeProduct

Constructor

G

GeoZoneIf - Interface in com.konakart.appif

Describes a tax zone.

getAccountCreated() - Method in interface com.konakart.appif.CustomerIf

When the account was created.

getAccountLastModified() - Method in interface com.konakart.appif.CustomerIf

getAddressCustom1() - Method in interface com.konakart.appif.CustomerRegistrationIf

getAddressCustom2() - Method in interface com.konakart.appif.CustomerRegistrationIf

getAddressCustom3() - Method in interface com.konakart.appif.CustomerRegistrationIf

getAddressCustom4() - Method in interface com.konakart.appif.CustomerRegistrationIf

getAddressCustom5() - Method in interface com.konakart.appif.CustomerRegistrationIf

getAddresses() - Method in interface com.konakart.appif.CustomerIf

An array containing all of the addresses defined for this customer.

getAddressesPerCustomer(String) - Method in interface com.konakart.appif.KKEngIf

Returns all of the addresses registered for the given customer.

getAddressFormatId() - Method in interface com.konakart.appif.AddressIf

getAddressFormatId() - Method in interface com.konakart.appif.CountryIf

An address format can be associated to a country so that the address of a customer can be formatted according to the rules of the country.

getAddressFormatTemplate() - Method in interface com.konakart.appif.AddressIf

An example template is $firstname $lastname$cr$streets$cr$city, $postcode$cr$statecomma$country'.

getAddressSummaryTemplate() - Method in interface com.konakart.appif.AddressIf

An example summary template is $city / $country'.

getAllCountries() - Method in interface com.konakart.appif.KKEngIf

Returns an array of Country objects for all of the countries in the system.

getAllCurrencies() - Method in interface com.konakart.appif.KKEngIf

Returns an array of currency objects for all the records in the currencies table.

getAllCustomerGroups(int) - Method in interface com.konakart.appif.KKEngIf

Returns an array of customer groups for all customer groups that have been defined in the system.

getAllLanguages() - Method in interface com.konakart.appif.KKEngIf

Returns an array of Language classes containing all of the languages that have been defined within the system.

getAllManufacturers() - Method in interface com.konakart.appif.KKEngIf

Returns an array of Manufacturer objects for all of the manufacturers in the system.

getAllProducts(String, DataDescriptorIf, int) - Method in interface com.konakart.appif.KKEngIf

Returns all products using the given language.

getAllReviews(DataDescriptorIf) - Method in interface com.konakart.appif.KKEngIf

An array of review objects is returned.

getAllSpecials(String, DataDescriptorIf, int) - Method in interface com.konakart.appif.KKEngIf

Returns all specials using the given language.

getAlsoPurchased(String, DataDescriptorIf, int, int) - Method in interface com.konakart.appif.KKEngIf

Find products that were in the same order as orders containing the product referenced by productId.

getApplicableProducts() - Method in interface com.konakart.appif.PromotionIf

Contains an array of OrderProduct objects to which the promotion can be applied.

getAverageRating() - Method in interface com.konakart.appif.ReviewIf

The average rating for a product based on all of its reviews.

getBasketItems() - Method in interface com.konakart.appif.CustomerIf

An array of basket items for this customer.

getBasketItemsPerCustomer(String, int, int) - Method in interface com.konakart.appif.KKEngIf

Get the basket items for a customer and language.

getBestSellers(DataDescriptorIf, int, int) - Method in interface com.konakart.appif.KKEngIf

Returns an array of bestseller products for the category referenced by categoryId and its children.

getBillingAddrFormatId() - Method in interface com.konakart.appif.OrderIf

The id of the address format template used to format the billing address.

getBillingAddrFormatTemplate() - Method in interface com.konakart.appif.OrderIf

The address format template for the billing address.

getBillingAddrId() - Method in interface com.konakart.appif.OrderIf

getBillingCity() - Method in interface com.konakart.appif.OrderIf

getBillingCompany() - Method in interface com.konakart.appif.OrderIf

getBillingCountry() - Method in interface com.konakart.appif.OrderIf

getBillingFormattedAddress() - Method in interface com.konakart.appif.OrderIf

The formatted billing address which has been formatted using the address format template.

getBillingName() - Method in interface com.konakart.appif.OrderIf

getBillingPostcode() - Method in interface com.konakart.appif.OrderIf

getBillingState() - Method in interface com.konakart.appif.OrderIf

getBillingStreetAddress() - Method in interface com.konakart.appif.OrderIf

getBillingSuburb() - Method in interface com.konakart.appif.OrderIf

getBirthDate() - Method in interface com.konakart.appif.CustomerIf

getBirthDate() - Method in interface com.konakart.appif.CustomerRegistrationIf

getBirthDate() - Method in interface com.konakart.appif.CustomerSearchIf

getBoxPadding() - Method in class com.konakart.bl.modules.shipping.ShippingInfo

getBoxWeight() - Method in class com.konakart.bl.modules.shipping.ShippingInfo

getBundledProdQuantity() - Method in interface com.konakart.appif.ProductIf

When products are returned from the API call getRelatedProducts() and the relationship is a bundle relationship, they will have this attribute instantiated to show the number of times that this product appears in the bundle

getCategoriesPerManufacturer(int, int) - Method in interface com.konakart.appif.KKEngIf

Returns an array of leaf Category objects for the given manufacturer.

getCategory(int, int) - Method in interface com.konakart.appif.KKEngIf

Returns a complete single Category object for the given categoryId and language.

getCategoryId() - Method in interface com.konakart.appif.ProductIf

getCategoryId() - Method in interface com.konakart.appif.ProductSearchIf

getCategoryRule() - Method in interface com.konakart.appif.PromotionIf

This is the rule linking categories to the promotion.

getCategoryTree(int, boolean) - Method in interface com.konakart.appif.KKEngIf

Returns a category tree structure consisting of an array of top level categories, each of which may contain an array of child categories.

getCcCVV() - Method in interface com.konakart.appif.PaymentDetailsIf

getCcExpires() - Method in interface com.konakart.appif.OrderIf

getCcExpiryMonth() - Method in interface com.konakart.appif.PaymentDetailsIf

getCcExpiryYear() - Method in interface com.konakart.appif.PaymentDetailsIf

getCcNumber() - Method in interface com.konakart.appif.OrderIf

getCcNumber() - Method in interface com.konakart.appif.PaymentDetailsIf

getCcOwner() - Method in interface com.konakart.appif.OrderIf

getCcOwner() - Method in interface com.konakart.appif.PaymentDetailsIf

getCcPostcode() - Method in interface com.konakart.appif.PaymentDetailsIf

getCcStreetAddress() - Method in interface com.konakart.appif.PaymentDetailsIf

getCcType() - Method in interface com.konakart.appif.OrderIf

getCcType() - Method in interface com.konakart.appif.PaymentDetailsIf

getChildren() - Method in interface com.konakart.appif.CategoryIf

getCity() - Method in interface com.konakart.appif.AddressIf

getCity() - Method in interface com.konakart.appif.CustomerRegistrationIf

getClassName() - Method in interface com.konakart.appif.OrderTotalIf

This is the name of the order total module.

getCode() - Method in interface com.konakart.appif.CurrencyIf

e.g.

getCode() - Method in interface com.konakart.appif.LanguageIf

Examples of the code are en, es, de etc.

getCode() - Method in interface com.konakart.appif.PaymentDetailsIf

The code of the payment gateway.

getCode() - Method in interface com.konakart.appif.ShippingQuoteIf

The code of the shipping module.

getCode() - Method in interface com.konakart.bl.modules.ordertotal.OrderTotalInterface

getCode() - Method in class com.konakart.bl.modules.ordertotal.productdiscount.ProductDiscount

getCode() - Method in class com.konakart.bl.modules.ordertotal.shipping.Shipping

getCode() - Method in class com.konakart.bl.modules.ordertotal.subtotal.Subtotal

getCode() - Method in class com.konakart.bl.modules.ordertotal.tax.Tax

getCode() - Method in class com.konakart.bl.modules.ordertotal.total.Total

getCode() - Method in class com.konakart.bl.modules.ordertotal.totaldiscount.TotalDiscount

getComments() - Method in interface com.konakart.appif.OrderStatusHistoryIf

Comments may be added to explain the status change.

getCompany() - Method in interface com.konakart.appif.AddressIf

getCompany() - Method in interface com.konakart.appif.CustomerRegistrationIf

getComparison() - Method in interface com.konakart.appif.ProductIf

The content of this attribute should be structured data such as xml so that it can be easily used to compare product features with other products.

getConfiguration(String) - Method in interface com.konakart.appif.KKEngIf

Returns a Configuration object referenced by the key passed in as a parameter

getConfigurations() - Method in interface com.konakart.appif.KKEngIf

Returns an array of Configuration objects containing all configurations that have been defined in the system.

getContentType() - Method in interface com.konakart.appif.ProductIf

Valid for digital products.

getCost() - Method in interface com.konakart.appif.ShippingQuoteIf

getCost() - Method in class com.konakart.bl.modules.shipping.WeightCost

getCountryId() - Method in interface com.konakart.appif.AddressIf

getCountryId() - Method in interface com.konakart.appif.CustomerRegistrationIf

getCountryName() - Method in interface com.konakart.appif.AddressIf

getCountryPerName(String) - Method in interface com.konakart.appif.KKEngIf

Returns the country object for the countryName, or null if the country doesn't exist in the DB.

getCoupon() - Method in interface com.konakart.appif.PromotionIf

There may be a coupon associated with the promotion.

getCouponCode() - Method in interface com.konakart.appif.CouponIf

The code of the coupon is the string used by a customer to activate it.

getCouponCode() - Method in interface com.konakart.appif.OrderIf

The coupon code used when checking out.

getCouponIds() - Method in interface com.konakart.appif.OrderIf

A comma separated list of coupon ids.

getCurrency(String) - Method in interface com.konakart.appif.KKEngIf

Returns the currency referenced by currencyCode.

getCurrency() - Method in interface com.konakart.appif.OrderIf

getCurrencyCode() - Method in interface com.konakart.appif.OrderIf

The three letter currency code.

getCurrencyValue() - Method in interface com.konakart.appif.OrderIf

The exchange rate for the currency.

getCurrMgr() - Method in class com.konakart.bl.modules.ordertotal.BaseOrderTotalModule

getCustom1() - Method in interface com.konakart.appif.AddressIf

getCustom1() - Method in interface com.konakart.appif.BasketIf

getCustom1() - Method in interface com.konakart.appif.CategoryIf

getCustom1() - Method in interface com.konakart.appif.CouponIf

getCustom1() - Method in interface com.konakart.appif.CustomerGroupIf

getCustom1() - Method in interface com.konakart.appif.CustomerIf

getCustom1() - Method in interface com.konakart.appif.DataDescriptorIf

If not null, it is used as a constraint.

getCustom1() - Method in interface com.konakart.appif.ManufacturerIf

getCustom1() - Method in interface com.konakart.appif.OrderIf

getCustom1() - Method in interface com.konakart.appif.OrderProductIf

getCustom1() - Method in interface com.konakart.appif.PaymentDetailsIf

getCustom1() - Method in interface com.konakart.appif.ProductIf

getCustom1() - Method in interface com.konakart.appif.PromotionIf

getCustom1() - Method in interface com.konakart.appif.ReviewIf

getCustom1() - Method in interface com.konakart.appif.ShippingQuoteIf

getCustom10() - Method in interface com.konakart.appif.PromotionIf

getCustom2() - Method in interface com.konakart.appif.AddressIf

getCustom2() - Method in interface com.konakart.appif.BasketIf

getCustom2() - Method in interface com.konakart.appif.CategoryIf

getCustom2() - Method in interface com.konakart.appif.CouponIf

getCustom2() - Method in interface com.konakart.appif.CustomerGroupIf

getCustom2() - Method in interface com.konakart.appif.CustomerIf

getCustom2() - Method in interface com.konakart.appif.DataDescriptorIf

If not null, it is used as a constraint.

getCustom2() - Method in interface com.konakart.appif.ManufacturerIf

getCustom2() - Method in interface com.konakart.appif.OrderIf

getCustom2() - Method in interface com.konakart.appif.OrderProductIf

getCustom2() - Method in interface com.konakart.appif.PaymentDetailsIf

getCustom2() - Method in interface com.konakart.appif.ProductIf

getCustom2() - Method in interface com.konakart.appif.PromotionIf

getCustom2() - Method in interface com.konakart.appif.ReviewIf

getCustom2() - Method in interface com.konakart.appif.ShippingQuoteIf

getCustom3() - Method in interface com.konakart.appif.AddressIf

getCustom3() - Method in interface com.konakart.appif.BasketIf

getCustom3() - Method in interface com.konakart.appif.CategoryIf

getCustom3() - Method in interface com.konakart.appif.CouponIf

getCustom3() - Method in interface com.konakart.appif.CustomerGroupIf

getCustom3() - Method in interface com.konakart.appif.CustomerIf

getCustom3() - Method in interface com.konakart.appif.DataDescriptorIf

If not null, it is used as a constraint.

getCustom3() - Method in interface com.konakart.appif.ManufacturerIf

getCustom3() - Method in interface com.konakart.appif.OrderIf

getCustom3() - Method in interface com.konakart.appif.OrderProductIf

getCustom3() - Method in interface com.konakart.appif.PaymentDetailsIf

getCustom3() - Method in interface com.konakart.appif.ProductIf

getCustom3() - Method in interface com.konakart.appif.PromotionIf

getCustom3() - Method in interface com.konakart.appif.ReviewIf

getCustom3() - Method in interface com.konakart.appif.ShippingQuoteIf

getCustom4() - Method in interface com.konakart.appif.AddressIf

getCustom4() - Method in interface com.konakart.appif.BasketIf

getCustom4() - Method in interface com.konakart.appif.CouponIf

getCustom4() - Method in interface com.konakart.appif.CustomerGroupIf

getCustom4() - Method in interface com.konakart.appif.CustomerIf

getCustom4() - Method in interface com.konakart.appif.DataDescriptorIf

If not null, it is used as a constraint.

getCustom4() - Method in interface com.konakart.appif.ManufacturerIf

getCustom4() - Method in interface com.konakart.appif.OrderIf

getCustom4() - Method in interface com.konakart.appif.OrderProductIf

getCustom4() - Method in interface com.konakart.appif.PaymentDetailsIf

getCustom4() - Method in interface com.konakart.appif.ProductIf

getCustom4() - Method in interface com.konakart.appif.PromotionIf

getCustom4() - Method in interface com.konakart.appif.ShippingQuoteIf

getCustom5() - Method in interface com.konakart.appif.AddressIf

getCustom5() - Method in interface com.konakart.appif.BasketIf

getCustom5() - Method in interface com.konakart.appif.CouponIf

getCustom5() - Method in interface com.konakart.appif.CustomerGroupIf

getCustom5() - Method in interface com.konakart.appif.CustomerIf

getCustom5() - Method in interface com.konakart.appif.DataDescriptorIf

If not null, it is used as a constraint.

getCustom5() - Method in interface com.konakart.appif.ManufacturerIf

getCustom5() - Method in interface com.konakart.appif.OrderIf

getCustom5() - Method in interface com.konakart.appif.OrderProductIf

getCustom5() - Method in interface com.konakart.appif.PaymentDetailsIf

getCustom5() - Method in interface com.konakart.appif.ProductIf

getCustom5() - Method in interface com.konakart.appif.PromotionIf

getCustom5() - Method in interface com.konakart.appif.ShippingQuoteIf

getCustom6() - Method in interface com.konakart.appif.PromotionIf

getCustom7() - Method in interface com.konakart.appif.PromotionIf

getCustom8() - Method in interface com.konakart.appif.PromotionIf

getCustom9() - Method in interface com.konakart.appif.PromotionIf

getCustomBigDecimal(String, int) - Method in class com.konakart.bl.modules.ordertotal.BaseOrderTotalModule

Utility method that gets a BigDecimal from one of the promotion custom attributes

getCustomBoolean(String, int) - Method in class com.konakart.bl.modules.ordertotal.BaseOrderTotalModule

Utility method that gets a boolean from one of the promotion custom attributes

getCustomer(String) - Method in interface com.konakart.appif.KKEngIf

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

getCustomerAddrFormatId() - Method in interface com.konakart.appif.OrderIf

The id of the address format template used to format the customer address.

getCustomerAddrFormatTemplate() - Method in interface com.konakart.appif.OrderIf

The address format template for the customer address.

getCustomerAddrId() - Method in interface com.konakart.appif.OrderIf

getCustomerCity() - Method in interface com.konakart.appif.OrderIf

getCustomerCompany() - Method in interface com.konakart.appif.OrderIf

getCustomerCountry() - Method in interface com.konakart.appif.OrderIf

getCustomerCustom1() - Method in interface com.konakart.appif.CustomerRegistrationIf

getCustomerCustom2() - Method in interface com.konakart.appif.CustomerRegistrationIf

getCustomerCustom3() - Method in interface com.konakart.appif.CustomerRegistrationIf

getCustomerCustom4() - Method in interface com.konakart.appif.CustomerRegistrationIf

getCustomerCustom5() - Method in interface com.konakart.appif.CustomerRegistrationIf

getCustomerEmail() - Method in interface com.konakart.appif.OrderIf

getCustomerFormattedAddress() - Method in interface com.konakart.appif.OrderIf

The formatted customer address which has been formatted using the address format template.

getCustomerGroup() - Method in interface com.konakart.appif.CustomerIf

The Customer Group to which the customer belongs.

getCustomerGroup(int, int) - Method in interface com.konakart.appif.KKEngIf

Returns a customer group object for the customerGroupId passed in as a parameter.

getCustomerGroupRule() - Method in interface com.konakart.appif.PromotionIf

This is the rule linking customer groups to the promotion.

getCustomerId() - Method in interface com.konakart.appif.AddressIf

getCustomerId() - Method in interface com.konakart.appif.DigitalDownloadIf

getCustomerId() - Method in interface com.konakart.appif.IpnHistoryIf

getCustomerId() - Method in interface com.konakart.appif.OrderIf

getCustomerId() - Method in interface com.konakart.appif.ReviewIf

getCustomerName() - Method in interface com.konakart.appif.OrderIf

getCustomerName() - Method in interface com.konakart.appif.ReviewIf

getCustomerPostcode() - Method in interface com.konakart.appif.OrderIf

getCustomerRule() - Method in interface com.konakart.appif.PromotionIf

This is the rule linking customers to the promotion.

getCustomerState() - Method in interface com.konakart.appif.OrderIf

getCustomerStreetAddress() - Method in interface com.konakart.appif.OrderIf

getCustomerSuburb() - Method in interface com.konakart.appif.OrderIf

getCustomerTelephone() - Method in interface com.konakart.appif.OrderIf

getCustomInt(String, int) - Method in class com.konakart.bl.modules.ordertotal.BaseOrderTotalModule

Utility method that gets an int from one of the promotion custom attributes

getCustomString(String, int) - Method in class com.konakart.bl.modules.ordertotal.BaseOrderTotalModule

Utility method that gets a String from one of the promotion custom attributes.

getDateAdded() - Method in interface com.konakart.appif.BasketIf

getDateAdded() - Method in interface com.konakart.appif.CouponIf

getDateAdded() - Method in interface com.konakart.appif.DigitalDownloadIf

getDateAdded() - Method in interface com.konakart.appif.GeoZoneIf

getDateAdded() - Method in interface com.konakart.appif.IpnHistoryIf

getDateAdded() - Method in interface com.konakart.appif.OrderStatusHistoryIf

getDateAdded() - Method in interface com.konakart.appif.ProductIf

getDateAdded() - Method in interface com.konakart.appif.PromotionIf

getDateAdded() - Method in interface com.konakart.appif.ReviewIf

getDateAdded() - Method in interface com.konakart.appif.TaxClassIf

getDateAddedFrom() - Method in interface com.konakart.appif.ProductSearchIf

getDateAddedTo() - Method in interface com.konakart.appif.ProductSearchIf

getDateAvailable() - Method in interface com.konakart.appif.ProductIf

getDateFinished() - Method in interface com.konakart.appif.OrderIf

getDatePurchased() - Method in interface com.konakart.appif.OrderIf

The date that the order was saved.

getDecimalPlaces() - Method in interface com.konakart.appif.CurrencyIf

getDecimalPoint() - Method in interface com.konakart.appif.CurrencyIf

The character use to represent a decimal point.

getDefaultAddr() - Method in interface com.konakart.appif.CustomerIf

getDefaultAddressPerCustomer(String) - Method in interface com.konakart.appif.KKEngIf

Returns the default address for the given customer.

getDefaultAddrId() - Method in interface com.konakart.appif.CustomerIf

Identifies the default address for this customer.

getDefaultCurrency() - Method in interface com.konakart.appif.KKEngIf

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

getDefaultCustomer() - Method in interface com.konakart.appif.KKEngIf

Returns the customer object for the default customer.

getDefaultLanguage() - Method in interface com.konakart.appif.KKEngIf

The default language is referenced by a configuration variable called DEFAULT_LANGUAGE.

getDeliveryAddrFormatId() - Method in interface com.konakart.appif.OrderIf

The id of the address format template used to format the delivery address.

getDeliveryAddrFormatTemplate() - Method in interface com.konakart.appif.OrderIf

The address format template for the delivery address.

getDeliveryAddrId() - Method in interface com.konakart.appif.OrderIf

getDeliveryCity() - Method in interface com.konakart.appif.OrderIf

getDeliveryCompany() - Method in interface com.konakart.appif.OrderIf

getDeliveryCountry() - Method in interface com.konakart.appif.OrderIf

getDeliveryCountry() - Method in class com.konakart.bl.modules.shipping.ShippingInfo

getDeliveryCountryObject() - Method in interface com.konakart.appif.OrderIf

getDeliveryFormattedAddress() - Method in interface com.konakart.appif.OrderIf

The formatted delivery address which has been formatted using the address format template.

getDeliveryGeoZoneArray() - Method in class com.konakart.bl.modules.payment.PaymentInfo

getDeliveryGeoZoneArray() - Method in class com.konakart.bl.modules.shipping.ShippingInfo

getDeliveryName() - Method in interface com.konakart.appif.OrderIf

getDeliveryPostcode() - Method in interface com.konakart.appif.OrderIf

getDeliveryState() - Method in interface com.konakart.appif.OrderIf

getDeliveryStreetAddress() - Method in interface com.konakart.appif.OrderIf

getDeliverySuburb() - Method in interface com.konakart.appif.OrderIf

getDeliveryZone() - Method in class com.konakart.bl.modules.shipping.ShippingInfo

getDeliveryZoneObject() - Method in interface com.konakart.appif.OrderIf

getDescription() - Method in interface com.konakart.appif.CouponIf

getDescription() - Method in interface com.konakart.appif.CustomerGroupIf

getDescription() - Method in interface com.konakart.appif.PaymentDetailsIf

The payment gateway description to put on the UI so that it can be selected.

getDescription() - Method in interface com.konakart.appif.ProductIf

getDescription() - Method in interface com.konakart.appif.PromotionIf

A description of the promotion.

getDescription() - Method in interface com.konakart.appif.ShippingQuoteIf

The shipping module description to put on the UI so that it can be selected.

getDescription() - Method in interface com.konakart.appif.TagGroupIf

getDescription() - Method in interface com.konakart.appif.TaxRateIf

The description of the tax rate.

getDigitalDownloads(String) - Method in interface com.konakart.appif.KKEngIf

Returns an array of Digital Download objects for the customer identified by the sessionId parameter.
If the DD_DELETE_ON_EXPIRATION configuration variable is set to "true", then the objects read from the database that have expired, are automatically deleted.

getDirectory() - Method in interface com.konakart.appif.LanguageIf

Examples of the directory are english, german, espanol etc.

getDiscountOrderTotalFromList(Order, List<OrderTotal>) - Method in class com.konakart.bl.modules.ordertotal.BaseOrderTotalModule

This is a helper method for the discount modules.

getEmailAddr() - Method in interface com.konakart.appif.CustomerIf

getEmailAddr() - Method in interface com.konakart.appif.CustomerRegistrationIf

This is the user name to log into KonaKart.

getEmailAddr() - Method in interface com.konakart.appif.CustomerSearchIf

getEncodedOptionValues() - Method in interface com.konakart.appif.ProductIf

When products are returned from the API call getRelatedProducts() and the relationship is a bundle relationship, they will have this attribute instantiated if the product in the bundle is configured with one or more options.
encodedOptionValues 3{5}4{1} means product_options of id==3 and product_options_values of id==5 followed by product_options of id==4 and product_options_values of id==1.

getEncodedOptionValues() - Method in interface com.konakart.appif.ProductQuantityIf

encodedOptionValues: {4}3{3}6 which means product_options of id==4 and product_options_values of id==3 followed by product_options of id==3 and product_options_values of id==6.

getEncodedProduct() - Method in interface com.konakart.appif.BasketIf

The encodedProduct is in the form 1{3}5{4}1 where the first number is the product id.

getEndDate() - Method in interface com.konakart.appif.PromotionIf

After this date the promotion is no longer active.

getExpirationDate() - Method in interface com.konakart.appif.DigitalDownloadIf

The date at which the download expires and the link will be removed from the UI.

getFaxNumber() - Method in interface com.konakart.appif.CustomerIf

getFaxNumber() - Method in interface com.konakart.appif.CustomerRegistrationIf

getFilePath() - Method in interface com.konakart.appif.ProductIf

Valid for digital products.

getFinalPriceExTax() - Method in interface com.konakart.appif.BasketIf

This is the price without including tax.

getFinalPriceExTax() - Method in interface com.konakart.appif.OrderProductIf

getFinalPriceIncTax() - Method in interface com.konakart.appif.BasketIf

This is the price including tax.

getFinalPriceIncTax() - Method in interface com.konakart.appif.OrderProductIf

getFirstName() - Method in interface com.konakart.appif.AddressIf

getFirstName() - Method in interface com.konakart.appif.CustomerIf

getFirstName() - Method in interface com.konakart.appif.CustomerRegistrationIf

getFirstName() - Method in interface com.konakart.appif.CustomerSearchIf

getFormattedAddress() - Method in interface com.konakart.appif.AddressIf

It is formatted based on the address format template.

getFreeShippingOver() - Method in interface com.konakart.appif.ShippingQuoteIf

The value for freeShippingOver is set in a configuration variable.

getGatewayFullResponse() - Method in interface com.konakart.appif.IpnHistoryIf

The full response received by the payment gateway.

getGatewayResult() - Method in interface com.konakart.appif.IpnHistoryIf

The result string returned by the payment gateway (i.e.

getGatewayTransactionId() - Method in interface com.konakart.appif.IpnHistoryIf

The transaction id returned by the payment gateway

getGender() - Method in interface com.konakart.appif.AddressIf

getGender() - Method in interface com.konakart.appif.CustomerIf

Normally set to "m" or "f" .

getGender() - Method in interface com.konakart.appif.CustomerRegistrationIf

Normally set to "m" or "f".

getGeoZoneDescription() - Method in interface com.konakart.appif.GeoZoneIf

e.g.

getGeoZoneId() - Method in interface com.konakart.appif.GeoZoneIf

getGeoZoneName() - Method in interface com.konakart.appif.GeoZoneIf

e.g.

getGlobalProdNotifier() - Method in interface com.konakart.appif.CustomerIf

If set to 1, the customer is notified of all product updates.

getGroupId() - Method in interface com.konakart.appif.CustomerIf

If negative, the customer belongs to no groups.

getGroupId() - Method in interface com.konakart.appif.CustomerRegistrationIf

If negative, the customer belongs to no groups.

getHandlingCost() - Method in interface com.konakart.appif.ShippingQuoteIf

getHostAndPort() - Method in class com.konakart.bl.modules.payment.PaymentInfo

getIcon() - Method in interface com.konakart.appif.ShippingQuoteIf

getId() - Method in interface com.konakart.appif.AddressIf

getId() - Method in interface com.konakart.appif.BasketIf

getId() - Method in interface com.konakart.appif.CategoryIf

getId() - Method in interface com.konakart.appif.CountryIf

getId() - Method in interface com.konakart.appif.CouponIf

getId() - Method in interface com.konakart.appif.CurrencyIf

getId() - Method in interface com.konakart.appif.CustomerGroupIf

getId() - Method in interface com.konakart.appif.CustomerIf

getId() - Method in interface com.konakart.appif.CustomerSearchIf

getId() - Method in interface com.konakart.appif.IpnHistoryIf

Id

getId() - Method in interface com.konakart.appif.KKConfigurationIf

getId() - Method in interface com.konakart.appif.LanguageIf

getId() - Method in interface com.konakart.appif.ManufacturerIf

getId() - Method in interface com.konakart.appif.OptionIf

The id of the record in the products_options table.

getId() - Method in interface com.konakart.appif.OrderIf

getId() - Method in interface com.konakart.appif.OrderProductIf

getId() - Method in interface com.konakart.appif.OrderStatusHistoryIf

getId() - Method in interface com.konakart.appif.OrderStatusIf

getId() - Method in interface com.konakart.appif.OrderTotalIf

getId() - Method in interface com.konakart.appif.ProductIf

getId() - Method in interface com.konakart.appif.PromotionIf

getId() - Method in interface com.konakart.appif.ReviewIf

getId() - Method in interface com.konakart.appif.TagGroupIf

getId() - Method in interface com.konakart.appif.TagIf

getId() - Method in interface com.konakart.appif.TaxRateIf

getImage() - Method in interface com.konakart.appif.CategoryIf

getImage() - Method in interface com.konakart.appif.LanguageIf

Normally a flag of the country where the language is spoken, stored in the directory of images specific to this language.

getImage() - Method in interface com.konakart.appif.ManufacturerIf

getImage() - Method in interface com.konakart.appif.ProductIf

getImage2() - Method in interface com.konakart.appif.ProductIf

getImage3() - Method in interface com.konakart.appif.ProductIf

getImage4() - Method in interface com.konakart.appif.ProductIf

getInvisible() - Method in interface com.konakart.appif.ProductIf

When set to '1' the product is invisible and will not be returned from normal API calls.

getIsoCode2() - Method in interface com.konakart.appif.CountryIf

Two letter ISO code.

getIsoCode3() - Method in interface com.konakart.appif.CountryIf

Three letter ISO code.

getIsPrimary() - Method in interface com.konakart.appif.AddressIf

getKey() - Method in interface com.konakart.appif.KKConfigurationIf

This identifies the configuration parameter.

getKonakartResultDescription() - Method in interface com.konakart.appif.IpnHistoryIf

A description of the KonaKart result.

getKonakartResultId() - Method in interface com.konakart.appif.IpnHistoryIf

A KonaKart result.

getKonakartTimeStamp() - Method in interface com.konakart.appif.KKEngIf

Get a Date Time Stamp from the server

getLanguageId() - Method in interface com.konakart.appif.OrderStatusIf

getLanguageId() - Method in interface com.konakart.appif.ReviewIf

getLanguageId() - Method in interface com.konakart.appif.TagGroupIf

getLanguageId() - Method in interface com.konakart.appif.TagIf

getLanguageName() - Method in interface com.konakart.appif.ReviewIf

getLanguagePerCode(String) - Method in interface com.konakart.appif.KKEngIf

Retrieves the language object referenced by the two letter code (i.e.

getLanguagePerId(int) - Method in interface com.konakart.appif.KKEngIf

Retrieves the language object referenced by the id.

getLastClick() - Method in interface com.konakart.appif.ManufacturerIf

The last time that the url link was clicked.

getLastLogon() - Method in interface com.konakart.appif.CustomerIf

getLastModified() - Method in interface com.konakart.appif.CouponIf

getLastModified() - Method in interface com.konakart.appif.DigitalDownloadIf

getLastModified() - Method in interface com.konakart.appif.GeoZoneIf

getLastModified() - Method in interface com.konakart.appif.KKConfigurationIf

getLastModified() - Method in interface com.konakart.appif.