com.ibm.commerce.inventory.commands
Interface ReleaseManifestCmd

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

public interface ReleaseManifestCmd
extends ToolsControllerCommand

Updates order status and fulfillment status after the order release is packed and shipped.

This controller command will call UpdateReleaseManifestStatusCmd to update the order status and fulfillment status. If the order release is packed and shipped, the status of the order release will be set to 'MNF', the fulfillment status of all the order items in the order release will be set to 'SHIP', and the status of the order will be set to 'S' if all order items in the order are packed and shipped.

URL calling syntax

https://host_name/path/ReleaseManifest?ordersId=order_Id&ordReleaseNum=order_release_number&URL=return_url

Parameters

ordersId
The identifier of the order.
ordReleaseNum
The order release number.
URL
The URL to be called when the command completes successfully.

Response Parameters

manifestFound
Return the flag to indicate if there is any shipment tracking information for the order release is found.

Exceptions

When the required fields are missing or not in the right datatype, 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.ReleaseManifestCmdImpl".
static java.lang.String NAME
          The name of this interface is "com.ibm.commerce.inventory.commands.ReleaseManifestCmd".
 
Method Summary
 void setOrdersId(java.lang.String newOrdersId)
          Sets the order identifier.
 void setOrdReleaseNum(java.lang.String newOrdReleaseNum)
          Sets the order release number.
 void setRequestProperties( TypedProperty reqParms)
          Sets the command request properties.
 
Methods inherited from interface com.ibm.commerce.command. ControllerCommand
checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, 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.ReleaseManifestCmd".
See Also:
Constant Field Values

defaultCommandClassName

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

setOrdersId

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

setOrdReleaseNum

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

setRequestProperties

public void setRequestProperties(TypedProperty reqParms)
                          throws ECApplicationException
Sets the command request properties.
Specified by:
setRequestProperties in interface ControllerCommand
Parameters:
reqParms - request properties
ECApplicationException