com.konakart.blif

Interface StoreMgrIf

All Known Implementing Classes:

StoreMgr

public interface StoreMgrIf

Manages all business logic relevant to the management of Stores for the Application Engine

Method Summary

Modifier and Type	Method and Description
boolean	doesStoreExist(java.lang.String storeId) Return true if the store exists.
java.lang.String[]	getActiveStores() Get a list of the active stores from the database.
Address[]	getAddressesPerStore(java.lang.String storeId) Returns all of the addresses for the given store.
Store	getStore() Returns the store that this KonaKart engine is connected to.
Store	getStoreForId(java.lang.String storeId) Returns the store referenced by the storeId parameter.
java.lang.String[]	getStores() Get a list of stores from the database
Store	getStoreStatusById(java.lang.String storeId, boolean forceRefresh) Return the status elements of the Store object from the database with the specified storeId.

Method Detail

doesStoreExist

boolean doesStoreExist(java.lang.String storeId)
                throws org.apache.torque.TorqueException

Return true if the store exists.

Parameters:

storeId - store id

Returns:

True if the zone exists

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

getStores

java.lang.String[] getStores()
                      throws org.apache.torque.TorqueException,
                             com.workingdogs.village.DataSetException

Get a list of stores from the database

Returns:

True if the zone exists

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

getActiveStores

java.lang.String[] getActiveStores()
                            throws org.apache.torque.TorqueException,
                                   com.workingdogs.village.DataSetException

Get a list of the active stores from the database. Active stores are enabled stores not under maintenance or deleted.

Returns:

an array of Store names - from 0 to n elements - ordered by storeId

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

getStoreStatusById

Store getStoreStatusById(java.lang.String storeId,
                         boolean forceRefresh)
                  throws com.konakart.app.KKException

Return the status elements of the Store object from the database with the specified storeId. Since this method is called on every API call, to improve performance the status is cached and refreshed after a programmable number of seconds. A forced refresh of the cache occurs if forceRefresh is set to true.

Parameters:

storeId - the storeId of the Store object to retrieve.

forceRefresh - When set, the cached data is refreshed from the database

Returns:

a partly-filled Store object or null if the store isn't found

Throws:

com.konakart.app.KKException - an unexpected KKException exception

getStore

Store getStore()
        throws com.konakart.app.KKException,
               org.apache.torque.TorqueException,
               com.workingdogs.village.DataSetException

Returns the store that this KonaKart engine is connected to.

Returns:

Returns a Store object or null if the store isn't found

Throws:

com.konakart.app.KKException - an unexpected KKException exception

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

getStoreForId

Store getStoreForId(java.lang.String storeId)
             throws java.lang.Exception

Returns the store referenced by the storeId parameter. It can only be called when in multi-vendor mode which assumes there is a single DB and products are shared.

Parameters:

storeId - the storeId

Returns:

Returns a Store object or null if the store isn't found

Throws:

java.lang.Exception - an unexpected exception

getAddressesPerStore

Address[] getAddressesPerStore(java.lang.String storeId)
                        throws java.lang.Exception

Returns all of the addresses for the given store. Returns an empty array if the storeId parameter is set to null or no addresses exist.

Parameters:

storeId - the storeId

Returns:

An array of address objects

Throws:

java.lang.Exception - an unexpected exception