com.konakartadmin.modules

Class OtherModule

java.lang.Object

com.konakartadmin.modules.Module

com.konakartadmin.modules.OtherModule

All Implemented Interfaces:

ModuleInterface, OtherModuleInterface

Direct Known Subclasses:

Captcha, Ldap, USPSAddrVal

public class OtherModule
extends Module
implements OtherModuleInterface

Implements the OtherModule interface

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	classPrefix

Fields inherited from class com.konakartadmin.modules.Module

configKeyStub, configs, implementationFileName, installed, keys, log

Fields inherited from interface com.konakartadmin.modules.ModuleInterface

MODULE_SUB_TYPE_PROMOTION, MODULE_TYPE_ORDER_TOTAL, MODULE_TYPE_OTHER, MODULE_TYPE_PAYMENT, MODULE_TYPE_SHIPPING

Constructor Summary

Constructors

Constructor and Description
OtherModule() Constructor

Method Summary

Modifier and Type	Method and Description
java.lang.String	execute(KKAdminIf adminEng, java.lang.String sessionId, java.lang.String custom1, java.lang.String custom2) Execute a function implemented by the "Other" module.
java.lang.String	getClassPrefix()
java.lang.String	getConfigKeyStub()
int	getModuleType()
java.lang.String	toString()

Methods inherited from class com.konakartadmin.modules.Module

getConfigs, getImplementationFileName, getKeys, getKonakartTimeStampDate, getModuleCode, getModuleSubType, getModuleTitle, getMsgs, init, install, installed, remove, setConfigKeyStub, setConfigs, setImplementationFileName, setInstalled, setKeys, setMsgs

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.konakartadmin.modules.ModuleInterface

getConfigs, getImplementationFileName, getKeys, getModuleCode, getModuleSubType, getModuleTitle, init, install, installed, remove, setConfigKeyStub, setInstalled

Field Detail

classPrefix

private static java.lang.String classPrefix

Constructor Detail

OtherModule

public OtherModule()

Constructor

Method Detail

getClassPrefix

public java.lang.String getClassPrefix()

Specified by:

getClassPrefix in interface ModuleInterface

Overrides:

getClassPrefix in class Module

Returns:

the class prefix

getModuleType

public int getModuleType()

Specified by:

getModuleType in interface ModuleInterface

Overrides:

getModuleType in class Module

Returns:

the module type

getConfigKeyStub

public java.lang.String getConfigKeyStub()

Specified by:

getConfigKeyStub in interface ModuleInterface

Overrides:

getConfigKeyStub in class Module

Returns:

the config key stub

execute

public java.lang.String execute(KKAdminIf adminEng,
                                java.lang.String sessionId,
                                java.lang.String custom1,
                                java.lang.String custom2)
                         throws KKAdminException

Description copied from interface: OtherModuleInterface

Execute a function implemented by the "Other" module.

Specified by:

execute in interface OtherModuleInterface

Parameters:

adminEng - A KKAdmin engine

sessionId - the sessionId of a logged in user

custom1 - custom parameter for custom usage

custom2 - custom parameter for custom usage

Returns:

a String object to indicate the result

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

toString

public java.lang.String toString()

Specified by:

toString in interface ModuleInterface

Overrides:

toString in class java.lang.Object

Returns:

a string representing the module - for diagnostics