java.lang.Object | +--CacheableCommandImpl | +--com.ibm.commerce.command.AbstractECTargetableCommand | +--com.ibm.commerce.command.ControllerCommandImpl | +--com.ibm.commerce.tools.command.ToolsControllerCommandImpl | +--com.ibm.commerce.inventory.commands.ReleaseShipConfirmCmdImpl
Default implementation of the ReleaseShipConfirmCmd
interface.
Records 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.
If a redirect URL is not provided, ReleaseShipConfirmRedirectView will be called upon successful completion, and ReleaseShipConfirmErrorView upon failure. Utilizes these access beans:
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT The internal copyright field. |
Fields inherited from class com.ibm.commerce.command. ControllerCommandImpl |
requestProperties,
responseProperties,
retriable,
viewReqProperties |
Fields inherited from class com.ibm.commerce.command. AbstractECTargetableCommand |
commandContext |
Fields inherited from interface com.ibm.commerce.inventory.commands. ReleaseShipConfirmCmd |
defaultCommandClassName,
NAME |
Fields inherited from interface com.ibm.commerce.tools.common. ECToolsConstants |
EC_LINE_SEPARATOR,
EC_TOOLS_FULFILLMENT_CENTER_ID,
EC_TOOLS_MERCHANT_CENTER_URL,
EC_TOOLS_STORE_LANGUAGE_URL,
EC_TOOLS_STORES_ACCESS_CONTROL_REQUIRED,
EC_TOOLS_STORES_EMPTY,
EC_TOOLS_STORES_NO_ACCESS,
EC_TOOLS_STORES_NOT_ADMINISTRATOR,
EC_XML,
EC_XMLFILE,
EC_XMLFILEOBJECT,
EC_XMLOBJECT,
EC_XMLSTRING |
Constructor Summary | |
---|---|
ReleaseShipConfirmCmdImpl() |
Method Summary | |
---|---|
protected
void |
checkForeignKeyViolation() Checks for foreign key violation. |
protected
void |
checkIllegalArgumentException() Checks that the timestamp fields are in the correct timestamp format. |
protected
void |
checkNumberFormatException() Checks that the numeric fields are in the correct numeric format. |
java.lang.String |
getDateShipped() Returns the date the package shipped. |
java.lang.String |
getLastupdate() Returns the timestamp of last update. |
java.lang.String |
getManifestFound() Returns the flag to indicate if there is any shipment tracking information for the order release is found when the UpdateReleaseManifestStatusCmd is called. |
java.lang.String |
getManifestId() Returns manifest (package) identifier. |
java.lang.String |
getManifestStatus() Returns the status of the manifest (package). |
java.lang.String |
getOrdersId() Returns the identifier of the order. |
java.lang.String |
getOrdReleaseNum() Returns the release number of the order. |
java.lang.String |
getPackageId() Returns the identifier of the package. |
java.lang.String |
getPickupRecordId() Returns the pickup record identifier. |
AccessVector |
getResources() Gets the access vector accessed by this command. |
java.lang.String |
getSetCCurr() Returns currency in which the shipment was charged. |
java.lang.String |
getShipModeId() Returns the shipping provider. |
java.lang.String |
getShippingCosts() Returns the shipping costs. |
java.lang.String |
getTrackingId() Returns the tracking identifier. |
java.lang.String |
getUpdateManifestStatus() Returns the flag to indicate if the order and fulfillment status should be updated after the carrier and shipment tracking information is recorded. |
java.lang.String |
getWeight() Returns the weight of the package. |
java.lang.String |
getWeightMeasure() Returns the unit of measure of the package weight. |
protected
void |
handleSubmitError(
ECException e) Constructs and returns the error message based on the error properties set by the caller. |
void |
performExecute() Records carrier and shipment tracking information when the order release is packed and shipped. |
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 |
setManifestFound(java.lang.String newManifestFound) Sets the flag to indicate if there is any shipment tracking information for the order release is found. |
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. |
void |
validateParameters() Gets the carrier and shipment tracking information and sets the information into the command local variable. |
Methods inherited from class com.ibm.commerce.tools.command. ToolsControllerCommandImpl |
getViewInputProperties,
setRequestProperties |
Methods inherited from class com.ibm.commerce.command. ControllerCommandImpl |
checkPermission,
fulfills,
getForUserId,
getGeneric,
getOwner,
getRequestProperties,
getResolvedRequestProperties,
getResourceOwners,
getResponseProperties,
getRetriable,
isGeneric,
isRetriable,
mergeProperties,
setForUserId,
setGeneric,
setOwner,
setResponseProperties,
setRetriable,
setViewInputProperties |
Methods inherited from class com.ibm.commerce.command. AbstractECTargetableCommand |
accessControlCheck,
checkIsAllowed,
checkParameters,
checkResourcePermission,
createCommandExecutionEvent,
execute,
finalize,
getAccCheck,
getCommandContext,
getCommandIfName,
getCommandName,
getCommandStoreId,
getDefaultProperties,
getStoreId,
getUser,
getUserId,
isReadyToCallExecute,
reset,
setAccCheck,
setCommandContext,
setCommandIfName,
setCommandStoreId,
setDefaultProperties |
Methods inherited from class java.lang.Object |
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait,
wait, wait |
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,
getStoreId,
getUser,
getUserId,
setCommandContext,
setCommandIfName,
setCommandStoreId,
setDefaultProperties |
Field Detail |
---|
public static final java.lang.String COPYRIGHT
Constructor Detail |
---|
public ReleaseShipConfirmCmdImpl()
Method Detail |
---|
public java.lang.String getDateShipped()
public java.lang.String getLastupdate()
public java.lang.String getManifestId()
public java.lang.String getManifestFound()
UpdateReleaseManifestStatusCmd
is called.
public java.lang.String getManifestStatus()
public java.lang.String getOrdersId()
public java.lang.String getOrdReleaseNum()
public java.lang.String getPackageId()
public java.lang.String getPickupRecordId()
public java.lang.String getSetCCurr()
public java.lang.String getShipModeId()
public java.lang.String getShippingCosts()
public java.lang.String getTrackingId()
public java.lang.String getUpdateManifestStatus()
public java.lang.String getWeight()
public java.lang.String getWeightMeasure()
public void setDateShipped(java.lang.String newDateShipped)
ReleaseShipConfirmCmd
setDateShipped
in interface
ReleaseShipConfirmCmd
newDateShipped
- shipped datepublic void setLastupdate(java.lang.String newLastupdate)
ReleaseShipConfirmCmd
setLastupdate
in interface
ReleaseShipConfirmCmd
newLastupdate
- last updatepublic void setManifestId(java.lang.String newManifestId)
ReleaseShipConfirmCmd
setManifestId
in interface
ReleaseShipConfirmCmd
newManifestId
- package idpublic void setManifestFound(java.lang.String newManifestFound)
newManifestFound
- shipment tracking information
flagpublic void setManifestStatus(java.lang.String newManifestStatus)
ReleaseShipConfirmCmd
setManifestStatus
in interface
ReleaseShipConfirmCmd
newManifestStatus
- package statuspublic void setOrdersId(java.lang.String newOrdersId)
ReleaseShipConfirmCmd
setOrdersId
in interface
ReleaseShipConfirmCmd
newOrdersId
- order idpublic void setOrdReleaseNum(java.lang.String newOrdReleaseNum)
ReleaseShipConfirmCmd
setOrdReleaseNum
in interface
ReleaseShipConfirmCmd
newOrdReleaseNum
- order release numberpublic void setPackageId(java.lang.String newPackageId)
ReleaseShipConfirmCmd
setPackageId
in interface
ReleaseShipConfirmCmd
newPackageId
- package idpublic void setPickupRecordId(java.lang.String newPickupRecordId)
ReleaseShipConfirmCmd
setPickupRecordId
in interface
ReleaseShipConfirmCmd
newPickupRecordId
- pickup record idpublic void setSetCCurr(java.lang.String newSetCCurr)
ReleaseShipConfirmCmd
setSetCCurr
in interface
ReleaseShipConfirmCmd
newSetCCurr
- currencypublic void setShipModeId(java.lang.String newShipModeId)
ReleaseShipConfirmCmd
setShipModeId
in interface
ReleaseShipConfirmCmd
newShipModeId
- shipping providerpublic void setShippingCosts(java.lang.String newShippingCosts)
ReleaseShipConfirmCmd
setShippingCosts
in interface
ReleaseShipConfirmCmd
newShippingCosts
- shipping costspublic void setTrackingId(java.lang.String newTrackingId)
ReleaseShipConfirmCmd
setTrackingId
in interface
ReleaseShipConfirmCmd
newTrackingId
- tracking idpublic void setUpdateManifestStatus(java.lang.String newUpdateManifestStatus)
ReleaseShipConfirmCmd
setUpdateManifestStatus
in interface
ReleaseShipConfirmCmd
newUpdateManifestStatus
- status flagpublic void setWeight(java.lang.String newWeight)
ReleaseShipConfirmCmd
setWeight
in interface
ReleaseShipConfirmCmd
newWeight
- package weightpublic void setWeightMeasure(java.lang.String newWeightMeasure)
ReleaseShipConfirmCmd
setWeightMeasure
in interface
ReleaseShipConfirmCmd
newWeightMeasure
- unit of measurepublic void validateParameters() throws ECException
It also sets the success redirect URL to the URL provided in the command. If
a redirect URL is not provided, success redirect URL is set to
ReleaseShipConfirmRedirectView
Verifies that the following
parameters are set:
Calls
checkForeignKeyViolation()
and
handleSubmitError(com.ibm.commerce.exception.ECException)
.
validateParameters
in interface
ECCommand
validateParameters
in class
AbstractECTargetableCommand
ECApplicationException
- If the XMLObject cannot be parsed as
expected, throw ECApplicationException. Specify _ERR_BAD_MISSING_CMD_PARAMETER
if a required parameter is missing or bad.ECException
public AccessVector getResources() throws ECException
OrderItemAccessBean
to get the fulfillment center id which is
used to get the
FulfillmentCenterAccessBean
which is returned as an
AccessVector.
getResources
in interface
ECCommand
getResources
in class
AbstractECTargetableCommand
ECException
protected void checkForeignKeyViolation() throws ECApplicationException
ECApplicationException
- Throw ECApplicationException to indicate
which foreign or unique key is violated.public void performExecute() throws ECException
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.
Insert the manifest record using the
ManifestAccessBean
. Update with the properties supplied
previously.
Sets the output parameters manifest id and manifest found status flag.
performExecute
in interface
ECCommand
performExecute
in class
AbstractECTargetableCommand
ECException
-
checkIllegalArgumentException()
,
checkNumberFormatException()
,
handleSubmitError(com.ibm.commerce.exception.ECException)
,
UpdateReleaseManifestStatusCmd
protected void checkNumberFormatException() throws ECApplicationException
ECApplicationException
- Specifies message _ERR_CMD_INVALID_PARAM
indicating which field is bad.protected void checkIllegalArgumentException() throws ECApplicationException
ECApplicationException
- Specifies
_ERR_CMD_INVALID_PARAM.protected void handleSubmitError(ECException e) throws ECApplicationException
com.ibm.commerce.exception.ECApplicationException.
- Throw
ECApplicationException with the newly constructed message.
ECApplicationException