com.dpslink.flash.erp.extend

Class ARInformation

java.lang.Object

com.dpslink.base.obj.MappedAttributesObject

com.dpslink.flash.erp.ERPInterfaceAS400

com.dpslink.flash.erp.extend.ARInformation

All Implemented Interfaces:

ERPInterface, IARInformation, java.io.Serializable

public class ARInformation
extends ERPInterfaceAS400
implements IARInformation

An implementation of the ERP accounts receivable 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
private static java.text.DecimalFormat	FMT5 A number formatter of length 5.
protected ARSummary	ivARSummary A WIP AR summary object.
protected int	ivDaysOfInvoices The supplied value that limits the invoices retrieved to this many days in the past.
protected java.lang.String	ivErrorCode A WIP error code.
protected java.lang.String	ivFullPath A WIP full path name to the invoice PDF file.
protected java.lang.String	ivInvoiceNumber The supplied value for invoice number.
protected char	ivMode The current mode being processed.
protected int	ivMonthsOfAging The supplied value that limits the aging retrieved to this many months in the past.
protected boolean	ivOpenInvoices The supplied flag that designates whether open invoices are retrieved true or all invoices are retrieved false.
protected java.io.OutputStream	ivOutputStream The supplied value for output stream.
private static char	MODE_GET_ARSUM Constants for interface mode.
private static char	MODE_INVOICE_PDF
private static char	MODE_WRITE_PDF_DATA
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
ARInformation() Constructs a new ERP accounts receivable information interface.

Method Summary

Modifier and Type	Method and Description
protected boolean	callCreateInvoicePDF() Calls the ERP program for creating an invoice as a PDF file.
protected boolean	callGetARSummary() Calls the ERP program for retrieving A/R summary information.
protected boolean	callProgram() Calls the ERP program for execution.
boolean	createInvoicePDF(java.lang.String invoiceNumber) Creates an existing invoice as a PDF file.
protected boolean	executeTransferPdfData() Transfers PDF file data from the IFS on the backend system to the supplied output stream.
ARSummary	getAR(boolean openInvoices, int daysOfInvoices, int monthsOfAging) Returns accounts receivable information for the current shopping user.
java.lang.String	getErrorCode() Returns the retrieved error code.
java.util.ArrayList<PaymentDetail>	getInvoicePayments(java.lang.String paidbyCustId, java.lang.String invoiceNumber) Returns a collection of payment details for an invoice.
protected ARAging	parseARAging(ERPInterfaceAS400.Received rec) Parses AR aging data from the receive data queue and returns an AR aging object.
protected ARDetail	parseARDetail(ERPInterfaceAS400.Received rec) Parses AR detail data from the receive data queue and returns an AR detail object.
protected ARSummary	parseARSummary(ERPInterfaceAS400.Received rec) Parses AR summary data from the receive data queue and returns an AR summary 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 void	readDataQueue() Reads information placed on the inbound receiving data queue by the called ERP program.
protected void	resetVariables() Resets the class' instance variables for the start of a new request.
protected void	sendDataQueue() Places information on the outbound sending data queue.
boolean	writeInvoicePDFData(java.io.OutputStream out) Writes the invoice PDF data to the supplied output stream.

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, 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

MODE_GET_ARSUM

private static final char MODE_GET_ARSUM

Constants for interface mode.

See Also:

Constant Field Values

MODE_INVOICE_PDF

private static final char MODE_INVOICE_PDF

See Also:

Constant Field Values

MODE_WRITE_PDF_DATA

private static final char MODE_WRITE_PDF_DATA

See Also:

Constant Field Values

FMT5

private static final java.text.DecimalFormat FMT5

A number formatter of length 5.

ivOpenInvoices

protected boolean ivOpenInvoices

The supplied flag that designates whether open invoices are retrieved true or all invoices are retrieved false.

ivDaysOfInvoices

protected int ivDaysOfInvoices

The supplied value that limits the invoices retrieved to this many days in the past.

ivMonthsOfAging

protected int ivMonthsOfAging

The supplied value that limits the aging retrieved to this many months in the past.

ivInvoiceNumber

protected java.lang.String ivInvoiceNumber

The supplied value for invoice number.

ivOutputStream

protected java.io.OutputStream ivOutputStream

The supplied value for output stream.

ivARSummary

protected ARSummary ivARSummary

A WIP AR summary object.

ivErrorCode

protected java.lang.String ivErrorCode

A WIP error code.

ivFullPath

protected java.lang.String ivFullPath

A WIP full path name to the invoice PDF file.

ivMode

protected char ivMode

The current mode being processed.

Constructor Detail

ARInformation

public ARInformation()

Constructs a new ERP accounts receivable information interface.

Method Detail

getAR

public ARSummary getAR(boolean openInvoices,
                       int daysOfInvoices,
                       int monthsOfAging)

Returns accounts receivable information for the current shopping user. Implements getAR in IARInformation.

Specified by:

getAR in interface IARInformation

Parameters:

openInvoices - (boolean) A flag that designates whether open invoices are retrieved true or all invoices are retrieved false.

daysOfInvoices - (int) Limits the invoices retrieved to this many days in the past.

monthsOfAging - (int) Limits the aging retrieved to this many months in the past.

Returns:

ARSummary - An accounts receivable summary object containing accounts receivable information for the specified user.

getInvoicePayments

public java.util.ArrayList<PaymentDetail> getInvoicePayments(java.lang.String paidbyCustId,
                                                             java.lang.String invoiceNumber)

Returns a collection of payment details for an invoice.

Specified by:

getInvoicePayments in interface IARInformation

Parameters:

paidbyCustId - (String) The paid-by customer for the desired payment details.

invoiceNumber - (String) The invoice number for the desired payment details.

Returns:

ArrayList - The invoice's collection of payment details.

createInvoicePDF

public boolean createInvoicePDF(java.lang.String invoiceNumber)

Creates an existing invoice as a PDF file.

Specified by:

createInvoicePDF in interface IARInformation

Parameters:

invoiceNumber - (String) Invoice number.

Returns:

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

writeInvoicePDFData

public boolean writeInvoicePDFData(java.io.OutputStream out)

Writes the invoice PDF data to the supplied output stream. A successful call to createInvoicePDF() must be made before executing this method.

Specified by:

writeInvoicePDFData in interface IARInformation

Parameters:

out - (OutputStream) The target output stream.

Returns:

boolean - true if operation was successful, otherwise false.

getErrorCode

public java.lang.String getErrorCode()

Returns the retrieved error code.

Specified by:

getErrorCode in interface IARInformation

Returns:

String - The error code.

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. Implements 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.

callGetARSummary

protected boolean callGetARSummary()
                            throws java.lang.Exception

Calls the ERP program for retrieving A/R summary information.

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.

callCreateInvoicePDF

protected boolean callCreateInvoicePDF()
                                throws java.lang.Exception

Calls the ERP program for creating an invoice as a PDF file.

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.

executeTransferPdfData

protected boolean executeTransferPdfData()
                                  throws java.lang.Exception

Transfers PDF file data from the IFS on the backend system to the supplied output stream. *** Also deletes the IFS file when done ***

Returns:

boolean - true if the transfer 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. Implements 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. Implements 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.

readDataQueue

protected void readDataQueue()
                      throws java.lang.Exception

Reads information placed on the inbound receiving data queue by the called ERP program. A connection to the ERP system is required prior to invoking this method. Invoked by process after a successful call to the ERP program. Iterates through the received queue entries for the current queue key, determines each queue entry's record format id, and then invokes the parseQueueEntry method. Overrides readDataQueue in ERPInterfaceAS400.

Overrides:

readDataQueue in class ERPInterfaceAS400

Throws:

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

parseARSummary

protected ARSummary parseARSummary(ERPInterfaceAS400.Received rec)
                            throws java.lang.Exception

Parses AR summary data from the receive data queue and returns an AR summary object.

Parameters:

rec - (Received) The receive data queue data.

Returns:

ARSummary - The parsed AR summary data.

Throws:

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

parseARAging

protected ARAging parseARAging(ERPInterfaceAS400.Received rec)
                        throws java.lang.Exception

Parses AR aging data from the receive data queue and returns an AR aging object.

Parameters:

rec - (Received) The receive data queue data.

Returns:

ARAging - The parsed AR aging data.

Throws:

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

parseARDetail

protected ARDetail parseARDetail(ERPInterfaceAS400.Received rec)
                          throws java.lang.Exception

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

Parameters:

rec - (Received) The receive data queue data.

Returns:

ARDetail - The parsed AR detail data.

Throws:

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

resetVariables

protected void resetVariables()

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