com.konakartadmin.modules

Interface ModuleInterface

All Known Subinterfaces:

OrderTotalModuleInterface, OtherModuleInterface, PaymentModuleInterface, ShippingModuleInterface

All Known Implementing Classes:

BankTransfer, BarclaycardSmartPayApi, BarclaycardSmartPayHosted, Bluepay, BuyXGetYFree, Caledon, Captcha, Cod, CommideaVanguard, CustomerCard, CyberSourceSA, DigitalDownload, Elink, Eway_au, ExternalTax, Fedex, Flat, Free, FreeProduct, FreeProduct, GiftCertificate, GlobalCollect, Item, Ldap, Module, MoneyBookers, Netpayintl, OrderTotalModule, OtherModule, PayflowPro, Payjunction, PaymentCharge, PaymentModule, Paypal, PickUpInStore, ProductDiscount, ProductRewardPoints, RedeemPoints, RewardPoints, Shipping, ShippingDiscount, ShippingModule, SubTotal, Table, Tax, TaxCloud, Total, TotalDiscount, TotalDiscountAdmin, Ups, Usaepay, Usps, USPSAddrVal, Uspsint, Worldpay, WorldPayXMLRedirect, Zones

public interface ModuleInterface

All Konakart Admin modules must implement the ModuleInterface

Field Summary

Fields

Modifier and Type	Field and Description
static int	MODULE_SUB_TYPE_PROMOTION Order Total sub-type module constant
static int	MODULE_TYPE_ORDER_TOTAL Order Total type module constant
static int	MODULE_TYPE_OTHER Other module type constant
static int	MODULE_TYPE_PAYMENT Payment type module constant
static int	MODULE_TYPE_SHIPPING Shipping type module constant

Method Summary

Modifier and Type	Method and Description
java.lang.String	getClassPrefix()
java.lang.String	getConfigKeyStub()
KKConfiguration[]	getConfigs()
java.lang.String	getImplementationFileName()
java.lang.String[]	getKeys()
java.lang.String	getModuleCode()
int	getModuleSubType()
java.lang.String	getModuleTitle()
int	getModuleType()
void	init(java.lang.String moduleName) Initialise the module
void	install() Install the module
boolean	installed() Is the module currently installed?
void	remove() Remove the module
void	setConfigKeyStub(java.lang.String configKeyStub)
void	setInstalled(boolean installed) Set the module installation status
java.lang.String	toString()

Field Detail

MODULE_TYPE_PAYMENT

static final int MODULE_TYPE_PAYMENT

Payment type module constant

See Also:

Constant Field Values

MODULE_TYPE_SHIPPING

static final int MODULE_TYPE_SHIPPING

Shipping type module constant

See Also:

Constant Field Values

MODULE_TYPE_ORDER_TOTAL

static final int MODULE_TYPE_ORDER_TOTAL

Order Total type module constant

See Also:

Constant Field Values

MODULE_TYPE_OTHER

static final int MODULE_TYPE_OTHER

Other module type constant

See Also:

Constant Field Values

MODULE_SUB_TYPE_PROMOTION

static final int MODULE_SUB_TYPE_PROMOTION

Order Total sub-type module constant

See Also:

Constant Field Values

Method Detail

init

void init(java.lang.String moduleName)

Initialise the module

Parameters:

moduleName - the module's ClassName (only the final part, not including the package)

getModuleType

int getModuleType()

Returns:

the module type

getModuleSubType

int getModuleSubType()

Returns:

the module sub type

getModuleCode

java.lang.String getModuleCode()

Returns:

the module code

getClassPrefix

java.lang.String getClassPrefix()

Returns:

the class prefix

getConfigKeyStub

java.lang.String getConfigKeyStub()

Returns:

the config key stub

setConfigKeyStub

void setConfigKeyStub(java.lang.String configKeyStub)

Parameters:

configKeyStub - set this config key stub

installed

boolean installed()
           throws com.konakart.app.KKException

Is the module currently installed?

Returns:

true if the module is currently installed

Throws:

com.konakart.app.KKException - if something unexpected happens with the database

setInstalled

void setInstalled(boolean installed)

Set the module installation status

Parameters:

installed - set to true if the module is currently installed

install

void install()
      throws com.konakart.app.KKException

Install the module

Throws:

com.konakart.app.KKException - if something unexpected happens with the database

getConfigs

KKConfiguration[] getConfigs()

Returns:

an array of configuration values for this module

remove

void remove()
     throws com.konakart.app.KKException

Remove the module

Throws:

com.konakart.app.KKException - if something unexpected happens with the database

getKeys

java.lang.String[] getKeys()
                    throws com.konakart.app.KKException

Returns:

the module's keys - the configuration_key values

Throws:

com.konakart.app.KKException - an unexpected KKException exception

getImplementationFileName

java.lang.String getImplementationFileName()

Returns:

the module's implementation file name

getModuleTitle

java.lang.String getModuleTitle()

Returns:

the module's title - the friendly name for the user

toString

java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

a string representing the module - for diagnostics