com.dpslink.flash.erp.extend

Class Control

java.lang.Object

com.dpslink.base.obj.MappedAttributesObject

com.dpslink.flash.erp.ERPInterfaceAS400

com.dpslink.flash.erp.extend.Control

All Implemented Interfaces:

ERPInterface, IControl, java.io.Serializable

public class Control
extends ERPInterfaceAS400
implements IControl

An implementation of the ERP control file 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.util.ArrayList<BackendControl>	ivControls A supplied or WIP collection of backend controls.
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.ERPInterface

ERROR_CONNECT, ERROR_NONE, ERROR_PROGRAM, WARN_DUPLICATE, WARN_NONE

Constructor Summary

Constructors

Constructor and Description
Control() Constructs a new ERP control file information interface.

Method Summary

Modifier and Type	Method and Description
protected boolean	callProgram() Calls the ERP program for execution.
java.util.ArrayList<BackendControl>	getControls() Retrieves a collection of backend control objects from the ERP system.
BackendJobDescription	getJobDescription() Retrieves a backend job description object from the ERP system.
protected BackendControl	parseControl(ERPInterfaceAS400.Received rec) Parses backend control data from the receive data queue and returns a backend control 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	sendDataQueue() Places information on the outbound sending data queue.
boolean	updateControls(java.util.ArrayList<BackendControl> controls) Updates a collection of backend control objects on 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, 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

ivControls

protected java.util.ArrayList<BackendControl> ivControls

A supplied or WIP collection of backend controls.

ivMode

protected char ivMode

The current mode being processed.

Constructor Detail

Control

public Control()

Constructs a new ERP control file information interface.

Method Detail

getControls

public java.util.ArrayList<BackendControl> getControls()

Retrieves a collection of backend control objects from the ERP system. Implements getControls in IControl.

Specified by:

getControls in interface IControl

Returns:

ArrayList - A collection of backend control objects.

getJobDescription

public BackendJobDescription getJobDescription()

Retrieves a backend job description object from the ERP system. Implements getJobDescription in IControl.

Specified by:

getJobDescription in interface IControl

Returns:

BackendJobDescription - The backend job description object.

updateControls

public boolean updateControls(java.util.ArrayList<BackendControl> controls)

Updates a collection of backend control objects on the ERP system. Implements updateControls in IControl.

Specified by:

updateControls in interface IControl

Parameters:

controls - (ArrayList) The control objects to update.

Returns:

boolean - true if updates are successful, otherwise false.

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.

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.

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.

parseControl

protected BackendControl parseControl(ERPInterfaceAS400.Received rec)
                               throws java.lang.Exception

Parses backend control data from the receive data queue and returns a backend control object.

Parameters:

rec - (Received) The receive data queue data.

Returns:

BackendControl - The parsed backend control data.

Throws:

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