com.ibm.commerce.inventory.commands
Interface ReleaseShipConfirmCmd

All Superinterfaces:
AccCommand, ControllerCommand, ECCommand, ToolsControllerCommand
All Known Implementing Classes:
ReleaseShipConfirmCmdImpl

public interface ReleaseShipConfirmCmd
extends ToolsControllerCommand

Records carrier and shipment tracking information when the order release is packed and shipped. If the updateManifestStatus flag is set to "1", the UpdateReleaseManifestStatusCmd task command will be called to update order status and fulfillment status after shipment tracking information is recorded.

Parameters

EC_XMLObject
An input xml_string that contains all required data for recording carrrier and shipment tracking information.

Example xml_string for recording carrrier and shipment tracking information:

 
 <?xml version="1.0" encoding="UTF-8"?>
 <XML>
 <XMLFile>inventory.PackageDetail</XMLFile>
 <dateShipped>2001-10-30 00:00:00.0</dateShipped>
 <ordersId>100</ordersId>
 <ordReleaseNum>1</ordReleaseNum>
 <packageId>Package 123</packageId>
 <pickupRecordId>Record 456</pickupRecordId> 
 <setCCurr>CAD</setCCurr>
 <shipModeId>100</shipModeId>
 <shippingCosts>120.5</shippingCosts>
 <trackingId>track 789</trackingId>
 <updateManifestStatus>0</updateManifestStatus>
 <weight>28</weight> 
 <weightMeasure>KGM</weightMeasure>
 </XML>

URL
The URL to be called when the command completes successfully.

Response Parameters

manifestId
Return the identifer of the manifest updated.
manifestFound
Return the manifest found status flag.

Exceptions

When the required fields are missing or not in the right data type, this command will throw exception to indicate which field is missing or bad.


Field Summary
static java.lang.String COPYRIGHT
          The internal copyright field.
static java.lang.String defaultCommandClassName
          The default implementation class name is "com.ibm.commerce.inventory.commands.ReleaseShipConfirmCmdImpl".
static java.lang.String NAME
          The name of this interface is "com.ibm.commerce.inventory.commands.ReleaseShipConfirmCmd".
 
Method Summary
 void setDateShipped(java.lang.String newDateShipped)
          Sets the date the package shipped.
 void setLastupdate(java.lang.String newLastupdate)
          Sets the timestamp of last update.
 void setManifestId(java.lang.String newManifestId)
          Sets the manifest (package) identifier.
 void setManifestStatus(java.lang.String newManifestStatus)
          Sets the status of the manifest (package).
 void setOrdersId(java.lang.String newOrdersId)
          Sets the order identifier.
 void setOrdReleaseNum(java.lang.String newOrdReleaseNum)
          Sets the order release number.
 void setPackageId(java.lang.String newPackageId)
          Sets the package identifier.
 void setPickupRecordId(java.lang.String newPickupRecordId)
          Sets the pickup record identifier.
 void setSetCCurr(java.lang.String newSetCCurr)
          Sets the currency in which the shipment was charged.
 void setShipModeId(java.lang.String newShipModeId)
          Sets the shipping provider.
 void setShippingCosts(java.lang.String newShippingCosts)
          Sets the shipping costs.
 void setTrackingId(java.lang.String newTrackingId)
          Sets the tracking identifier.
 void setUpdateManifestStatus(java.lang.String newUpdateManifestStatus)
          Sets the flag to indicate if the order and fulfillment status should be updated after the carrier and shipment tracking information is recorded.
 void setWeight(java.lang.String newWeight)
          Sets the weight of the package.
 void setWeightMeasure(java.lang.String newWeightMeasure)
          Sets the unit of measure of the package weight.
 
Methods inherited from interface com.ibm.commerce.command. ControllerCommand
checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRequestProperties, setRetriable, setViewInputProperties
 
Methods inherited from interface com.ibm.commerce.command. AccCommand
accessControlCheck, getAccCheck, getForUserId, getResourceOwners, setAccCheck, setForUserId, setOwner
 
Methods inherited from interface com.ibm.commerce.command. ECCommand
checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
 

Field Detail
public static final java.lang.String COPYRIGHT
The internal copyright field.
See Also:
Constant Field Values

NAME

public static final java.lang.String NAME
The name of this interface is "com.ibm.commerce.inventory.commands.ReleaseShipConfirmCmd".
See Also:
Constant Field Values

defaultCommandClassName

public static final java.lang.String defaultCommandClassName
The default implementation class name is "com.ibm.commerce.inventory.commands.ReleaseShipConfirmCmdImpl".
See Also:
Constant Field Values
Method Detail

setDateShipped

public void setDateShipped(java.lang.String newDateShipped)
Sets the date the package shipped.
Parameters:
newDateShipped - shipped date

setLastupdate

public void setLastupdate(java.lang.String newLastupdate)
Sets the timestamp of last update.
Parameters:
newLastupdate - time

setManifestId

public void setManifestId(java.lang.String newManifestId)
Sets the manifest (package) identifier.
Parameters:
newManifestId - package id

setManifestStatus

public void setManifestStatus(java.lang.String newManifestStatus)
Sets the status of the manifest (package).
Parameters:
newManifestStatus - status

setOrdersId

public void setOrdersId(java.lang.String newOrdersId)
Sets the order identifier.
Parameters:
newOrdersId - order id

setOrdReleaseNum

public void setOrdReleaseNum(java.lang.String newOrdReleaseNum)
Sets the order release number.
Parameters:
newOrdReleaseNum - release number

setPackageId

public void setPackageId(java.lang.String newPackageId)
Sets the package identifier.
Parameters:
newPackageId - package id

setPickupRecordId

public void setPickupRecordId(java.lang.String newPickupRecordId)
Sets the pickup record identifier.
Parameters:
newPickupRecordId - pickup record id

setSetCCurr

public void setSetCCurr(java.lang.String newSetCCurr)
Sets the currency in which the shipment was charged.
Parameters:
newSetCCurr - currency

setShipModeId

public void setShipModeId(java.lang.String newShipModeId)
Sets the shipping provider.
Parameters:
newShipModeId - shipping provider

setShippingCosts

public void setShippingCosts(java.lang.String newShippingCosts)
Sets the shipping costs.
Parameters:
newShippingCosts - shipping costs

setTrackingId

public void setTrackingId(java.lang.String newTrackingId)
Sets the tracking identifier.
Parameters:
newTrackingId - tracking id

setUpdateManifestStatus

public void setUpdateManifestStatus(java.lang.String newUpdateManifestStatus)
Sets the flag to indicate if the order and fulfillment status should be updated after the carrier and shipment tracking information is recorded.
Parameters:
newUpdateManifestStatus - status flag

setWeight

public void setWeight(java.lang.String newWeight)
Sets the weight of the package.
Parameters:
newWeight - package weight

setWeightMeasure

public void setWeightMeasure(java.lang.String newWeightMeasure)
Sets the unit of measure of the package weight.
Parameters:
newWeightMeasure - weight measure