com.konakartadmin.blif

Interface AdminMiscItemMgrIf

All Known Implementing Classes:

AdminMiscItemMgr

public interface AdminMiscItemMgrIf

AdminMiscItemMgrIf

Method Summary

Modifier and Type	Method and Description
void	deleteMiscItem(int miTypeId) Delete an AdminMiscItem.
void	deleteMiscItemType(int miTypeId, boolean deleteChildren) Delete an AdminMiscItemType.
AdminMiscItemSearchResult	getMiscItems(AdminSearch search, int offset, int size) Return the AdminMiscItem objects defined by the search criteria.
AdminMiscItemSearchResult	getMiscItems(AdminSearch search, int offset, int size, java.sql.Connection con) Return the AdminMiscItem objects defined by the search criteria.
AdminMiscItem[]	getMiscItemsPerProduct(int productId) A method for returning the misc items of a product.
AdminMiscItemType[]	getMiscItemTypes(AdminSearch search, int offset, int size) Return the AdminMiscItemType objects defined by the search criteria.
int	insertMiscItems(AdminMiscItem[] mItems) Insert an array of AdminMiscItem objects
int	insertMiscItemType(AdminMiscItemType[] miTypes) Insert an array of AdminMiscItemType objects
void	refreshConfigs() Refresh the configuration of the Manager
void	updateMiscItems(AdminMiscItem[] mItems) Update an array of AdminMiscItem objects.
void	updateMiscItemType(AdminMiscItemType[] miTypes) Update an array of AdminMiscItemType objects.

Method Detail

getMiscItemTypes

AdminMiscItemType[] getMiscItemTypes(AdminSearch search,
                                     int offset,
                                     int size)
                              throws KKAdminException,
                                     java.lang.Exception

Return the AdminMiscItemType objects defined by the search criteria.

Parameters:

search - the generic Admin search object that defines the objects to search for. If null we use the default AdminSearch object. If you specify the LanguageId in the search object, only the MiscItemType for that specified language will be returned. If you specify AdminLanguage.ALL_LANGUAGES for the languageId the search will be made on the default language, and if MiscItemTypes are found, MiscItemTypes with these MiscItemTypeIds for all of the languages are returned.

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

Returns:

an array of AdminMiscItemType objects or null if no records match the search criteria.

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

java.lang.Exception - an unexpected exception

insertMiscItemType

int insertMiscItemType(AdminMiscItemType[] miTypes)
                throws KKAdminException,
                       java.lang.Exception

Insert an array of AdminMiscItemType objects

Parameters:

miTypes - An array of AdminMiscItemType objects to insert. Typically you would insert one AdminMiscItemType record for each language to maintain data integrity.

Returns:

the id created for the newly-inserted AdminMiscItemType objects

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

java.lang.Exception - an unexpected exception

updateMiscItemType

void updateMiscItemType(AdminMiscItemType[] miTypes)
                 throws KKAdminException,
                        org.apache.torque.TorqueException

Update an array of AdminMiscItemType objects. Only the name and the description can be updated.

Parameters:

miTypes - An array of AdminMiscItemType objects to update.

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

deleteMiscItemType

void deleteMiscItemType(int miTypeId,
                        boolean deleteChildren)
                 throws KKAdminException,
                        org.apache.torque.TorqueException,
                        java.lang.Exception

Delete an AdminMiscItemType. All records with the specified miscellaneous item type id will be deleted - that is the miscellaneous item type for every language defined.

Parameters:

miTypeId - the id of the miscellaneous item type object to delete

deleteChildren - if true all children (miscellaneous items with this miscellaneous item type) will also be deleted.

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

java.lang.Exception - an unexpected exception

insertMiscItems

int insertMiscItems(AdminMiscItem[] mItems)
             throws KKAdminException,
                    java.lang.Exception

Insert an array of AdminMiscItem objects

Parameters:

mItems - An array of AdminMiscItem objects to insert.

Returns:

the id created for the last newly-inserted AdminMiscItem objects

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

java.lang.Exception - an unexpected exception

updateMiscItems

void updateMiscItems(AdminMiscItem[] mItems)
              throws KKAdminException,
                     org.apache.torque.TorqueException

Update an array of AdminMiscItem objects.

Parameters:

mItems - An array of AdminMiscItem objects to update.

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

deleteMiscItem

void deleteMiscItem(int miTypeId)
             throws KKAdminException,
                    org.apache.torque.TorqueException

Delete an AdminMiscItem. All records with the specified miscellaneous item type id will be deleted - that is the miscellaneous item type for every language defined.

Parameters:

miTypeId - the id of the miscellaneous item object to delete

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

getMiscItems

AdminMiscItemSearchResult getMiscItems(AdminSearch search,
                                       int offset,
                                       int size)
                                throws KKAdminException,
                                       org.apache.torque.TorqueException,
                                       com.workingdogs.village.DataSetException

Return the AdminMiscItem objects defined by the search criteria.

Parameters:

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

AdminSearch criteria usage:

• ids = Can contain an array of kkObjIds
• id = kkMiscItemId
• id2 = kkMiscItemTypeId
• id3 = kkObjId
• id4 = kkObjTypeId
• name = item Value

AdminSearch order by options:

• AdminSearch.ORDER_BY_ID_DESCENDING order by Misc Item Id descending
• AdminSearch.ORDER_BY_ID_ASCENDING order by Misc Item Id ascending
• AdminSearch.ORDER_BY_ID2_DESCENDING order by Misc Item Type Id descending
• AdminSearch.ORDER_BY_ID2_ASCENDING order by Misc Item Type Id ascending
• AdminSearch.ORDER_BY_ID3_DESCENDING order by Object Id descending
• AdminSearch.ORDER_BY_ID3_ASCENDING order by Object Id ascending
• AdminSearch.ORDER_BY_ID4_DESCENDING order by Object Type Id descending
• AdminSearch.ORDER_BY_ID4_ASCENDING order by Object Type Id ascending
• AdminSearch.ORDER_BY_NAME_DESCENDING order by Item Value descending
• AdminSearch.ORDER_BY_NAME_ASCENDING order by Item Value ascending
• AdminSearch.ORDER_BY_DATE_DESCENDING order by Date Added descending
• AdminSearch.ORDER_BY_DATE_ASCENDING order by Date Added ascending

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

Returns:

an AdminMiscItemSearchResult object that contains an array of AdminMiscItem objects if records are found that match the search criteria.

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)

getMiscItems

AdminMiscItemSearchResult getMiscItems(AdminSearch search,
                                       int offset,
                                       int size,
                                       java.sql.Connection con)
                                throws KKAdminException,
                                       org.apache.torque.TorqueException,
                                       com.workingdogs.village.DataSetException

Return the AdminMiscItem objects defined by the search criteria.

Parameters:

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

AdminSearch criteria usage:

• ids = Can contain an array of kkObjIds
• id = kkMiscItemId
• id2 = kkMiscItemTypeId
• id3 = kkObjId
• id4 = kkObjTypeId
• name = item Value

AdminSearch order by options:

• AdminSearch.ORDER_BY_ID_DESCENDING order by Misc Item Id descending
• AdminSearch.ORDER_BY_ID_ASCENDING order by Misc Item Id ascending
• AdminSearch.ORDER_BY_ID2_DESCENDING order by Misc Item Type Id descending
• AdminSearch.ORDER_BY_ID2_ASCENDING order by Misc Item Type Id ascending
• AdminSearch.ORDER_BY_ID3_DESCENDING order by Object Id descending
• AdminSearch.ORDER_BY_ID3_ASCENDING order by Object Id ascending
• AdminSearch.ORDER_BY_ID4_DESCENDING order by Object Type Id descending
• AdminSearch.ORDER_BY_ID4_ASCENDING order by Object Type Id ascending
• AdminSearch.ORDER_BY_NAME_DESCENDING order by Item Value descending
• AdminSearch.ORDER_BY_NAME_ASCENDING order by Item Value ascending
• AdminSearch.ORDER_BY_DATE_DESCENDING order by Date Added descending
• AdminSearch.ORDER_BY_DATE_ASCENDING order by Date Added ascending

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

con - Connection for Transaction

Returns:

an AdminMiscItemSearchResult object that contains an array of AdminMiscItem objects if records are found that match the search criteria.

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)

refreshConfigs

void refreshConfigs()
             throws java.lang.Exception

Refresh the configuration of the Manager

Throws:

java.lang.Exception - an unexpected exception

getMiscItemsPerProduct

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

A method for returning the misc items of a product. It doesn't check that the product belongs to the current store of the engine.

Parameters:

productId - the productId

Returns:

Returns an array of misc items associated with a product

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)