AdminModulesMgrIf (KonaKartAdmin API Documentation)

All Known Implementing Classes:

AdminModulesMgr
```
public interface AdminModulesMgrIf
```
AdminModulesMgrIf

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`com.konakart.app.NameValue[]`	`callPaymentModule(java.lang.String moduleClassName, com.konakart.app.PaymentOptions options)` This method is used to call a payment module from the Admin App.
`void`	`fetchModules()` Initialise the modules - regardless of the setting of initDone
`KKModule[]`	`getModules(int moduleType)` Returns an array of Module objects for the module type specified
`int`	`getNumOrderTotalModules()` Returns the number of Order Total modules that can be set up
`int`	`getNumOtherModules()` Returns the number of Other modules that can be set up
`int`	`getNumPaymentModules()` Returns the number of payment modules that can be set up
`int`	`getNumShippingModules()` Returns the number of shipping modules that can be set up
`OrderTotalModule[]`	`getOrderTotalModules()` Returns an array of Order Total Modules
`OtherModule[]`	`getOtherModules()` Returns an array of Other Modules
`PaymentModule[]`	`getPaymentModules()` Returns an array of payment modules
`ShippingModuleInterface`	`getShippingModuleByCode(java.lang.String code)` Get a ShippingModuleInterface with the specified code
`ShippingModule[]`	`getShippingModules()` Returns an array of Shipping Modules
`void`	`init()` Initialise the modules - if not already initialised
`void`	`refreshConfigs()` Refresh the configuration of the Admin Currency Manager
`void`	`setNumOrderTotalModules(int numOrderTotalModules)` Set the number of modules that can be set up
`void`	`setNumOtherModules(int numOtherModules)` Set the number of Other modules that can be set up
`void`	`setNumPaymentModules(int numberPaymentModules)` Set the number of modules that can be set up
`void`	`setNumShippingModules(int numShippingModules)` Set the number of modules that can be set up
`void`	`setOrderTotalModules(OrderTotalModule[] orderTotalModules)` *Sets an array of Order Total modules
`void`	`setOtherModules(OtherModule[] otherModules)` Sets an array of Other modules
`void`	`setPaymentModules(PaymentModule[] paymentModules)` Sets an array of payment modules
`void`	`setShippingModules(ShippingModule[] shippingModules)` Sets an array of Shipping modules

- Method Detail
  - init
```
void init()
   throws KKAdminException
```
    Initialise the modules - if not already initialised
    
    Throws:
    
    KKAdminException - an unexpected exception in the KonaKart Admin engine
  - fetchModules
```
void fetchModules()
           throws KKAdminException
```
    Initialise the modules - regardless of the setting of initDone
    
    Throws:
    
    KKAdminException - an unexpected exception in the KonaKart Admin engine
  - getModules
```
KKModule[] getModules(int moduleType)
               throws com.konakart.app.KKException,
                      KKAdminException
```
    Returns an array of Module objects for the module type specified
    
    Parameters:
    
    moduleType - the module type
    
    Returns:
    
    Array of Module objects
    
    Throws:
    
    com.konakart.app.KKException - an unexpected KKException exception
    
    KKAdminException - an unexpected exception in the KonaKart Admin engine
  - getPaymentModules
```
PaymentModule[] getPaymentModules()
```
    Returns an array of payment modules
    
    Returns:
    
    the paymentModules
  - setPaymentModules
```
void setPaymentModules(PaymentModule[] paymentModules)
```
    Sets an array of payment modules
    
    Parameters:
    
    paymentModules - the paymentModules to set
  - getOrderTotalModules
```
OrderTotalModule[] getOrderTotalModules()
```
    Returns an array of Order Total Modules
    
    Returns:
    
    the orderTotalModules
  - setOrderTotalModules
```
void setOrderTotalModules(OrderTotalModule[] orderTotalModules)
```
    *Sets an array of Order Total modules
    
    Parameters:
    
    orderTotalModules - the orderTotalModules to set
  - getShippingModules
```
ShippingModule[] getShippingModules()
```
    Returns an array of Shipping Modules
    
    Returns:
    
    the shippingModules
  - setShippingModules
```
void setShippingModules(ShippingModule[] shippingModules)
```
    Sets an array of Shipping modules
    
    Parameters:
    
    shippingModules - the shippingModules to set
  - getOtherModules
```
OtherModule[] getOtherModules()
```
    Returns an array of Other Modules
    
    Returns:
    
    the OtherModules
  - setOtherModules
```
void setOtherModules(OtherModule[] otherModules)
```
    Sets an array of Other modules
    
    Parameters:
    
    otherModules - the otherModules to set
  - getNumPaymentModules
```
int getNumPaymentModules()
```
    Returns the number of payment modules that can be set up
    
    Returns:
    
    Returns the number of payment modules that can be set up
  - setNumPaymentModules
```
void setNumPaymentModules(int numberPaymentModules)
```
    Set the number of modules that can be set up
    
    Parameters:
    
    numberPaymentModules - set the number of modules that can be set up
  - getNumOrderTotalModules
```
int getNumOrderTotalModules()
```
    Returns the number of Order Total modules that can be set up
    
    Returns:
    
    the numOrderTotalModules
  - setNumOrderTotalModules
```
void setNumOrderTotalModules(int numOrderTotalModules)
```
    Set the number of modules that can be set up
    
    Parameters:
    
    numOrderTotalModules - the numOrderTotalModules to set
  - getNumShippingModules
```
int getNumShippingModules()
```
    Returns the number of shipping modules that can be set up
    
    Returns:
    
    the numShippingModules
  - setNumShippingModules
```
void setNumShippingModules(int numShippingModules)
```
    Set the number of modules that can be set up
    
    Parameters:
    
    numShippingModules - the numShippingModules to set
  - getNumOtherModules
```
int getNumOtherModules()
```
    Returns the number of Other modules that can be set up
    
    Returns:
    
    the numOtherModules
  - setNumOtherModules
```
void setNumOtherModules(int numOtherModules)
```
    Set the number of Other modules that can be set up
    
    Parameters:
    
    numOtherModules - the numOtherModules
  - getShippingModuleByCode
```
ShippingModuleInterface getShippingModuleByCode(java.lang.String code)
```
    Get a ShippingModuleInterface with the specified code
    
    Parameters:
    
    code - the code for the Shipping Module
    
    Returns:
    
    the ShippingModule or null if it isn't found
  - refreshConfigs
```
void refreshConfigs()
             throws java.lang.Exception
```
    Refresh the configuration of the Admin Currency Manager
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - callPaymentModule
```
com.konakart.app.NameValue[] callPaymentModule(java.lang.String moduleClassName,
                                               com.konakart.app.PaymentOptions options)
                                        throws java.lang.Exception
```
    This method is used to call a payment module from the Admin App. The payment module which must implement the com.konakartadmin.modules.AdminPaymentIf interface, is instantiated and the execute method is called.
    
    Parameters:
    
    moduleClassName - The full class name such as com.konakartadmin.modules.payment.authorizenet.AdminPayment
    
    options - An object containing all of the parameters required for the transaction
    
    Returns:
    
    Returns an array of name value pairs
    
    Throws:
    
    java.lang.Exception - an unexpected exception

Interface AdminModulesMgrIf

Method Summary

Method Detail

init

fetchModules

getModules

getPaymentModules

setPaymentModules

getOrderTotalModules

setOrderTotalModules

getShippingModules

setShippingModules

getOtherModules

setOtherModules

getNumPaymentModules

setNumPaymentModules

getNumOrderTotalModules

setNumOrderTotalModules

getNumShippingModules

setNumShippingModules

getNumOtherModules

setNumOtherModules

getShippingModuleByCode

refreshConfigs

callPaymentModule