com.konakart.rmi.app
Class S_EngineConfig

java.lang.Object
  com.konakart.rmi.app.S_EngineConfig

All Implemented Interfaces:

java.io.Serializable

public class S_EngineConfig
extends java.lang.Object
implements java.io.Serializable

Used to configure the KonaKart engine when instantiated

See Also:

Serialized Form

Constructor Summary

S_EngineConfig()

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	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	setAppPropertiesFileName(java.lang.String _appPropertiesFileName) The name of the properties file for the KonaKart application engine which must be on the classpath.
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	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.

Methods inherited from class java.lang.Object

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

Constructor Detail

S_EngineConfig

public S_EngineConfig()

Method Detail

getStoreId

public java.lang.String getStoreId()

Used in multi-store mode to configure the engine to use the correct store.

Returns:

Returns the storeId.

setStoreId

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public java.lang.String getEngineId()

This is not designed to be set by developers. Consider it to be read only

Returns:

the engineId

setEngineId

public 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