EngineConfigIf (KonaKart Server Engine API Documentation)

All Known Implementing Classes:

EngineConfig
```
public interface EngineConfigIf
```
Used to configure the KonaKart engine when instantiated

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAppPropertiesFileName()` The name of the properties file for the KonaKart application engine (can be just the name of a file on the classpath or a full file path).
`java.lang.String`	`getEngineId()` This is not designed to be set by developers.
`java.lang.String`	`getJaxwsClientPropertiesFileName()` The name of the properties file for the KonaKart JAXWS client (can be just the name of a file on the classpath or a full file path).
`int`	`getMode()` Used to configure the engine at startup.
`java.lang.String`	`getPropertiesFileName()` The name of the properties file for the KonaKart engine (can be just the name of a file on the classpath or a full file path).
`java.lang.String`	`getRmiClientPropertiesFileName()` The name of the properties file for the KonaKart RMI client (can be just the name of a file on the classpath or a full file path).
`java.lang.String`	`getStoreId()` Used in multi-store mode to configure the engine to use the correct store.
`boolean`	`isAppEngPortlet()` Used only by the AppEng.
`boolean`	`isCategoriesShared()` Only relevant when in MODE_MULTI_STORE_SHARED_DB mode and products are shared.
`boolean`	`isCustomersShared()` Only relevant when in MODE_MULTI_STORE_SHARED_DB mode.
`boolean`	`isProductsShared()` Only relevant when in MODE_MULTI_STORE_SHARED_DB mode.
`void`	`setAppEngPortlet(boolean appEngPortlet)` Used only by the AppEng.
`void`	`setAppPropertiesFileName(java.lang.String appPropertiesFileName)` The name of the properties file for the KonaKart application engine (can be just the name of a file on the classpath or a full file path).
`void`	`setCategoriesShared(boolean categoriesShared)` Only relevant when in MODE_MULTI_STORE_SHARED_DB mode and products are shared.
`void`	`setCustomersShared(boolean customersShared)` Only relevant when in MODE_MULTI_STORE_SHARED_DB mode.
`void`	`setEngineId(java.lang.String engineId)` This is not designed to be set by developers.
`void`	`setJaxwsClientPropertiesFileName(java.lang.String jaxwsClientPropertiesFileName)` The name of the properties file for the KonaKart JAXWS client (can be just the name of a file on the classpath or a full file path).
`void`	`setMode(int mode)` Used to configure the engine at startup.
`void`	`setProductsShared(boolean productsShared)` Only relevant when in MODE_MULTI_STORE_SHARED_DB mode.
`void`	`setPropertiesFileName(java.lang.String propertiesFileName)` The name of the properties file for the KonaKart engine (can be just the name of a file on the classpath or a full file path).
`void`	`setRmiClientPropertiesFileName(java.lang.String rmiClientPropertiesFileName)` The name of the properties file for the KonaKart RMI client (can be just the name of a file on the classpath or a full file path).
`void`	`setStoreId(java.lang.String storeId)` Used in multi-store mode to configure the engine to use the correct store.

- Method Detail
  - getStoreId
```
java.lang.String getStoreId()
```
    Used in multi-store mode to configure the engine to use the correct store.
    
    Returns:
    
    Returns the storeId.
  - setStoreId
```
void setStoreId(java.lang.String storeId)
```
    Used in multi-store mode to configure the engine to use the correct store.
    
    Parameters:
    
    storeId - The storeId to set.
  - getMode
```
int getMode()
```
    Used to configure the engine at startup. Valid values are:
    - EngineConfig.MODE_SINGLE_STORE
    - EngineConfig.MODE_MULTI_STORE_NON_SHARED_DB
    - EngineConfig.MODE_MULTI_STORE_SHARED_DB
    Returns:
    
    Returns the mode.
  - setMode
```
void setMode(int mode)
```
    Used to configure the engine at startup. Valid values are:
    - EngineConfig.MODE_SINGLE_STORE
    - EngineConfig.MODE_MULTI_STORE_NON_SHARED_DB
    - EngineConfig.MODE_MULTI_STORE_SHARED_DB
    Parameters:
    
    mode - The mode to set.
  - getPropertiesFileName
```
java.lang.String getPropertiesFileName()
```
    The name of the properties file for the KonaKart engine (can be just the name of a file on the classpath or a full file path). If set to null, the default properties file is used - konakart.properties.
    
    Returns:
    
    Returns the propertiesFileName.
  - setPropertiesFileName
```
void setPropertiesFileName(java.lang.String propertiesFileName)
```
    The name of the properties file for the KonaKart engine (can be just the name of a file on the classpath or a full file path). If set to null, the default properties file is used - konakart.properties.
    
    Parameters:
    
    propertiesFileName - The propertiesFileName to set.
  - getAppPropertiesFileName
```
java.lang.String getAppPropertiesFileName()
```
    The name of the properties file for the KonaKart application engine (can be just the name of a file on the classpath or a full file path). If set to null, the default properties file is used - konakart_app.properties.
    
    Returns:
    
    Returns the appPropertiesFileName.
  - setAppPropertiesFileName
```
void setAppPropertiesFileName(java.lang.String appPropertiesFileName)
```
    The name of the properties file for the KonaKart application engine (can be just the name of a file on the classpath or a full file path). If set to null, the default properties file is used - konakart_app.properties.
    
    Parameters:
    
    appPropertiesFileName - The appPropertiesFileName to set.
  - getJaxwsClientPropertiesFileName
```
java.lang.String getJaxwsClientPropertiesFileName()
```
    The name of the properties file for the KonaKart JAXWS client (can be just the name of a file on the classpath or a full file path). If set to null, the default properties file is used - konakart_jaxws_client.properties.
    
    Returns:
    
    the jaxwsClientPropertiesFileName
  - setJaxwsClientPropertiesFileName
```
void setJaxwsClientPropertiesFileName(java.lang.String jaxwsClientPropertiesFileName)
```
    The name of the properties file for the KonaKart JAXWS client (can be just the name of a file on the classpath or a full file path). If set to null, the default properties file is used - konakart_jaxws_client.properties.
    
    Parameters:
    
    jaxwsClientPropertiesFileName - the jaxwsClientPropertiesFileName to set
  - getRmiClientPropertiesFileName
```
java.lang.String getRmiClientPropertiesFileName()
```
    The name of the properties file for the KonaKart RMI client (can be just the name of a file on the classpath or a full file path). If set to null, the default properties file is used - konakart.properties.
    
    Returns:
    
    the rmiClientPropertiesFileName
  - setRmiClientPropertiesFileName
```
void setRmiClientPropertiesFileName(java.lang.String rmiClientPropertiesFileName)
```
    The name of the properties file for the KonaKart RMI client (can be just the name of a file on the classpath or a full file path). If set to null, the default properties file is used - konakart.properties.
    
    Parameters:
    
    rmiClientPropertiesFileName - the rmiClientPropertiesFileName to set
  - isCustomersShared
```
boolean isCustomersShared()
```
    Only relevant when in MODE_MULTI_STORE_SHARED_DB mode. If set to true, customers are shared between all stores. If we aren't in MODE_MULTI_STORE_SHARED_DB mode, it always returns false.
    
    Returns:
    
    Returns true or false
  - setCustomersShared
```
void setCustomersShared(boolean customersShared)
```
    Only relevant when in MODE_MULTI_STORE_SHARED_DB mode. If set to true, customers are shared between all stores.
    
    Parameters:
    
    customersShared - set to true or false
  - isProductsShared
```
boolean isProductsShared()
```
    Only relevant when in MODE_MULTI_STORE_SHARED_DB mode. If set to true, products can be shared between all stores.
    
    Returns:
    
    the productsShared
  - setProductsShared
```
void setProductsShared(boolean productsShared)
```
    Only relevant when in MODE_MULTI_STORE_SHARED_DB mode. If set to true, products can be shared between all stores.
    
    Parameters:
    
    productsShared - the productsShared to set
  - isCategoriesShared
```
boolean isCategoriesShared()
```
    Only relevant when in MODE_MULTI_STORE_SHARED_DB mode and products are shared. If set to true, categories can be shared between all stores.
    
    Returns:
    
    the categoriesShared
  - setCategoriesShared
```
void setCategoriesShared(boolean categoriesShared)
```
    Only relevant when in MODE_MULTI_STORE_SHARED_DB mode and products are shared. If set to true, categories can be shared between all stores.
    
    Parameters:
    
    categoriesShared - the categoriesShared to set
  - getEngineId
```
java.lang.String getEngineId()
```
    This is not designed to be set by developers. Consider it to be read only
    
    Returns:
    
    the engineId
  - setEngineId
```
void setEngineId(java.lang.String engineId)
```
    This is not designed to be set by developers. Consider it to be read only
    
    Parameters:
    
    engineId - the engineId to set
  - isAppEngPortlet
```
boolean isAppEngPortlet()
```
    Used only by the AppEng. It is set when the KonaKart storefront application is running as a portlet.
    
    Returns:
    
    the appEngPortlet
  - setAppEngPortlet
```
void setAppEngPortlet(boolean appEngPortlet)
```
    Used only by the AppEng. It is set when the KonaKart storefront application is running as a portlet.
    
    Parameters:
    
    appEngPortlet - the appEngPortlet to set

Interface EngineConfigIf

Method Summary

Method Detail

getStoreId

setStoreId

getMode

setMode

getPropertiesFileName

setPropertiesFileName

getAppPropertiesFileName

setAppPropertiesFileName

getJaxwsClientPropertiesFileName

setJaxwsClientPropertiesFileName

getRmiClientPropertiesFileName

setRmiClientPropertiesFileName

isCustomersShared

setCustomersShared

isProductsShared

setProductsShared

isCategoriesShared

setCategoriesShared

getEngineId

setEngineId

isAppEngPortlet

setAppEngPortlet