com.konakartadmin.blif

Interface AdminStoreMgrIf

All Known Implementing Classes:

AdminCommunityStoreMgr, AdminStoreMgr

public interface AdminStoreMgrIf

AdminStoreMgrIf

Method Summary

Modifier and Type	Method and Description
void	cloneStore(AdminNewStoreOptions options, java.lang.String storeToCloneId, AdminStore newStore, int userId) Insert a new store into the mall by cloning a specified store.
void	deleteStoreDB(java.lang.String storeId) Delete a Store from the Database.
boolean	doesStoreExistDB(java.lang.String storeId) Return true if the store exists.
com.konakart.db.KKCriteria	getNewCriteria() Gets a new KKCriteria object from the super class ten takes off the storeId as we never want to add a where storeId= constraint when looking up these stores.
AdminStore	getStoreDBById(java.lang.String storeId) Return the AdminStore object from the database with the specified storeId
AdminStore[]	getStores(org.apache.commons.configuration2.Configuration kkConfig) Get the stores supported by the server.
AdminStore[]	getStores(java.lang.String configFile) Get the stores supported by the server.
AdminStoreSearchResult	getStoresDB(AdminStoreSearch search, int offset, int size) Return the AdminStore objects defined by the search criteria.
AdminStore	getStoreStatusById(java.lang.String storeId) Return the status elements of the AdminStore object from the database with the specified storeId
java.lang.String	insertStore(AdminStore insertObj, int userId) Insert an AdminStore object
void	removeStoreDB(java.lang.String storeId) Delete a Store from the Database - this doesn't just mark the store as deleted (that's what deleteStoreDB does) but it removes all the records for this store from the database.
void	updateStoreDB(AdminStore updateObj) Update an AdminStore object

Method Detail

getStores

AdminStore[] getStores(java.lang.String configFile)
                throws KKAdminException

Get the stores supported by the server.

Parameters:

configFile - the name of the properties file

Returns:

an array of AdminStore objects

Throws:

KKAdminException - thrown when there are problems reading the properties file

getStores

AdminStore[] getStores(org.apache.commons.configuration2.Configuration kkConfig)
                throws KKAdminException

Get the stores supported by the server. This version uses a KonaKart Configuration that has already been read rather than read a new one every time.

Parameters:

kkConfig - A configuration that has already been read

Returns:

an array of AdminStore objects

Throws:

KKAdminException - an unexpected KKAdminException exception

getStoresDB

AdminStoreSearchResult getStoresDB(AdminStoreSearch search,
                                   int offset,
                                   int size)
                            throws KKAdminException

Return the AdminStore objects defined by the search criteria.

Parameters:

search - the generic Admin search object that defines the AdminStore objects to search for. If null we use the default AdminSearch object.

offset - starting offset in database - so that you can page through results

size - size of the group that will be returned - the maximum number of records returned. If this is set to -1 (KonakartAdminConstants.NOT_SET) no limit is imposed.

Returns:

an AdminStoreSearchResult object

Throws:

KKAdminException - an unexpected KKAdminException exception

getStoreStatusById

AdminStore getStoreStatusById(java.lang.String storeId)
                       throws KKAdminException

Return the status elements of the AdminStore object from the database with the specified storeId

Parameters:

storeId - the storeId of the AdminStore object to retrieve.

Returns:

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

Throws:

KKAdminException - an unexpected KKAdminException exception

getStoreDBById

AdminStore getStoreDBById(java.lang.String storeId)
                   throws KKAdminException

Return the AdminStore object from the database with the specified storeId

Parameters:

storeId - the storeId of the AdminStore object to retrieve.

Returns:

an AdminStore object or null if the store isn't found

Throws:

KKAdminException - an unexpected KKAdminException exception

deleteStoreDB

void deleteStoreDB(java.lang.String storeId)
            throws KKAdminException

Delete a Store from the Database. This just marks the store as "Deleted" but doesn't delete the records from the database.

Parameters:

storeId - A Store id

Throws:

KKAdminException - an unexpected KKAdminException exception

removeStoreDB

void removeStoreDB(java.lang.String storeId)
            throws KKAdminException

Delete a Store from the Database - this doesn't just mark the store as deleted (that's what deleteStoreDB does) but it removes all the records for this store from the database.

Parameters:

storeId - A Store id

Throws:

KKAdminException - an unexpected KKAdminException exception

doesStoreExistDB

boolean doesStoreExistDB(java.lang.String storeId)
                  throws KKAdminException,
                         org.apache.torque.TorqueException

Return true if the store exists.

Parameters:

storeId - store id

Returns:

True if the zone exists

Throws:

KKAdminException - an unexpected KKAdminException exception

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

insertStore

java.lang.String insertStore(AdminStore insertObj,
                             int userId)
                      throws org.apache.torque.TorqueException,
                             KKAdminException,
                             java.lang.Exception

Insert an AdminStore object

Parameters:

insertObj - An AdminStore object

userId - the user inserting the store

Returns:

returns the id of the inserted AdminStore object

Throws:

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

KKAdminException - an unexpected KKAdminException exception

java.lang.Exception - an unexpected exception

cloneStore

void cloneStore(AdminNewStoreOptions options,
                java.lang.String storeToCloneId,
                AdminStore newStore,
                int userId)
         throws KKAdminException,
                org.apache.torque.TorqueException,
                java.lang.Exception

Insert a new store into the mall by cloning a specified store. Multi-Store Single DB only

Parameters:

options - Some options for defining how to execute the clone

storeToCloneId - the store the will be cloned to make the new store

newStore - the new store

userId - the user inserting the store

Throws:

java.lang.Exception - an unexpected exception

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

KKAdminException - an unexpected KKAdminException exception

updateStoreDB

void updateStoreDB(AdminStore updateObj)
            throws KKAdminException

Update an AdminStore object

Parameters:

updateObj - An AdminStore object

Throws:

KKAdminException - an unexpected KKAdminException exception

getNewCriteria

com.konakart.db.KKCriteria getNewCriteria()

Gets a new KKCriteria object from the super class ten takes off the storeId as we never want to add a where storeId= constraint when looking up these stores.

Returns:

Returns a new KKCriteria object