com.ibm.commerce.order.commands

Class ScheduledOrderCancelCmdImpl

  • All Implemented Interfaces:
    AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, ScheduledOrderCancelCmd, Protectable, com.ibm.websphere.cache.Sizeable, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, com.ibm.websphere.command.TargetableCommand, java.io.Serializable

    public class ScheduledOrderCancelCmdImpl
extends ControllerCommandImpl
implements ScheduledOrderCancelCmd
    This is the implementation of the ScheduledOrderCancelCmd controller command.

    Behaviour:

    • It cancels execution of a scheduled order by deactivating the scheduler job that is responsible for processing this order.
    • It Removes an entry from the SCHORDERS table that associates the reference number of the scheduled order with the scheduler job reference number.

    Input parameters:

    Name Description
    forUser The logon ID of the user on whose behalf the command will be run. Only a person with the authority to process orders can specify this parameter.
    forUserId Same as forUser, but identifying the user by the internal user ID as found in the USERS table.
    langId Sets or resets the preferred language for the duration of the session; the supported languages for a store are found in the STORELANG table.
    URL (Required) The URL to be called when the command completes successfully.
    orderId (Required) The reference number of the scheduled order to be canceled.

    Output parameters:

    None.

    Task commands called:

    None.
    See Also:
    Serialized Form

    • Field Detail

      • COPYRIGHT

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

    • Constructor Detail

      • ScheduledOrderCancelCmdImpl

        public ScheduledOrderCancelCmdImpl()
        This is the constructor.

    • Method Detail

      • getJobId

        public java.lang.Long getJobId()
        This method gets scheduler job id which needs to be disabled.
        Returns:
        A Long that specifies the job id.

      • getOrderId

        public java.lang.Long getOrderId()
        This method gets the order identifier.
        Returns:
        A Long that specifies the order id.

      • getRemoveJobCmd

        public RemoveJobCmd getRemoveJobCmd()
        This method gets the instance of the RemoveJob command.
        Returns:
        A RemoveJobCmd.

      • getUrl

        public java.lang.String getUrl()
        This method returns the redirection url to be called when the command completes successfully.
        Returns:
        A String that specifies the URL.

      • setJobId

        public void setJobId(java.lang.Long newJobId)
        This method sets scheduler job id which needs to be disabled.
        Parameters:
        newJobId - A Long that specifies the job id.

      • setOrderId

        public void setOrderId(java.lang.Long newOrderId)
        This method sets order identifier
        Specified by:
        setOrderId in interface ScheduledOrderCancelCmd
        Parameters:
        newOrderId - A Long that specifies the order id.

      • setRemoveJobCmd

        public void setRemoveJobCmd(RemoveJobCmdImpl newRemoveJobCmd)
        This method sets the instance of the RemoveJob command.
        Parameters:
        newRemoveJobCmd - A RemoveJobCmdImpl reference.

      • setUrl

        public void setUrl(java.lang.String astrUrl)
        This method sets the redirection url to be called when the command completes successfully.
        Specified by:
        setUrl in interface ScheduledOrderCancelCmd
        Parameters:
        astrUrl - A String that specifies the URL.
Skip navigation links