com.konakart.appif
Interface EngineConfigIf

All Known Implementing Classes:

EngineConfig

public interface EngineConfigIf

Used to configure the KonaKart engine when instantiated

Method Summary

java.lang.String	getAppPropertiesFileName() The name of the properties file for the KonaKart application engine which must be on the classpath.
java.lang.String	getEngineId() This is not designed to be set by developers.
int	getMode() Used to configure the engine at startup.
java.lang.String	getPropertiesFileName() The name of the properties file for the KonaKart engine which must be on the classpath.
java.lang.String	getStoreId() Used in multi-store mode to configure the engine to use the correct store.
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	setAppPropertiesFileName(java.lang.String appPropertiesFileName) The name of the properties file for the KonaKart application engine which must be on the classpath.
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	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 which must be on the classpath.
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 which must be on the classpath. 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 which must be on the classpath. 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 which must be on the classpath. 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 which must be on the classpath. If set to null, the default properties file is used - konakart_app.properties.

Parameters:

appPropertiesFileName - The appPropertiesFileName 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

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