com.dpslink.flash.erp.bogus

Class ARInformation

java.lang.Object

com.dpslink.base.obj.MappedAttributesObject

com.dpslink.flash.erp.ERPInterfaceBogus

com.dpslink.flash.erp.bogus.ARInformation

All Implemented Interfaces:

ERPInterface, IARInformation, java.io.Serializable

public class ARInformation
extends ERPInterfaceBogus
implements IARInformation

A bogus implementation of the ERP accounts receivable information interface.

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.flash.erp.ERPInterfaceBogus

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
boolean	createInvoicePDF(java.lang.String invoiceNumber) Creates an existing invoice as a PDF.
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.
boolean	writeInvoicePDFData(java.io.OutputStream out) Writes the invoice PDF data to the supplied output stream.

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

equals, getContext, getErrorType, getQueueKey, getWarningType, 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

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.

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.