com.dpslink.flash.erp.extend

Class UserMaintenance

java.lang.Object

com.dpslink.base.obj.MappedAttributesObject

com.dpslink.flash.erp.ERPInterfaceAS400

com.dpslink.flash.erp.extend.UserMaintenance

All Implemented Interfaces:

ERPInterface, IUserMaintenance, java.io.Serializable

public class UserMaintenance
extends ERPInterfaceAS400
implements IUserMaintenance

An implementation of the ERP user 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 java.lang.String	ivInitId The supplied id of the user initiating the maintenance.
protected char	ivMode The current mode being processed.
protected User	ivUser The supplied user being maintained or the WIP retrieved user.
protected java.lang.String	ivUserId A WIP user id.
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
UserMaintenance() Constructs a new ERP user maintenance interface.

Method Summary

Modifier and Type	Method and Description
protected boolean	callProgram() Calls the ERP program for execution.
boolean	createUser(User user, java.lang.String initid) Creates a new user record in the ERP system.
boolean	deleteUser(User user, java.lang.String initid) Deletes a user record in the ERP system.
protected Customer	findCustomer(java.lang.String id) Returns the customer record for the given id.
User	getUser(java.lang.String userId) Retrieves a user record from the ERP system.
User	getUser(java.lang.String userId, java.lang.String queueId) Retrieves a user record from the ERP system.
protected boolean	parseQueueEntry(java.lang.String fmtid, byte[] qbytes) Parses a data queue entry that was received on the inbound receiving data queue.
protected User	parseUser(ERPInterfaceAS400.Received rec) Parses user data from the receive data queue and returns a user object.
protected void	sendDataQueue() Places information on the outbound sending data queue.
boolean	updateUser(User user, java.lang.String initid) Updates a user 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

ivUser

protected User ivUser

The supplied user being maintained or the WIP retrieved user.

ivInitId

protected java.lang.String ivInitId

The supplied id of the user initiating the maintenance.

ivMode

protected char ivMode

The current mode being processed.

ivUserId

protected java.lang.String ivUserId

A WIP user id.

Constructor Detail

UserMaintenance

public UserMaintenance()

Constructs a new ERP user maintenance interface.

Method Detail

createUser

public boolean createUser(User user,
                          java.lang.String initid)

Creates a new user record in the ERP system. Implements createUser in IUserMaintenance.

Specified by:

createUser in interface IUserMaintenance

Parameters:

user - (User) The user object to create.

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

Returns:

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

updateUser

public boolean updateUser(User user,
                          java.lang.String initid)

Updates a user record in the ERP system. Implements updateUser in IUserMaintenance.

Specified by:

updateUser in interface IUserMaintenance

Parameters:

user - (User) The user object containing the new information.

initid - (String) The user Id initiating the update.

Returns:

boolean - true if the user was successfully updated, otherwise false.

deleteUser

public boolean deleteUser(User user,
                          java.lang.String initid)

Deletes a user record in the ERP system. Implements deleteUser in IUserMaintenance.

Specified by:

deleteUser in interface IUserMaintenance

Parameters:

user - (User) The user object for the user to delete.

initid - (String) The user Id initiating the update.

Returns:

boolean - true if the user was successfully deleted, otherwise false.

getUser

public User getUser(java.lang.String userId)

Retrieves a user record from the ERP system. Implements getUser in IUserMaintenance.

Specified by:

getUser in interface IUserMaintenance

Parameters:

userId - (String) The id for the user to retrieve.

Returns:

User - A user object for the requested id.

getUser

public User getUser(java.lang.String userId,
                    java.lang.String queueId)

Retrieves a user record from the ERP system. Implements getUser in IUserMaintenance.

Specified by:

getUser in interface IUserMaintenance

Parameters:

userId - (String) The id for the user 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:

User - A user object for the requested 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.

findCustomer

protected Customer findCustomer(java.lang.String id)

Returns the customer record for the given id.

Parameters:

id - (String) The customer id for the desired record.

Returns:

Customer - The requested customer, if found, else null.

parseUser

protected User parseUser(ERPInterfaceAS400.Received rec)
                  throws java.lang.Exception

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

Parameters:

rec - (Received) The receive data queue data.

Returns:

User - The parsed user data.

Throws:

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