com.konakartadmin.blif

Interface AdminProdAttrMgrIf

All Known Implementing Classes:

AdminProductAttrMgr

public interface AdminProdAttrMgrIf

AdminCustomerTagMgrIf

Method Summary

Modifier and Type	Method and Description
void	addProdAttrDescsToTemplate(AdminProdAttrDesc[] attrDescs, int templateId) Add the array of ProdAttrDesc objects to the template.
int	deleteProdAttrDesc(int id) Delete an AdminProdAttrDesc
int	deleteProdAttrDescWithOptions(int id, AdminProdAttrDescOptions options) Delete an AdminProdAttrDesc
int	deleteProdAttrTemplate(int id) Delete an AdminProdAttrTemplate
AdminProdAttrDesc[]	getCustomAttrsFromXML(java.lang.String xml) Create an array of custom attributes from the XML
AdminProdAttrDesc	getProdAttrDesc(int id) Returns the AdminProdAttrDesc object for the id parameter, or Null if the AdminProdAttrDesc doesn't exist in the DB.
AdminProdAttrDescSearchResult	getProdAttrDescs(AdminProdAttrDescSearch search, int offset, int size) This returns an AdminProdAttrDescSearchResult object.
AdminProdAttrDesc[]	getProdAttrDescsForTemplate(int templateId) This method fetches all of the AdminProdAttrDesc objects for the template referenced by the templateId parameter.
AdminProdAttrDesc[]	getProdAttrDescsForTemplates(AdminProdAttrTemplate[] templates) This method fetches all of the AdminProdAttrDesc objects for the array of templates referenced by the templates parameter.
AdminProdAttrTemplate	getProdAttrTemplate(int id) Returns the AdminProdAttrTemplate object for the id parameter, or Null if the AdminProdAttrTemplate doesn't exist in the DB.
AdminProdAttrTemplateSearchResult	getProdAttrTemplates(AdminProdAttrTemplateSearch search, int offset, int size) This returns an AdminProdAttrTemplateSearchResult object.
AdminProdAttrTemplate[]	getProdAttrTemplatesPerProduct(int productId) Returns an array of custom attribute templates associated with the product
AdminProdAttrTemplate[]	getProdAttrTemplatesPerProduct(int productId, java.sql.Connection con) Returns an array of custom attribute templates associated with the product
int	getProductCountPerProdAttrDesc(int attrDescId) Returns the number of products using the product attribute descriptor
int	getProductCountPerTemplate(int templateId) Returns the number of products using the custom product attribute template
int	getTemplateCountPerProdAttrDesc(int attrDescId) Returns the number of templates using the product attribute descriptor
java.lang.String	getXMLFromCustomAttrs(AdminProdAttrDesc[] attrDescArray) Create an XML structure for the custom attributes
int	insertProdAttrDesc(AdminProdAttrDesc attrDesc) An AdminProdAttrDesc object is inserted into the database.
int	insertProdAttrTemplate(AdminProdAttrTemplate template) An AdminProdAttrTemplate object is inserted into the database.
void	removeProdAttrDescsFromTemplate(AdminProdAttrDesc[] attrDescs, int templateId) Remove an array of ProdAttrDesc objects from the template
int	updateProdAttrDesc(AdminProdAttrDesc attrDesc) Update an AdminProdAttrDesc object.
int	updateProdAttrTemplate(AdminProdAttrTemplate template) Update an AdminProdAttrTemplate object.
int	updateProductsUsingProdAttrDesc(int attrDescId) Loop through all templates containing the custom attribute.
int	updateProductsUsingTemplates(int[] templateIds) For each template, loop through the products and update the custom fields.

Method Detail

insertProdAttrDesc

int insertProdAttrDesc(AdminProdAttrDesc attrDesc)
                throws KKAdminException,
                       org.apache.torque.TorqueException

An AdminProdAttrDesc object is inserted into the database. The following attributes are compulsory:

• name

The id of the new object is returned.

Parameters:

attrDesc - the attrDesc

Returns:

Returns the id of the ProdAttrDesc object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

updateProdAttrDesc

int updateProdAttrDesc(AdminProdAttrDesc attrDesc)
                throws KKAdminException,
                       org.apache.torque.TorqueException,
                       com.workingdogs.village.DataSetException

Update an AdminProdAttrDesc object. If the value of an attribute is null, the current value is not updated.

Parameters:

attrDesc - An AdminProdAttrDesc object

Returns:

returns the id of the updated AdminProdAttrDesc object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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)

deleteProdAttrDesc

int deleteProdAttrDesc(int id)
                throws KKAdminException,
                       org.apache.torque.TorqueException

Delete an AdminProdAttrDesc

Parameters:

id - The id of the deleted AdminProdAttrDesc object

Returns:

Returns the id of the deleted AdminProdAttrDesc object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

deleteProdAttrDescWithOptions

int deleteProdAttrDescWithOptions(int id,
                                  AdminProdAttrDescOptions options)
                           throws KKAdminException,
                                  org.apache.torque.TorqueException

Delete an AdminProdAttrDesc

Parameters:

id - The id of the deleted AdminProdAttrDesc object

options - Can be used to configure the operation to update all products to remove the deleted attribute from the products using it.

Returns:

Returns the id of the deleted AdminProdAttrDesc object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

getProdAttrDesc

AdminProdAttrDesc getProdAttrDesc(int id)
                           throws KKAdminException,
                                  org.apache.torque.TorqueException,
                                  com.workingdogs.village.DataSetException

Returns the AdminProdAttrDesc object for the id parameter, or Null if the AdminProdAttrDesc doesn't exist in the DB.

Parameters:

id - the id

Returns:

Returns a AdminProdAttrDesc object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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)

getProdAttrDescsForTemplate

AdminProdAttrDesc[] getProdAttrDescsForTemplate(int templateId)
                                         throws org.apache.torque.TorqueException,
                                                KKAdminException,
                                                com.workingdogs.village.DataSetException

This method fetches all of the AdminProdAttrDesc objects for the template referenced by the templateId parameter.

An empty array is returned if no AdminProdAttrDesc objects exist.

Parameters:

templateId - the templateId

Returns:

Returns an array of AdminProdAttrDesc objects

Throws:

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

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

getProdAttrDescsForTemplates

AdminProdAttrDesc[] getProdAttrDescsForTemplates(AdminProdAttrTemplate[] templates)
                                          throws org.apache.torque.TorqueException,
                                                 KKAdminException,
                                                 com.workingdogs.village.DataSetException

This method fetches all of the AdminProdAttrDesc objects for the array of templates referenced by the templates parameter.

An empty array is returned if no AdminProdAttrDesc objects exist.

Parameters:

templates - the templates

Returns:

Returns an array of AdminProdAttrDesc objects

Throws:

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

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

getProdAttrDescs

AdminProdAttrDescSearchResult getProdAttrDescs(AdminProdAttrDescSearch search,
                                               int offset,
                                               int size)
                                        throws org.apache.torque.TorqueException,
                                               com.workingdogs.village.DataSetException,
                                               KKAdminException

This returns an AdminProdAttrDescSearchResult object.

Parameters:

search - the search

offset - the offset in the db

size - the number of records from the specified offset

Returns:

Returns an AdminProdAttrDescSearchResult object

Throws:

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

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

KKAdminException - an unexpected exception in the KonaKart Admin engine

insertProdAttrTemplate

int insertProdAttrTemplate(AdminProdAttrTemplate template)
                    throws KKAdminException,
                           org.apache.torque.TorqueException

An AdminProdAttrTemplate object is inserted into the database. The following attributes are compulsory:

• name

The id of the new object is returned.

Parameters:

template - the template

Returns:

Returns the id of the ProdAttrTemplate object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

updateProdAttrTemplate

int updateProdAttrTemplate(AdminProdAttrTemplate template)
                    throws KKAdminException,
                           org.apache.torque.TorqueException,
                           com.workingdogs.village.DataSetException

Update an AdminProdAttrTemplate object. If the value of an attribute is null, the current value is not updated.

Parameters:

template - An AdminProdAttrTemplate object

Returns:

returns the id of the updated AdminProdAttrTemplate object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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)

deleteProdAttrTemplate

int deleteProdAttrTemplate(int id)
                    throws KKAdminException,
                           org.apache.torque.TorqueException

Delete an AdminProdAttrTemplate

Parameters:

id - The id of the deleted AdminProdAttrTemplate object

Returns:

Returns the id of the deleted AdminProdAttrTemplate object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

getProdAttrTemplate

AdminProdAttrTemplate getProdAttrTemplate(int id)
                                   throws KKAdminException,
                                          org.apache.torque.TorqueException,
                                          com.workingdogs.village.DataSetException

Returns the AdminProdAttrTemplate object for the id parameter, or Null if the AdminProdAttrTemplate doesn't exist in the DB. If the Template contains an array of ProdAttrDesc objects, these are also fetched from the DB.

Parameters:

id - the id

Returns:

Returns a AdminProdAttrTemplate object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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)

getProdAttrTemplates

AdminProdAttrTemplateSearchResult getProdAttrTemplates(AdminProdAttrTemplateSearch search,
                                                       int offset,
                                                       int size)
                                                throws org.apache.torque.TorqueException,
                                                       com.workingdogs.village.DataSetException,
                                                       KKAdminException

This returns an AdminProdAttrTemplateSearchResult object.

Parameters:

search - the search

offset - the offset in the db

size - the number of records from the specified offset

Returns:

Returns an AdminProdAttrTemplateSearchResult object

Throws:

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

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

KKAdminException - an unexpected exception in the KonaKart Admin engine

getProdAttrTemplatesPerProduct

AdminProdAttrTemplate[] getProdAttrTemplatesPerProduct(int productId)
                                                throws KKAdminException,
                                                       com.workingdogs.village.DataSetException,
                                                       org.apache.torque.TorqueException

Returns an array of custom attribute templates associated with the product

Parameters:

productId - the productId

Returns:

Returns an array of custom attribute templates associated with the product

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

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

getProdAttrTemplatesPerProduct

AdminProdAttrTemplate[] getProdAttrTemplatesPerProduct(int productId,
                                                       java.sql.Connection con)
                                                throws KKAdminException,
                                                       com.workingdogs.village.DataSetException,
                                                       org.apache.torque.TorqueException

Returns an array of custom attribute templates associated with the product

Parameters:

productId - the productId

con - Connection for Transaction

Returns:

Returns an array of custom attribute templates associated with the product

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

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

addProdAttrDescsToTemplate

void addProdAttrDescsToTemplate(AdminProdAttrDesc[] attrDescs,
                                int templateId)
                         throws org.apache.torque.TorqueException,
                                KKAdminException

Add the array of ProdAttrDesc objects to the template. We assume that the ProdAttrDesc objects have already been inserted.

Parameters:

attrDescs - the attrDescs

templateId - the templateId

Throws:

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

KKAdminException - an unexpected exception in the KonaKart Admin engine

removeProdAttrDescsFromTemplate

void removeProdAttrDescsFromTemplate(AdminProdAttrDesc[] attrDescs,
                                     int templateId)
                              throws org.apache.torque.TorqueException,
                                     KKAdminException

Remove an array of ProdAttrDesc objects from the template

Parameters:

attrDescs - the attrDescs

templateId - the templateId

Throws:

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

KKAdminException - an unexpected exception in the KonaKart Admin engine

getTemplateCountPerProdAttrDesc

int getTemplateCountPerProdAttrDesc(int attrDescId)
                             throws com.workingdogs.village.DataSetException,
                                    KKAdminException,
                                    org.apache.torque.TorqueException

Returns the number of templates using the product attribute descriptor

Parameters:

attrDescId - the attrDescId

Returns:

Return the number of templates using the product attribute descriptor

Throws:

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

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

getProductCountPerProdAttrDesc

int getProductCountPerProdAttrDesc(int attrDescId)
                            throws com.workingdogs.village.DataSetException,
                                   KKAdminException,
                                   org.apache.torque.TorqueException

Returns the number of products using the product attribute descriptor

Parameters:

attrDescId - the attrDescId

Returns:

Return the number of products using the product attribute descriptor

Throws:

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

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

getProductCountPerTemplate

int getProductCountPerTemplate(int templateId)
                        throws com.workingdogs.village.DataSetException,
                               KKAdminException,
                               org.apache.torque.TorqueException

Returns the number of products using the custom product attribute template

Parameters:

templateId - the templateId

Returns:

Return the number of products using the custom product attribute template

Throws:

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

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

getXMLFromCustomAttrs

java.lang.String getXMLFromCustomAttrs(AdminProdAttrDesc[] attrDescArray)

Create an XML structure for the custom attributes

Parameters:

attrDescArray - Array of custom attributes

Returns:

Returns an XML structure

getCustomAttrsFromXML

AdminProdAttrDesc[] getCustomAttrsFromXML(java.lang.String xml)

Create an array of custom attributes from the XML

Parameters:

xml - The custom attribute data in xml format

Returns:

Returns an array of AdminProdAttrDesc objects

updateProductsUsingProdAttrDesc

int updateProductsUsingProdAttrDesc(int attrDescId)
                             throws java.lang.Exception

Loop through all templates containing the custom attribute. For each template, loop through the products and update the custom fields.

Parameters:

attrDescId - the attrDescId

Returns:

Returns the number of products updated

Throws:

java.lang.Exception - an unexpected exception

updateProductsUsingTemplates

int updateProductsUsingTemplates(int[] templateIds)
                          throws java.lang.Exception

For each template, loop through the products and update the custom fields.

Parameters:

templateIds - the templateIds

Returns:

Returns the number of products updated

Throws:

java.lang.Exception - an unexpected exception