com.dpslink.flash.erp.extend

Class OrderInformation

java.lang.Object

com.dpslink.base.obj.MappedAttributesObject

com.dpslink.flash.erp.ERPInterfaceAS400

com.dpslink.flash.erp.extend.OrderInformation

All Implemented Interfaces:

ERPInterface, IOrderInformation, java.io.Serializable

public class OrderInformation
extends ERPInterfaceAS400
implements IOrderInformation

An implementation of the ERP order information 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
protected java.lang.String	ivAddlAmt A WIP amount for additional charges.
protected java.lang.String	ivCustDiscAmt A WIP amount for customer discount.
protected java.lang.String	ivOIPromoAmt A WIP amount for promotion discount.
protected Order	ivOrder A WIP order information object.
protected java.lang.String	ivOrderNum The supplied order number to retrieve.
protected java.lang.String	ivQtyDiscAmt A WIP amount for quantity discount.
protected ShipSummary	ivShipSum A WIP shipment summary object.
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.ERPInterface

ERROR_CONNECT, ERROR_NONE, ERROR_PROGRAM, WARN_DUPLICATE, WARN_NONE

Constructor Summary

Constructors

Constructor and Description
OrderInformation() Constructs a new ERP order information interface.

Method Summary

Modifier and Type	Method and Description
protected boolean	callProgram() Calls the ERP program for execution.
Order	getOrder(java.lang.String orderNum) Returns an order object containing information for a requested order.
protected OrderDetail	parseOrderDetail(ERPInterfaceAS400.Received rec) Parses order detail data from the receive data queue and returns an order detail object.
protected void	parseOrderInfo(ERPInterfaceAS400.Pcml pcml) Parses order information data returned from the ERP program and sets the various WIP variables.
protected PaymentDetail	parsePaymentDetail(ERPInterfaceAS400.Received rec) Parses payment detail data from the receive data queue and returns a payment detail object.
protected boolean	parseQueueEntry(java.lang.String fmtid, byte[] qbytes) Parses a data queue entry that was received on the inbound receiving data queue.
protected OrderDetail	parseShipDetail(ERPInterfaceAS400.Received rec) Parses shipment detail data from the receive data queue and returns a shipment detail object (as an order detail object).
protected ShipSummary	parseShipSummary(ERPInterfaceAS400.Received rec) Parses shipment summary data from the receive data queue and returns a shipment summary object.
protected java.lang.String	parseTrackingDetail(ERPInterfaceAS400.Received rec) Parses shipment tracking data from the receive data queue and returns a shipment tracking number.
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

ivOrderNum

protected java.lang.String ivOrderNum

The supplied order number to retrieve.

ivOrder

protected Order ivOrder

A WIP order information object.

ivShipSum

protected ShipSummary ivShipSum

A WIP shipment summary object.

ivAddlAmt

protected java.lang.String ivAddlAmt

A WIP amount for additional charges.

ivQtyDiscAmt

protected java.lang.String ivQtyDiscAmt

A WIP amount for quantity discount.

ivOIPromoAmt

protected java.lang.String ivOIPromoAmt

A WIP amount for promotion discount.

ivCustDiscAmt

protected java.lang.String ivCustDiscAmt

A WIP amount for customer discount.

Constructor Detail

OrderInformation

public OrderInformation()

Constructs a new ERP order information interface.

Method Detail

getOrder

public Order getOrder(java.lang.String orderNum)

Returns an order object containing information for a requested order. Implements getOrder in IOrderInformation.

Specified by:

getOrder in interface IOrderInformation

Parameters:

orderNum - (String) The order number to retrieve.

Returns:

Order - The requested order.

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.

parseOrderInfo

protected void parseOrderInfo(ERPInterfaceAS400.Pcml pcml)
                       throws java.lang.Exception

Parses order information data returned from the ERP program and sets the various WIP variables.

Parameters:

pcml - (Pcml) The ERP program's definition.

Throws:

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

parseOrderDetail

protected OrderDetail parseOrderDetail(ERPInterfaceAS400.Received rec)
                                throws java.lang.Exception

Parses order detail data from the receive data queue and returns an order detail object.

Parameters:

rec - (Received) The receive data queue data.

Returns:

OrderDetail - The parsed order detail data.

Throws:

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

parseShipSummary

protected ShipSummary parseShipSummary(ERPInterfaceAS400.Received rec)
                                throws java.lang.Exception

Parses shipment summary data from the receive data queue and returns a shipment summary object.

Parameters:

rec - (Received) The receive data queue data.

Returns:

ShipSummary - The parsed shipment summary data.

Throws:

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

parseShipDetail

protected OrderDetail parseShipDetail(ERPInterfaceAS400.Received rec)
                               throws java.lang.Exception

Parses shipment detail data from the receive data queue and returns a shipment detail object (as an order detail object).

Parameters:

rec - (Received) The receive data queue data.

Returns:

OrderDetail - The parsed shipment detail data.

Throws:

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

parsePaymentDetail

protected PaymentDetail parsePaymentDetail(ERPInterfaceAS400.Received rec)
                                    throws java.lang.Exception

Parses payment detail data from the receive data queue and returns a payment detail object.

Parameters:

rec - (Received) The receive data queue data.

Returns:

PaymentDetail - The parsed payment detail data.

Throws:

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

parseTrackingDetail

protected java.lang.String parseTrackingDetail(ERPInterfaceAS400.Received rec)
                                        throws java.lang.Exception

Parses shipment tracking data from the receive data queue and returns a shipment tracking number.

Parameters:

rec - (Received) The receive data queue data.

Returns:

PaymentDetail - The parsed shipment tracking data.

Throws:

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