com.ibm.commerce.inventory.commands
Interface ReleaseShipConfirmCmd

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

public interface ReleaseShipConfirmCmd
extends ToolsControllerCommand

Record carrier and shipment tracking information when the order release is packed and shipped. If the updateManifestStatus flag is set to "1", the UpdateReleaseManifestStatusCmd 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.

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
           
static java.lang.String defaultCommandClassName
          The default implementation class name.
static java.lang.String NAME
           
 
Method Summary
 void setDateShipped(java.lang.String newDateShipped)
          Set the date the package shipped.
 void setLastupdate(java.lang.String newLastupdate)
          Set the timestamp of last update.
 void setManifestId(java.lang.String newManifestId)
          Set manifest (package) identifier.
 void setManifestStatus(java.lang.String newManifestStatus)
          Set the status of the manifest (package).
 void setOrdersId(java.lang.String newOrdersId)
          Set the order identifier.
 void setOrdReleaseNum(java.lang.String newOrdReleaseNum)
          Set order release number.
 void setPackageId(java.lang.String newPackageId)
          Set package identifier.
 void setPickupRecordId(java.lang.String newPickupRecordId)
          Set pickup record identifier.
 void setSetCCurr(java.lang.String newSetCCurr)
          Set currency in which the shipment was charged.
 void setShipModeId(java.lang.String newShipModeId)
          Set shipping provider.
 void setShippingCosts(java.lang.String newShippingCosts)
          Set shipping costs.
 void setTrackingId(java.lang.String newTrackingId)
          Set tracking identifier.
 void setUpdateManifestStatus(java.lang.String newUpdateManifestStatus)
          Set 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)
          Set the weight of the package.
 void setWeightMeasure(java.lang.String newWeightMeasure)
          Set the unit of measure of the package weight.
 
Methods inherited from interface com.ibm.commerce.command.ControllerCommand
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, setAccCheck, setForUserId, setOwner
 
Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters
 
Methods inherited from interface com.ibm.commerce.security.Protectable
fulfills, getOwner
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

defaultCommandClassName

public static final java.lang.String defaultCommandClassName
The default implementation class name.

NAME

public static final java.lang.String NAME
Method Detail

setDateShipped

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

setLastupdate

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

setManifestId

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

setManifestStatus

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

setOrdersId

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

setOrdReleaseNum

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

setPackageId

public void setPackageId(java.lang.String newPackageId)
Set package identifier.
Parameters:
newPackageId - java.lang.String

setPickupRecordId

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

setSetCCurr

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

setShipModeId

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

setShippingCosts

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

setTrackingId

public void setTrackingId(java.lang.String newTrackingId)
Set tracking identifier.
Parameters:
newTrackingId - java.lang.String

setUpdateManifestStatus

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

setWeight

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

setWeightMeasure

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