com.konakart.blif

Interface ManufacturerMgrIf

All Known Implementing Classes:

ManufacturerMgr, ManufacturerMgrWond

public interface ManufacturerMgrIf

ManufacturerMgrIf Interface which an implementation of this manager must adhere to.

Method Summary

Modifier and Type	Method and Description
Address[]	getAddressesPerManufacturer(int manufacturerId) Gets an array of Address objects that have been defined for the manufacturer referenced by the manufacturerId.
Manufacturer[]	getAllManufacturers() Returns an array of all manufacturers
Manufacturer	getManufacturer(int manufacturerId, int languageId) Gets the manufacturer referenced by the manufacturer id
Manufacturer	getManufacturerByShopId(int shopId) Gets the manufacturer referenced by the shop id
Manufacturer	getManufacturerByWondId(java.lang.String shopId) Gets the manufacturer referenced by the Wond-Shop id
Manufacturer	getManufacturerPerProduct(int productId, int languageId) Returns an array of manufacturers for a product
Manufacturer[]	getManufacturers(DataDescriptorIf dataDesc, ManufacturerSearchIf search, int languageId) Returns an array of Manufacturer objects that match the specified search criteria in the ManufacturerSearch object.
Manufacturer[]	getManufacturersFromIds(java.util.ArrayList<java.lang.Integer> manuIdList) Return an array of manufacturers for the ids passed in through the manuIdList parameter.
Manufacturer[]	getManufacturersPerCategory(int categoryId) Returns an array of manufacturers for a category
void	UpdateManufacturerViewedCount(int manufacturerId, int languageId) Whenever a user clicks on a manufacturer to view the home page, we update the click count and the date of the last click.

Method Detail

getManufacturers

Manufacturer[] getManufacturers(DataDescriptorIf dataDesc,
                                ManufacturerSearchIf search,
                                int languageId)
                         throws java.lang.Exception

Returns an array of Manufacturer objects that match the specified search criteria in the ManufacturerSearch object. It allows you to search for:

• Manufacturers with a specific name
• A manufacturer by id
• The manufacturer of a product from the product id
• The manufacturers for all products within a category, from the category id

dataDesc controls the following functionality:

• The maximum number of Manufacturer objects returned.
• The offset which defaults to zero. This is useful when there are many Manufacturer objects, in order to return them using multiple calls to this method.
• Criteria on the custom attributes. If a custom attribute is set then only manufacturers with a matching custom attribute value are returned.
• The Manufacturers may be sorted by :
  • com.konakart.app.DataDescConstants.ORDER_BY_NAME_ASCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_NAME_DESCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM1_ASCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM1_DESCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM2_ASCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM2_DE@Override SCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM3_ASCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM3_DESCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM4_ASCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM4_DESCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM5_ASCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM5_DESCENDING

Parameters:

dataDesc - The data descriptor object that defines the sort order, constraints on custom fields and offset and limit for paging.

search - The Manufacturer search object that defines the search criteria

languageId - The language id is used for language specific attributes of the manufacturer such as the URL.

Returns:

Array of Manufacturer objects which may be null.

Throws:

java.lang.Exception - an unexpected exception

getAllManufacturers

Manufacturer[] getAllManufacturers()
                            throws java.lang.Exception

Returns an array of all manufacturers

Returns:

An array of all manufacturers

Throws:

java.lang.Exception - an unexpected exception

getManufacturersPerCategory

Manufacturer[] getManufacturersPerCategory(int categoryId)
                                    throws java.lang.Exception

Returns an array of manufacturers for a category

Parameters:

categoryId - the categoryId

Returns:

An array of manufacturers for this category

Throws:

java.lang.Exception - an unexpected exception

getManufacturerPerProduct

Manufacturer getManufacturerPerProduct(int productId,
                                       int languageId)
                                throws java.lang.Exception

Returns an array of manufacturers for a product

Parameters:

productId - the productId

languageId - the languageId

Returns:

An array of manufacturers for this product

Throws:

java.lang.Exception - an unexpected exception

getManufacturer

Manufacturer getManufacturer(int manufacturerId,
                             int languageId)
                      throws java.lang.Exception

Gets the manufacturer referenced by the manufacturer id

Parameters:

manufacturerId - the manufacturerId

languageId - the languageId

Returns:

The details of a manufacturer

Throws:

java.lang.Exception - an unexpected exception

UpdateManufacturerViewedCount

void UpdateManufacturerViewedCount(int manufacturerId,
                                   int languageId)
                            throws java.lang.Exception

Whenever a user clicks on a manufacturer to view the home page, we update the click count and the date of the last click.

Parameters:

manufacturerId - the manufacturerId

languageId - the languageId

Throws:

java.lang.Exception - an unexpected exception

getAddressesPerManufacturer

Address[] getAddressesPerManufacturer(int manufacturerId)
                               throws java.lang.Exception

Gets an array of Address objects that have been defined for the manufacturer referenced by the manufacturerId.

Parameters:

manufacturerId - the manufacturerId

Returns:

Returns an array of Address objects

Throws:

java.lang.Exception - an unexpected exception

getManufacturersFromIds

Manufacturer[] getManufacturersFromIds(java.util.ArrayList<java.lang.Integer> manuIdList)
                                throws java.lang.Exception

Return an array of manufacturers for the ids passed in through the manuIdList parameter.

Parameters:

manuIdList - An array list containing ids of manufacturers

Returns:

An array of manufacturers for the ids passed in

Throws:

java.lang.Exception - an unexpected exception

getManufacturerByShopId

Manufacturer getManufacturerByShopId(int shopId)
                              throws java.lang.Exception

Gets the manufacturer referenced by the shop id

Parameters:

shopId - the shopId

Returns:

The details of a manufacturer

Throws:

java.lang.Exception - an unexpected exception

getManufacturerByWondId

Manufacturer getManufacturerByWondId(java.lang.String shopId)
                              throws java.lang.Exception

Gets the manufacturer referenced by the Wond-Shop id

Parameters:

shopId - the shopId

Returns:

The details of a manufacturer

Throws:

java.lang.Exception - an unexpected exception