com.konakartadmin.blif

Interface AdminShipmentMgrIf

All Known Implementing Classes:

AdminShipmentMgr

public interface AdminShipmentMgrIf

AdminShipmentMgrIf

Method Summary

Modifier and Type	Method and Description
void	addOrderShipmentsToOrder(AdminOrder order) Get an array of order shipment objects for this order and attach them to the order
void	deleteOrderShipment(int orderShipmentId) Delete the AdminOrderShipment object and any associated AdminOrderShipmentProduct objects
int	deleteShipper(int shipperId) Delete a Shipper
void	editOrderShipment(AdminOrderShipment orderShipment) Edits an AdminOrderShipment object.
AdminOrderShipmentSearchResult	getOrderShipments(AdminOrderShipmentSearch shipSearch, int offset, int size)
AdminShipper	getShipper(int shipperId) Get a shipper by id
AdminShipperSearchResult	getShippers(AdminShipperSearch search) This returns an AdminShipperSearchResult object matching the search constraints
int	insertOrderShipment(AdminOrderShipment orderShipment) Inserts an AdminOrderShipment object and links it to an array of AdminOrderProduct objects in order to identify which products in the order were shipped.
int	insertShipper(AdminShipper shipper) Insert a Shipper
void	refreshConfigs() Refresh the configuration of the Manager
int	updateShipper(AdminShipper shipper) Update a Shipper

Method Detail

refreshConfigs

void refreshConfigs()
             throws java.lang.Exception

Refresh the configuration of the Manager

Throws:

java.lang.Exception - an unexpected exception

insertOrderShipment

int insertOrderShipment(AdminOrderShipment orderShipment)
                 throws java.lang.Exception

Inserts an AdminOrderShipment object and links it to an array of AdminOrderProduct objects in order to identify which products in the order were shipped.

Parameters:

orderShipment - the orderShipment

Returns:

Returns the id of the newly inserted AdminOrderShipment object

Throws:

java.lang.Exception - an unexpected exception

editOrderShipment

void editOrderShipment(AdminOrderShipment orderShipment)
                throws java.lang.Exception

Edits an AdminOrderShipment object.

Parameters:

orderShipment - the orderShipment

Throws:

java.lang.Exception - an unexpected exception

deleteOrderShipment

void deleteOrderShipment(int orderShipmentId)
                  throws java.lang.Exception

Delete the AdminOrderShipment object and any associated AdminOrderShipmentProduct objects

Parameters:

orderShipmentId - the orderShipmentId

Throws:

java.lang.Exception - an unexpected exception

getOrderShipments

AdminOrderShipmentSearchResult getOrderShipments(AdminOrderShipmentSearch shipSearch,
                                                 int offset,
                                                 int size)
                                          throws KKAdminException,
                                                 org.apache.torque.TorqueException,
                                                 com.workingdogs.village.DataSetException

Parameters:

shipSearch - the shipSearch

offset - the offset

size - the size

Returns:

Return an AdminShipments 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)

getShippers

AdminShipperSearchResult getShippers(AdminShipperSearch search)
                              throws org.apache.torque.TorqueException,
                                     com.workingdogs.village.DataSetException,
                                     KKAdminException

This returns an AdminShipperSearchResult object matching the search constraints

Parameters:

search - the search

Returns:

Returns an AdminShipperSearchResult object

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)

KKAdminException - an unexpected exception in the KonaKart Admin engine

getShipper

AdminShipper getShipper(int shipperId)
                 throws org.apache.torque.TorqueException,
                        com.workingdogs.village.DataSetException,
                        KKAdminException

Get a shipper by id

Parameters:

shipperId - the shipperId

Returns:

Returns an AdminShipper object

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)

KKAdminException - an unexpected exception in the KonaKart Admin engine

insertShipper

int insertShipper(AdminShipper shipper)
           throws org.apache.torque.TorqueException,
                  KKAdminException

Insert a Shipper

Parameters:

shipper - A shipper object

Returns:

returns the id of the inserted shipper object

Throws:

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

KKAdminException - an unexpected exception in the KonaKart Admin engine

updateShipper

int updateShipper(AdminShipper shipper)
           throws org.apache.torque.TorqueException,
                  KKAdminException

Update a Shipper

Parameters:

shipper - A shipper object

Returns:

returns the id of the updated shipper

Throws:

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

KKAdminException - an unexpected exception in the KonaKart Admin engine

deleteShipper

int deleteShipper(int shipperId)
           throws org.apache.torque.TorqueException,
                  KKAdminException

Delete a Shipper

Parameters:

shipperId - A shipper id

Returns:

returns the id of the deleted shipper

Throws:

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

KKAdminException - an unexpected exception in the KonaKart Admin engine

addOrderShipmentsToOrder

void addOrderShipmentsToOrder(AdminOrder order)
                       throws KKAdminException,
                              org.apache.torque.TorqueException,
                              com.workingdogs.village.DataSetException

Get an array of order shipment objects for this order and attach them to the order

Parameters:

order - the order

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