com.dpslink.flash.erp.extend

Class OrderPlacement

java.lang.Object

com.dpslink.base.obj.MappedAttributesObject

com.dpslink.flash.erp.ERPInterfaceAS400

com.dpslink.flash.erp.extend.OrderPlacement

All Implemented Interfaces:

ERPInterface, IOrderPlacement, java.io.Serializable

public class OrderPlacement
extends ERPInterfaceAS400
implements IOrderPlacement

An implementation of the ERP order placement interface for DPS Extend.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.dpslink.flash.erp.ERPInterfaceAS400

ERPInterfaceAS400.Pcml, ERPInterfaceAS400.Received

Field Summary

Fields

Modifier and Type	Field and Description
private static java.text.DecimalFormat	FMT9 A number formatter of length 5.
protected Cart	ivCart The supplied shopping cart object.
protected int	ivEmailAddrDfltIdx A WIP value for default email address index.
protected java.util.ArrayList<java.lang.String>	ivEmailAddrs A WIP collection of email addresses.
protected java.util.ArrayList<java.lang.String>	ivEmailNames A WIP collection of email names.
protected java.util.ArrayList<java.lang.Object[]>	ivErrorCodes A WIP collection of error codes.
protected char	ivMode The current mode being processed.
private static long	serialVersionUID The class' serialization version id.

Fields inherited from class com.dpslink.flash.erp.ERPInterfaceAS400

AS400TEXT3, ivAS400, ivConfig

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

ivHashCode, ivHashFlds, ivObjAttrs

Fields inherited from interface com.dpslink.flash.erp.IOrderPlacement

ERROR_ORDER

Fields inherited from interface com.dpslink.flash.erp.ERPInterface

ERROR_CONNECT, ERROR_NONE, ERROR_PROGRAM, WARN_DUPLICATE, WARN_NONE

Constructor Summary

Constructors

Constructor and Description
OrderPlacement() Constructs a new ERP order placement interface.

Method Summary

Modifier and Type	Method and Description
protected boolean	callProgram() Calls the ERP program for execution.
boolean	createOrder(Cart cart) Creates a new order on the ERP system.
boolean	createQuote(Cart cart) Creates a new quote on the ERP system.
int	getEmailAddressDefaultIndex() Returns the index in the retrieved collections of email addresses and names for the default email.
java.util.ArrayList<java.lang.String>	getEmailAddresses() Returns the retrieved collection of email addresses.
java.util.ArrayList<java.lang.String>	getEmailNames() Returns the retrieved collection of email names.
java.util.ArrayList<java.lang.Object[]>	getErrorCodes() Returns the retrieved collection of error codes.
User	getOrderUser() Returns the ordering user for the order based on the properties value for erp.OrderPlacement.Sfi.OrderingUser.
protected void	parseAdditional(ERPInterfaceAS400.Received rec) Parses additional information from the receive data queue and adds to the email name and address collections.
protected boolean	parseCart(ERPInterfaceAS400.Pcml pcml) Parses cart data returned from the ERP program and updates the current cart's values.
protected void	parseCartLine(ERPInterfaceAS400.Received rec) Parses cart line data from the receive data queue and updates a cart line in the current cart's collection of cart lines.
protected void	parseConfirmLine(ERPInterfaceAS400.Received rec) Parses order line information that is not in the cart which should be displayed to the user.
protected void	parseErrorCode(ERPInterfaceAS400.Received rec) Parses error code information from the receive data queue and adds to the collection of error codes.
protected boolean	parseQueueEntry(java.lang.String fmtid, byte[] qbytes) Parses a data queue entry that was received on the inbound receiving data queue.
boolean	requestQuotation(Cart cart) Sets order totals, taxes, freight, etc.
protected void	resetVariables() Resets the class' instance variables for the start of a new request.
protected boolean	sendCart(ERPInterfaceAS400.Pcml pcml) Sets the ERP program parameters for the current cart and calls the ERP program for execution.
protected void	sendCartLines(com.ibm.as400.access.KeyedDataQueue dq) Places the current cart's cart lines on the outbound sending data queue.
protected void	sendComments(com.ibm.as400.access.KeyedDataQueue dq, java.lang.String comments) Places cart or cart line comments on the outbound sending data queue.
protected void	sendDataQueue() Places information on the outbound sending data queue.

Methods inherited from class com.dpslink.flash.erp.ERPInterfaceAS400

equals, getContext, getEncryptAESLength, getErrorType, getMixedCase, getQueueKey, getRecordFormat, getRecordFormatFieldDecimals, getRecvQueue, getSendQueue, getStoreCompany, getStoreWarehouse, getWarningType, isEncryptAES, isYes, process, readDataQueue, setContext, setErrorType, setQueueKey, setWarningType

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

Methods inherited from interface com.dpslink.flash.erp.ERPInterface

getContext, getErrorType, getWarningType, setContext, setErrorType, setWarningType

Field Detail

serialVersionUID

private static final long serialVersionUID

The class' serialization version id.

See Also:

Constant Field Values

FMT9

private static final java.text.DecimalFormat FMT9

A number formatter of length 5.

ivCart

protected Cart ivCart

The supplied shopping cart object.

ivErrorCodes

protected java.util.ArrayList<java.lang.Object[]> ivErrorCodes

A WIP collection of error codes.

ivEmailNames

protected java.util.ArrayList<java.lang.String> ivEmailNames

A WIP collection of email names.

ivEmailAddrs

protected java.util.ArrayList<java.lang.String> ivEmailAddrs

A WIP collection of email addresses.

ivEmailAddrDfltIdx

protected int ivEmailAddrDfltIdx

A WIP value for default email address index.

ivMode

protected char ivMode

The current mode being processed.

Constructor Detail

OrderPlacement

public OrderPlacement()

Constructs a new ERP order placement interface.

Method Detail

createOrder

public boolean createOrder(Cart cart)

Creates a new order on the ERP system. Order id will be assigned and set in the cart object. Implements createOrder in IOrderPlacement.

Specified by:

createOrder in interface IOrderPlacement

Parameters:

cart - (Cart) The shopping cart on which the order is based.

Returns:

boolean - true if creating the order was successful, otherwise false.

createQuote

public boolean createQuote(Cart cart)

Creates a new quote on the ERP system. Order id will be assigned and set in the cart object. Implements createQuote in IOrderPlacement.

Specified by:

createQuote in interface IOrderPlacement

Parameters:

cart - (Cart) The shopping cart on which the quote is based.

Returns:

boolean - true if creating the quote was successful, otherwise false.

requestQuotation

public boolean requestQuotation(Cart cart)

Sets order totals, taxes, freight, etc. in the cart object. Implements requestQuotation in IOrderPlacement.

Specified by:

requestQuotation in interface IOrderPlacement

Parameters:

cart - (Cart) The shoppping cart for quotation.

Returns:

boolean - true if the quotation was successful, otherwise false.

getErrorCodes

public java.util.ArrayList<java.lang.Object[]> getErrorCodes()

Returns the retrieved collection of error codes. Implements getErrorCodes in IOrderPlacement.

Specified by:

getErrorCodes in interface IOrderPlacement

Returns:

ArrayList - The error codes.

getEmailAddressDefaultIndex

public int getEmailAddressDefaultIndex()

Returns the index in the retrieved collections of email addresses and names for the default email. Implements getEmailAddressDefaultIndex in IOrderPlacement.

Specified by:

getEmailAddressDefaultIndex in interface IOrderPlacement

Returns:

int - The default email address index.

getEmailAddresses

public java.util.ArrayList<java.lang.String> getEmailAddresses()

Returns the retrieved collection of email addresses. Implements getEmailAddresses in IOrderPlacement.

Specified by:

getEmailAddresses in interface IOrderPlacement

Returns:

ArrayList - The email addresses.

getEmailNames

public java.util.ArrayList<java.lang.String> getEmailNames()

Returns the retrieved collection of email names. Implements getEmailNames in IOrderPlacement.

Specified by:

getEmailNames in interface IOrderPlacement

Returns:

ArrayList - The email names.

getOrderUser

public User getOrderUser()

Returns the ordering user for the order based on the properties value for erp.OrderPlacement.Sfi.OrderingUser. Implements getOrderUser in IOrderPlacement.

Specified by:

getOrderUser in interface IOrderPlacement

Returns:

User - The order's ordering user.

callProgram

protected boolean callProgram()
                       throws java.lang.Exception

Calls the ERP program for execution. A connection to the ERP system is required prior to invoking this method. Invoked by process after any data to be placed on the send queue has been successfully placed and sent. Overrides callProgram in ERPInterfaceAS400.

Specified by:

callProgram in class ERPInterfaceAS400

Returns:

boolean - true if the call was successful, otherwise false.

Throws:

java.lang.Exception - - if an error occurs with the running of the ERP program.

parseQueueEntry

protected boolean parseQueueEntry(java.lang.String fmtid,
                                  byte[] qbytes)
                           throws java.lang.Exception

Parses a data queue entry that was received on the inbound receiving data queue. A connection to the ERP system is required prior to invoking this method. Invoked by readDataQueue for each queue entry that is read for the current queue key. Overrides parseQueueEntry in ERPInterfaceAS400.

Specified by:

parseQueueEntry in class ERPInterfaceAS400

Parameters:

fmtid - (String) The record format id of the queue entry.

qbytes - (byte[]) The data queue entry's raw data.

Returns:

boolean - true to read the next entry from the receive data queue or false to stop reading.

Throws:

java.lang.Exception - - if an error occurs with reading data on the queue.

sendDataQueue

protected void sendDataQueue()
                      throws java.lang.Exception

Places information on the outbound sending data queue. A connection to the ERP system is required prior to invoking this method. Invoked by process as the first step after a connection to the ERP system has been successfully established. Overrides sendDataQueue in ERPInterfaceAS400.

Specified by:

sendDataQueue in class ERPInterfaceAS400

Throws:

java.lang.Exception - - if an error occurs with placing data on the queue and sending the queue.

parseCart

protected boolean parseCart(ERPInterfaceAS400.Pcml pcml)
                     throws java.lang.Exception

Parses cart data returned from the ERP program and updates the current cart's values.

Parameters:

pcml - (Pcml) The ERP program definition.

Returns:

boolean - true if the parsing is successful, otherwise false.

Throws:

java.lang.Exception - - if an error occurs during the parsing of the returned data.

parseCartLine

protected void parseCartLine(ERPInterfaceAS400.Received rec)
                      throws java.lang.Exception

Parses cart line data from the receive data queue and updates a cart line in the current cart's collection of cart lines.

Parameters:

rec - (Received) The receive data queue data.

Throws:

java.lang.Exception - - if an error occurs during the parsing of the queue's data.

parseConfirmLine

protected void parseConfirmLine(ERPInterfaceAS400.Received rec)
                         throws java.lang.Exception

Parses order line information that is not in the cart which should be displayed to the user. This really should only happen when the order consolidation feature is being used (i.e. new order is being added to an existing order.

Parameters:

rec - (Received) The receive data queue data.

Throws:

java.lang.Exception - - if an error occurs during the parsing of the queue's data.

parseErrorCode

protected void parseErrorCode(ERPInterfaceAS400.Received rec)
                       throws java.lang.Exception

Parses error code information from the receive data queue and adds to the collection of error codes.

Parameters:

rec - (Received) The receive data queue data.

Throws:

java.lang.Exception - - if an error occurs during the parsing of the queue's data.

parseAdditional

protected void parseAdditional(ERPInterfaceAS400.Received rec)
                        throws java.lang.Exception

Parses additional information from the receive data queue and adds to the email name and address collections.

Parameters:

rec - (Received) The receive data queue data.

Throws:

java.lang.Exception - - if an error occurs during the parsing of the queue's data.

sendCart

protected boolean sendCart(ERPInterfaceAS400.Pcml pcml)
                    throws java.lang.Exception

Sets the ERP program parameters for the current cart and calls the ERP program for execution.

Parameters:

pcml - (Pcml) The ERP program definition.

Returns:

boolean - true if the call was successful, otherwise false.

Throws:

java.lang.Exception - - if an error occurs with the running of the ERP program.

sendCartLines

protected void sendCartLines(com.ibm.as400.access.KeyedDataQueue dq)
                      throws java.lang.Exception

Places the current cart's cart lines on the outbound sending data queue.

Parameters:

dq - (KeyedDataQueue) The outbound sending queue.

Throws:

java.lang.Exception - - if an error occurs with placing data on the queue and sending the queue.

sendComments

protected void sendComments(com.ibm.as400.access.KeyedDataQueue dq,
                            java.lang.String comments)
                     throws java.lang.Exception

Places cart or cart line comments on the outbound sending data queue.

Parameters:

dq - (KeyedDataQueue) The outbound sending queue.

comments - (String) The comments to send.

Throws:

java.lang.Exception - - if an error occurs with placing data on the queue and sending the queue.

resetVariables

protected void resetVariables()

Resets the class' instance variables for the start of a new request.