com.dpslink.flash.db

Class CartLineController

java.lang.Object

com.dpslink.base.obj.MappedAttributesObject

com.dpslink.base.jdbc.JDBCObjectController<CartLine>

com.dpslink.flash.db.CartLineController

All Implemented Interfaces:

java.io.Serializable

public class CartLineController
extends JDBCObjectController<CartLine>

The controller for the CartLine class. Provides methods for retrieving and persisting cart line table records in the database.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static long	serialVersionUID The class' serialization version id.

Fields inherited from class com.dpslink.base.jdbc.JDBCObjectController

ivDBObjCls, ivFieldCount, ivFieldKeyAlt, ivFieldKeyPri, ivFieldResPfx, ivSyncLast, ivSyncType, ivTableName

Fields inherited from class com.dpslink.base.obj.MappedAttributesObject

ivHashCode, ivHashFlds, ivObjAttrs

Constructor Summary

Constructors

Constructor and Description
CartLineController() The constructor for the controller.

Method Summary

Modifier and Type	Method and Description
boolean	add(CartLine obj) THIS METHOD SHOULD ONLY BE INVOKED BY THE CART CLASS, otherwise the cache of cart lines will be corrupted.
int	add(CartLine obj, boolean logdup) THIS METHOD SHOULD ONLY BE INVOKED BY THE CART CLASS, otherwise the cache of cart lines will be corrupted.
boolean	delete(CartLine obj) THIS METHOD SHOULD ONLY BE INVOKED BY THE CART CLASS, otherwise the cache of cart lines will be corrupted.
boolean	deleteCart(Cart cart) Deletes all cart line records for a cart.
boolean	deleteProduct(CartLine cartline) Deletes all cart line records that match a cart line's cart id, product and unit of measure.
java.util.ArrayList<CartLine>	getCart(FlashServletContext ctx, Cart cart) Returns a collection of all cart lines for a cart.
private int	getNextLineNumber(java.lang.String id) Returns the next available line number for a cart id.
CartLine	resultSetToObject(java.sql.ResultSet rs) Returns a database object from the given SQL result set.
boolean	update(CartLine obj) THIS METHOD SHOULD ONLY BE INVOKED BY THE CART CLASS, otherwise the cache of cart lines will be corrupted.

Methods inherited from class com.dpslink.base.jdbc.JDBCObjectController

add, arrayToMap, arrayToMap, countAll, delete, deleteAll, dispose, equals, getAll, getConnection, getConnectionInfo, getController, getFieldNames, getFieldNamesForKey, getFieldNamesForUpdate, getFieldNulls, getFieldNullsForKey, getFieldNullsForUpdate, getFieldsForOrderBy, getFieldsForWhere, getFieldSize, getFieldTypes, getFieldTypesForKey, getFieldTypesForUpdate, getStatementForDelete, getStatementForGet, getStatementForGetAll, getStatementForInsert, getStatementForUpdate, getStatementKey, getStatementString, getTableName, hasFieldNamesForKey, hasFieldNamesForUpdate, isDuplicate, resultSetToArray, resultSetToMap, resultSetToMap, setConnectionInfo, setPSDeleteValues, setPSExistsValues, setPSInsertValues, setPSUpdateValues, setPSValue, update, valuesToObject

Methods inherited from class com.dpslink.base.obj.MappedAttributesObject

cloneMapAttributes, formatValue, formatValue, getHashFields, getMapArrayList, getMapAttributes, getMapBigDecimal, getMapBoolean, getMapDate, getMapDouble, getMapInteger, getMapLong, getMapMapped, getMapObject, getMapShort, getMapString, getMapString, getMapStringBuffer, getMapStringBuilder, getMapTime, getMapTimestamp, getMapVector, hashCode, setHashFields, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMapAttributes, setMapObject, setMapTime, setMapTimestamp, toStringArray

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

The class' serialization version id.

See Also:

Constant Field Values

Constructor Detail

CartLineController

public CartLineController()

The constructor for the controller.

Method Detail

add

public boolean add(CartLine obj)

THIS METHOD SHOULD ONLY BE INVOKED BY THE CART CLASS, otherwise the cache of cart lines will be corrupted.

Adds a new record to the table associated with the controller. Assumes that duplicates are always logged as an exception. Overrides add in JDBCObjectController.

Overrides:

add in class JDBCObjectController<CartLine>

Parameters:

obj - (JDBCObject) The object for the record to be added.

Returns:

boolean - true if the record added successfully, otherwise false.

add

public int add(CartLine obj,
               boolean logdup)

THIS METHOD SHOULD ONLY BE INVOKED BY THE CART CLASS, otherwise the cache of cart lines will be corrupted.

Adds a new record to the table associated with the controller. Overrides add in JDBCObjectController.

Overrides:

add in class JDBCObjectController<CartLine>

Parameters:

obj - (JDBCObject) The object for the record to be added.

logdup - (boolean) true if duplicate errors are to be logged as an exception, otherwise false if not. When duplicates are logged, the return value of 1 is never returned.

Returns:

int - 0 = success, 1 = duplicate, 2 = failure.

delete

public boolean delete(CartLine obj)

THIS METHOD SHOULD ONLY BE INVOKED BY THE CART CLASS, otherwise the cache of cart lines will be corrupted.

Deletes an existing record from the table associated with the controller. Overrides delete in JDBCObjectController.

Overrides:

delete in class JDBCObjectController<CartLine>

Parameters:

obj - (JDBCObject) The object for the record to be deleted.

Returns:

boolean - true if the record deleted successfully, otherwise false.

update

public boolean update(CartLine obj)

THIS METHOD SHOULD ONLY BE INVOKED BY THE CART CLASS, otherwise the cache of cart lines will be corrupted.

Updates an existing record in the table associated with the controller. Overrides update in JDBCObjectController.

Overrides:

update in class JDBCObjectController<CartLine>

Parameters:

obj - (JDBCObject) The object for the record to be updated.

Returns:

boolean - true if the record updated successfully, otherwise false.

resultSetToObject

public CartLine resultSetToObject(java.sql.ResultSet rs)
                           throws java.sql.SQLException

Returns a database object from the given SQL result set.

Overrides:

resultSetToObject in class JDBCObjectController<CartLine>

Parameters:

rs - (ResultSet) The result set containing the database record from which the new object is to be created. Overrides resultSetToObject in JDBCObjectController.

This method assumes the result set includes a reference to the zproduct database view.

Returns:

CartLine - An object initialized with values from the result set.

Throws:

java.sql.SQLException - - if an error occurs while processing the result set.

deleteCart

public boolean deleteCart(Cart cart)

Deletes all cart line records for a cart.

NOTE: This method only deletes records from the database table. It does not delete from a cart's cached collection of cart lines. To also delete from the cart's cache, invoke one of the deleteCartLine or deleteCartLines methods in Cart.

Parameters:

cart - (Cart) The cart containing the records to delete.

Returns:

boolean - true if the cart lines successfully deleted, otherwise false.

deleteProduct

public boolean deleteProduct(CartLine cartline)

Deletes all cart line records that match a cart line's cart id, product and unit of measure.

NOTE: This method only deletes records from the database table. It does not delete from a cart's cached collection of cart lines. To also delete from the cart's cache, invoke one of the deleteCartLine or deleteCartLines methods in Cart.

Parameters:

cartline - (CartLine) The cart line containing the values for the records to delete.

Returns:

boolean - true if the cart lines successfully deleted, otherwise false.

getCart

public java.util.ArrayList<CartLine> getCart(FlashServletContext ctx,
                                             Cart cart)

Returns a collection of all cart lines for a cart.

NOTE: This method returns all existing cart lines for a cart, including cart lines that have products which are not in the current shopping user's catalog. To retrieve cart lines that are valid for the user's catalog, invoke one of the getCartLine or getCartLines methods in Cart.

Parameters:

ctx - (FlashServletContext) The current servlet context. Pass a null if Xref information is not needed.

cart - (Cart) The cart for the desired cart lines.

Returns:

ArrayList - The cart line objects associated with the cart.

getNextLineNumber

private int getNextLineNumber(java.lang.String id)

Returns the next available line number for a cart id.

Parameters:

id - (String) The cart id for the desired line number.

Returns:

int - The next available line number.