com.dpslink.flash.erp.extend

Class CustomerMaintenance

java.lang.Object

com.dpslink.base.obj.MappedAttributesObject

com.dpslink.flash.erp.ERPInterfaceAS400

com.dpslink.flash.erp.extend.CustomerMaintenance

All Implemented Interfaces:

ERPInterface, ICustomerMaintenance, java.io.Serializable

public class CustomerMaintenance
extends ERPInterfaceAS400
implements ICustomerMaintenance

An implementation of the ERP customer maintenance 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 Customer	ivCustomer The supplied customer being maintained.
protected java.lang.String	ivCustomerId A WIP customer id.
protected java.lang.String	ivInitId The supplied id of the user initiating the maintenance.
protected char	ivMode The current mode being processed.
protected java.util.ArrayList<Customer>	ivShiptos A WIP collection of shiptos for a customer.
protected int	ivType The supplied type of customer being maintained (account, shipto).
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.ICustomerMaintenance

ERROR_DUPLICATE, TYPE_ACCOUNT, TYPE_SHIPTO

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
CustomerMaintenance() Constructs a new ERP customer maintenance interface.

Method Summary

Modifier and Type	Method and Description
protected boolean	callProgram() Calls the ERP program for execution.
boolean	createCustomer(Customer customer, int type, java.lang.String initid) Creates a new customer record in the ERP system.
boolean	deleteCustomer(Customer customer, java.lang.String initid) Deletes a customer record in the ERP system.
protected Country	findCountry(java.lang.String code) Returns the country record for the given code.
protected State	findState(java.lang.String code, java.lang.String cntry) Returns the state record for the given state code and country code.
Customer	getCustomer(java.lang.String customerId) Retrieves a customer record from the ERP system.
Customer	getCustomer(java.lang.String customerId, java.lang.String queueId) Retrieves a customer record from the ERP system.
java.util.ArrayList<Customer>	getShipForCustomers(java.lang.String customerId) Returns a collection of customer records from the ERP system which have shipfor id equal customer id.
protected Customer	parseCustomer(ERPInterfaceAS400.Received rec) Parses customer data from the receive data queue and returns a customer 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	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	updateCustomer(Customer customer, java.lang.String initid) Updates a customer record in the ERP system.

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

ivCustomer

protected Customer ivCustomer

The supplied customer being maintained.

ivType

protected int ivType

The supplied type of customer being maintained (account, shipto).

ivInitId

protected java.lang.String ivInitId

The supplied id of the user initiating the maintenance.

ivMode

protected char ivMode

The current mode being processed.

ivCustomerId

protected java.lang.String ivCustomerId

A WIP customer id.

ivShiptos

protected java.util.ArrayList<Customer> ivShiptos

A WIP collection of shiptos for a customer.

Constructor Detail

CustomerMaintenance

public CustomerMaintenance()

Constructs a new ERP customer maintenance interface.

Method Detail

createCustomer

public boolean createCustomer(Customer customer,
                              int type,
                              java.lang.String initid)

Creates a new customer record in the ERP system. Implements createCustomer in ICustomerMaintenance.

Specified by:

createCustomer in interface ICustomerMaintenance

Parameters:

customer - (Customer) The customer object to create. A new customer id will be assigned and set in this customer object.

type - (int) The type of customer that is to be created. Must be one of the predefined types (TYPE_ACCOUNT, TYPE_SHIPTO).

initid - (String) The id of the user initiating the create.

Returns:

boolean - true if the customer was successfully added, otherwise false.

updateCustomer

public boolean updateCustomer(Customer customer,
                              java.lang.String initid)

Updates a customer record in the ERP system. Only ERP name and address are changed. Implements updateCustomer in ICustomerMaintenance.

Specified by:

updateCustomer in interface ICustomerMaintenance

Parameters:

customer - (Customer) The customer object containing the new information.

initid - (String) The id of the user initiating the update.

Returns:

boolean - true if the customer was successfully updated otherwise false.

deleteCustomer

public boolean deleteCustomer(Customer customer,
                              java.lang.String initid)

Deletes a customer record in the ERP system. Only ERP ship-to customers can be deleted. Implements deleteCustomer in ICustomerMaintenance.

Specified by:

deleteCustomer in interface ICustomerMaintenance

Parameters:

customer - (Customer) The customer object for the customer to delete.

initid - (String) The id of the user initiating the delete.

Returns:

boolean - true if the customer was successfully deleted otherwise false.

getCustomer

public Customer getCustomer(java.lang.String customerId)

Retrieves a customer record from the ERP system. Implements getCustomer in ICustomerMaintenance.

Specified by:

getCustomer in interface ICustomerMaintenance

Parameters:

customerId - (String) The id for the customer to retrieve.

Returns:

Customer - A customer object for the requested id.

getCustomer

public Customer getCustomer(java.lang.String customerId,
                            java.lang.String queueId)

Retrieves a customer record from the ERP system. Implements getCustomer in ICustomerMaintenance.

Specified by:

getCustomer in interface ICustomerMaintenance

Parameters:

customerId - (String) The id for the customer to retrieve.

queueId - (String) The value to use when creating the queue key, if a value other than the current session id is desired.

Returns:

Customer - A customer object for the requested id.

getShipForCustomers

public java.util.ArrayList<Customer> getShipForCustomers(java.lang.String customerId)

Returns a collection of customer records from the ERP system which have shipfor id equal customer id. Implements getShipForCustomers in ICustomerMaintenance.

Specified by:

getShipForCustomers in interface ICustomerMaintenance

Parameters:

customerId - (String) The shipfor id for the customers to retrieve.

Returns:

ArrayList - A collection of customer objects for the requested shipfor id.

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.

findCountry

protected Country findCountry(java.lang.String code)

Returns the country record for the given code.

Parameters:

code - (String) The country code for the desired record.

Returns:

Country - The requested country, if found, else null.

findState

protected State findState(java.lang.String code,
                          java.lang.String cntry)

Returns the state record for the given state code and country code.

Parameters:

code - (String) The state code for the desired record.

cntry - (String) The country code for the desired record.

Returns:

State - The requested state, if found, else null.

parseCustomer

protected Customer parseCustomer(ERPInterfaceAS400.Received rec)
                          throws java.lang.Exception

Parses customer data from the receive data queue and returns a customer object.

Parameters:

rec - (Received) The receive data queue data.

Returns:

Customer - The parsed customer 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.