StoredProcedureHelperProxy

java.lang.Object
- com.ibm.commerce.fulfillment.commands.StoredProcedureHelperProxy

```
public class StoredProcedureHelperProxy
extends java.lang.Object
```
This helper class to facilitate various operations on the collections of order items. Creation date: (03/23/01 1:36:20 PM)

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String COPYRIGHT
IBM copyright notice field.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COPYRIGHT` IBM copyright notice field.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static TypedProperty`	`callAdjustInventory(java.lang.Long invAdjId, java.lang.Long versionSpcId, java.lang.Integer storeId, java.lang.Integer ffcId, java.lang.Long invAdjCode, java.lang.Integer qtyAdjusted, java.lang.String comment)` call the stored procedure AdjustInventory
`static TypedProperty`	`callAvailInvStore(java.lang.Long itemSpcId, java.lang.Integer storeId, java.lang.String ffcList)` Call the stored procedure AvailInvStore
`static TypedProperty`	`callAvailRADate(java.lang.Long itemSpcId, java.lang.Integer qty, java.lang.Integer storeId, java.lang.String ffcList)` Call the stored procedure AvailRADate
`static TypedProperty`	`callBOItem(java.lang.Long orderItemsId, java.lang.String ffcList)` Call the stored procedure BOItem
`static TypedProperty`	`callCreateReleases(java.lang.Long ordersId, java.lang.Long allocId)` Call stored procedure CreateReleases.
`static TypedProperty`	`callCreateReleases(java.lang.Long ordersId, java.lang.Long allocId, java.lang.String storeIdList)` Call stored procedure CreateReleases
`static TypedProperty`	callExpectedAvail(java.lang.Integer storeId, java.lang.String raId, java.lang.String vendor, java.lang.String createTime, java.lang.String radetailId, java.lang.String externalId, java.lang.String openIndicator, java.lang.String orderDate, java.lang.String dateClosed, java.lang.String partNumber, java.lang.String raDetailComment, java.lang.String qtyRemaining, java.lang.String qtyOrdered, java.lang.String qtyReceived, java.lang.String ffmCenter, java.lang.String expectedDate, java.lang.String origExpectedDate, java.lang.String deleteFlag, java.lang.String raKeys, java.lang.String radetailKeys, java.lang.Integer inCount, java.lang.String sDelimiter, java.lang.String sRecCount, java.lang.String sCommitFlag) Call the stored procedure ExpectedAvail
`static TypedProperty`	`callGetItems(java.lang.Long orderItemsId, java.lang.Integer ffcId, java.lang.String singleFfcYorN, java.lang.Double qtyMultiple)` Call the stored procedure GetItems
`static TypedProperty`	`callGetItems(java.lang.Long orderItemsId, java.lang.Integer ffcId, java.lang.String singleFfcYorN, java.lang.Double qtyMultiple, java.lang.Integer ffmcTrackInventory, java.lang.String storeIdList)` call stored procedure with full parameters.
`static TypedProperty`	`callRAAllocation(java.lang.Integer storeId)` Call the stored procedure RAAllocation
`static TypedProperty`	`callReverseInventory(java.lang.Long orderItemsId)` Call the stored procedure ReverseInventory
`static TypedProperty`	`callShipItems(java.lang.Long ordersId, java.lang.Long allocId)` Call stored procedure ShipItems
`static TypedProperty`	`callShipItems(java.lang.Long ordersId, java.lang.Long allocId, java.lang.Integer inventoryOp)` Call stored procedure ShipItems
`static TypedProperty`	`callShipItems(java.lang.Long ordersId, java.lang.Long allocId, java.lang.String storeIdList, java.lang.Integer inventoryOp)` Call stored procedure ShipItems
`static void`	`checkForError(java.lang.String astrSPName, TypedProperty aSPReturnCodes)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- COPYRIGHT
```
public static final java.lang.String COPYRIGHT
```
  IBM copyright notice field.
  
  See Also:
  
  Constant Field Values

Method Detail

callAdjustInventory

public static TypedProperty callAdjustInventory(java.lang.Long invAdjId,
                                                java.lang.Long versionSpcId,
                                                java.lang.Integer storeId,
                                                java.lang.Integer ffcId,
                                                java.lang.Long invAdjCode,
                                                java.lang.Integer qtyAdjusted,
                                                java.lang.String comment)
                                         throws javax.naming.NamingException,
                                                java.sql.SQLException,
                                                ParameterNotFoundException,
                                                InvalidParameterValueException,
                                                ECApplicationException

call the stored procedure AdjustInventory

Parameters:: invAdjId -; versionSpcId -; storeId -; ffcId -; invAdjCode -; qtyAdjusted -; comment -
Returns:: com.ibm.commerce.datatype.TypedProperty
Throws:: javax.naming.NamingException; java.sql.SQLException; ParameterNotFoundException; InvalidParameterValueException; ECApplicationException

callAvailInvStore

public static TypedProperty callAvailInvStore(java.lang.Long itemSpcId,
                                              java.lang.Integer storeId,
                                              java.lang.String ffcList)
                                       throws javax.naming.NamingException,
                                              com.ibm.commerce.key.CreateKeyException,
                                              java.sql.SQLException,
                                              ParameterNotFoundException,
                                              InvalidParameterValueException,
                                              ECApplicationException

Call the stored procedure AvailInvStore

Parameters:: itemSpcId -; storeId -; ffcList -
Returns:: com.ibm.commerce.datatype.TypedProperty
Throws:: javax.naming.NamingException; java.sql.SQLException; ParameterNotFoundException; InvalidParameterValueException; ECApplicationException; com.ibm.commerce.key.CreateKeyException

callAvailRADate

public static TypedProperty callAvailRADate(java.lang.Long itemSpcId,
                                            java.lang.Integer qty,
                                            java.lang.Integer storeId,
                                            java.lang.String ffcList)
                                     throws javax.naming.NamingException,
                                            com.ibm.commerce.key.CreateKeyException,
                                            java.sql.SQLException,
                                            ParameterNotFoundException,
                                            InvalidParameterValueException,
                                            ECApplicationException

Call the stored procedure AvailRADate

Parameters:: itemSpcId -; qty -; storeId -; ffcList -
Returns:: com.ibm.commerce.datatype.TypedProperty
Throws:: javax.naming.NamingException; java.sql.SQLException; ParameterNotFoundException; InvalidParameterValueException; ECApplicationException; com.ibm.commerce.key.CreateKeyException

callBOItem

public static TypedProperty callBOItem(java.lang.Long orderItemsId,
                                       java.lang.String ffcList)
                                throws javax.naming.NamingException,
                                       com.ibm.commerce.key.CreateKeyException,
                                       java.sql.SQLException,
                                       ParameterNotFoundException,
                                       InvalidParameterValueException,
                                       ECApplicationException

Call the stored procedure BOItem

Parameters:: orderItemsId -; ffcList -
Returns:: com.ibm.commerce.datatype.TypedProperty
Throws:: javax.naming.NamingException; java.sql.SQLException; ParameterNotFoundException; InvalidParameterValueException; ECApplicationException; com.ibm.commerce.key.CreateKeyException

callGetItems

public static TypedProperty callGetItems(java.lang.Long orderItemsId,
                                         java.lang.Integer ffcId,
                                         java.lang.String singleFfcYorN,
                                         java.lang.Double qtyMultiple)
                                  throws javax.naming.NamingException,
                                         com.ibm.commerce.key.CreateKeyException,
                                         java.sql.SQLException,
                                         ParameterNotFoundException,
                                         InvalidParameterValueException,
                                         ECApplicationException

Call the stored procedure GetItems

Parameters:: orderItemsId -; ffcId -; singleFfcYorN -; qtyMultiple -
Returns:: com.ibm.commerce.datatype.TypedProperty
Throws:: javax.naming.NamingException; java.sql.SQLException; ParameterNotFoundException; InvalidParameterValueException; ECApplicationException; com.ibm.commerce.key.CreateKeyException

callGetItems

public static TypedProperty callGetItems(java.lang.Long orderItemsId,
                                         java.lang.Integer ffcId,
                                         java.lang.String singleFfcYorN,
                                         java.lang.Double qtyMultiple,
                                         java.lang.Integer ffmcTrackInventory,
                                         java.lang.String storeIdList)
                                  throws javax.naming.NamingException,
                                         com.ibm.commerce.key.CreateKeyException,
                                         java.sql.SQLException,
                                         ParameterNotFoundException,
                                         InvalidParameterValueException,
                                         ECApplicationException

call stored procedure with full parameters.

Parameters:: orderItemsId -; ffcId -; singleFfcYorN -; qtyMultiple -; ffmcTrackInventory -; storeIdList -
Returns:: TypedProperty
Throws:: javax.naming.NamingException; java.sql.SQLException; ParameterNotFoundException; InvalidParameterValueException; ECApplicationException; com.ibm.commerce.key.CreateKeyException

callRAAllocation

public static TypedProperty callRAAllocation(java.lang.Integer storeId)
                                      throws javax.naming.NamingException,
                                             java.sql.SQLException,
                                             ParameterNotFoundException,
                                             InvalidParameterValueException,
                                             ECApplicationException

Call the stored procedure RAAllocation

Parameters:: storeId -
Returns:: com.ibm.commerce.datatype.TypedProperty
Throws:: javax.naming.NamingException; java.sql.SQLException; ParameterNotFoundException; InvalidParameterValueException; ECApplicationException

callReverseInventory

public static TypedProperty callReverseInventory(java.lang.Long orderItemsId)
                                          throws javax.naming.NamingException,
                                                 java.sql.SQLException,
                                                 ParameterNotFoundException,
                                                 InvalidParameterValueException,
                                                 ECApplicationException

Call the stored procedure ReverseInventory

Parameters:: orderItemsId -
Returns:: com.ibm.commerce.datatype.TypedProperty
Throws:: javax.naming.NamingException; java.sql.SQLException; ParameterNotFoundException; InvalidParameterValueException; ECApplicationException

callShipItems

public static TypedProperty callShipItems(java.lang.Long ordersId,
                                          java.lang.Long allocId)
                                   throws javax.naming.NamingException,
                                          java.sql.SQLException,
                                          ParameterNotFoundException,
                                          InvalidParameterValueException,
                                          ECApplicationException

Call stored procedure ShipItems

Parameters:: ordersId -; allocId -
Returns:: com.ibm.commerce.datatype.TypedProperty
Throws:: javax.naming.NamingException; java.sql.SQLException; ParameterNotFoundException; InvalidParameterValueException; ECApplicationException
See Also:: callShipItems(Long, Long, String, Integer)

callShipItems

public static TypedProperty callShipItems(java.lang.Long ordersId,
                                          java.lang.Long allocId,
                                          java.lang.Integer inventoryOp)
                                   throws javax.naming.NamingException,
                                          java.sql.SQLException,
                                          ParameterNotFoundException,
                                          InvalidParameterValueException,
                                          ECApplicationException

Call stored procedure ShipItems

Parameters:: ordersId -; allocId -; inventoryOp - 0 implies that inventory should be decremented, otherwise it will be done later elsewhere
Returns:: a TypedProperty containing the return and error information
Throws:: javax.naming.NamingException; java.sql.SQLException; ParameterNotFoundException; InvalidParameterValueException; ECApplicationException
See Also:: callShipItems(Long,Long,String,Integer)

callShipItems
```
public static TypedProperty callShipItems(java.lang.Long ordersId,
                                          java.lang.Long allocId,
                                          java.lang.String storeIdList,
                                          java.lang.Integer inventoryOp)
                                   throws javax.naming.NamingException,
                                          java.sql.SQLException,
                                          ParameterNotFoundException,
                                          InvalidParameterValueException,
                                          ECApplicationException
```
Call stored procedure ShipItems

Parameters:

ordersId -

allocId - not currently used.

storeIdList - an explicit list of store ids to be used for accessing the STOREITEM table. This list is used instead of the default list of (order.storeid, storeitem storepath, store.groupid - where store is obtained from order.storeid)

inventoryOp -

Returns:

TypedProperty containing name-value pairs of returned values. Status "OK" - successful. CommitStatus "Y" - transaction should be committed. "N" - transaction should not be committed. SQLState error code. SPErrorCode for debug purposes - SQLSTATE for an unhandled SQLSTATE.

Throws:

javax.naming.NamingException

java.sql.SQLException

ParameterNotFoundException

InvalidParameterValueException

ECApplicationException

See Also:

com.ibm.commerce.base.objects.StoredProcedureHelperAccessBean#callShipItems(java.lang.Long, java.lang.Long, java.lang.String, java.lang.Integer)

callCreateReleases
```
public static TypedProperty callCreateReleases(java.lang.Long ordersId,
                                               java.lang.Long allocId)
                                        throws javax.naming.NamingException,
                                               java.sql.SQLException,
                                               ParameterNotFoundException,
                                               InvalidParameterValueException,
                                               ECApplicationException
```
Call stored procedure CreateReleases. This method creates releases, but they are not released to fulfillment as is done for ShipItems. Note: For each order item to be released, the STOREITEM table is accessed to determine whether the item is released separately or not. Since this table is storepath enabled, it will be accessed using the following algorithm until entry is found. the store id from the order. the storepath for the store item table. the store group for the store from the order. Database updates for an order item allocated from existing inventory: Table Attribute Description ORDRELEASE row(s) inserted for each release on this order Status='NEW'. ORDERITEM OrdReleaseNum the number of the containing release for the order

Parameters:

ordersId -

allocId - - not currently used.

Returns:

TypedProperty containing name-value pairs of returned values. RelNumStart The release number of the first release created. RelNumCount The number of releases created. Status "OK" - successful. CommitStatus "Y" - transaction should be committed. "N" - transaction should not be committed. SQLState error code. SPErrorCode for debug purposes - SQLSTATE for an unhandled SQLSTATE.

Throws:

javax.naming.NamingException

java.sql.SQLException

ParameterNotFoundException

InvalidParameterValueException

ECApplicationException

callCreateReleases
```
public static TypedProperty callCreateReleases(java.lang.Long ordersId,
                                               java.lang.Long allocId,
                                               java.lang.String storeIdList)
                                        throws javax.naming.NamingException,
                                               java.sql.SQLException,
                                               ParameterNotFoundException,
                                               InvalidParameterValueException,
                                               ECApplicationException
```
Call stored procedure CreateReleases

Parameters:

ordersId -

allocId - - not currently used.

storeIdList - - an explicit list of store ids to be used for accessing the STOREITEM table. This list is used instead of the default list of (order.storeid, storeitem storepath, store.groupid - where store is obtained from order.storeid)

Returns:

TypedProperty containing name-value pairs of returned values. RelNumStart The release number of the first release created. RelNumCount The number of releases created. Status "OK" - successful. CommitStatus "Y" - transaction should be committed. "N" - transaction should not be committed. SQLState error code. SPErrorCode for debug purposes - SQLSTATE for an unhandled SQLSTATE.

Throws:

javax.naming.NamingException

java.sql.SQLException

ParameterNotFoundException

InvalidParameterValueException

ECApplicationException

See Also:

callCreateReleases(Long,Long)

checkForError

public static void checkForError(java.lang.String astrSPName,
                                 TypedProperty aSPReturnCodes)
                          throws ECApplicationException,
                                 ParameterNotFoundException,
                                 InvalidParameterValueException

Parameters:: astrSPName -; aSPReturnCodes -
Throws:: ECApplicationException; ParameterNotFoundException; InvalidParameterValueException

callExpectedAvail

public static TypedProperty callExpectedAvail(java.lang.Integer storeId,
                                              java.lang.String raId,
                                              java.lang.String vendor,
                                              java.lang.String createTime,
                                              java.lang.String radetailId,
                                              java.lang.String externalId,
                                              java.lang.String openIndicator,
                                              java.lang.String orderDate,
                                              java.lang.String dateClosed,
                                              java.lang.String partNumber,
                                              java.lang.String raDetailComment,
                                              java.lang.String qtyRemaining,
                                              java.lang.String qtyOrdered,
                                              java.lang.String qtyReceived,
                                              java.lang.String ffmCenter,
                                              java.lang.String expectedDate,
                                              java.lang.String origExpectedDate,
                                              java.lang.String deleteFlag,
                                              java.lang.String raKeys,
                                              java.lang.String radetailKeys,
                                              java.lang.Integer inCount,
                                              java.lang.String sDelimiter,
                                              java.lang.String sRecCount,
                                              java.lang.String sCommitFlag)
                                       throws javax.naming.NamingException,
                                              java.sql.SQLException,
                                              ParameterNotFoundException,
                                              InvalidParameterValueException,
                                              ECApplicationException

Call the stored procedure ExpectedAvail

Parameters:: storeId -; raId -; vendor -; createTime -; radetailId -; externalId -; openIndicator -; orderDate -; dateClosed -; partNumber -; raDetailComment -; qtyRemaining -; qtyOrdered -; qtyReceived -; ffmCenter -; expectedDate -; origExpectedDate -; deleteFlag -; raKeys -; radetailKeys -; inCount -; sDelimiter -; sRecCount -; sCommitFlag -
Returns:: com.ibm.commerce.datatype.TypedProperty
Throws:: javax.naming.NamingException; java.sql.SQLException; ParameterNotFoundException; InvalidParameterValueException; ECApplicationException

Methods inherited from class java.lang.Object

COPYRIGHT

callAdjustInventory

callAvailInvStore

callAvailRADate

callBOItem

callGetItems

callGetItems

callRAAllocation

callReverseInventory

callShipItems

callShipItems

callShipItems

callCreateReleases

callCreateReleases

checkForError

callExpectedAvail