Interface OrderScheduleCmd

  • All Superinterfaces:
    AccCommand,,,, ControllerCommand, ECCommand, Protectable,,
    All Known Implementing Classes:

    public interface OrderScheduleCmd
    extends ControllerCommand
    This command submits a recurring order, which will be processed by the job scheduler. The default implementation of this command is OrderScheduleCmdImpl. The OrderSchedule is mapped to this command.
    • Field Detail


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

        static final java.lang.String NAME
        The name of the Command Interface class.
        See Also:
        Constant Field Values
    • Method Detail

      • setHost

        void setHost(java.lang.String astrHost)
        Sets the host name responsible for processing an order. Use this method when job scheduler instances are running on multiple hosts and processing this order needs to be restricted to a certain host.
        astrHost - java.lang.String - host name
      • setInterval

        void setInterval(java.lang.Integer anInterval)
        Sets the number of seconds between successive executions of this order.
        anInterval - java.lang.Integer - interval in seconds
      • setOrderId

        void setOrderId(java.lang.Long orderNumber)
        Sets the order which needs to be processed as a recurring order.
        orderNumber - java.lang.Long - order identifier
      • setOutOrderName

        void setOutOrderName(java.lang.String[] aarrOutOrderName)
        Sets the names of the name-value pairs to be added to the redirection URL. The value of each added name-value pair is the reference number of a scheduled order model.
        aarrOutOrderName - out order name
      • setRecoveryAttempts

        void setRecoveryAttempts(java.lang.Integer anRecAttempts)
        Sets the number of times the job scheduler will retry processing the order should order processing failure occur. When setting the number of recovery attempts you must also set the recovery delay (setRecoveryDelay())
        anRecAttempts - java.lang.Integer - number of recovery attempts
      • setRecoveryDelay

        void setRecoveryDelay(java.lang.Integer anRecDelay)
        Sets the amount of time (in seconds) before order processing is retried in case of order processing failure. When setting the recovery delay you must also set the number of recovery attempts (setRecoveryAttempts())
        anRecDelay - java.lang.Integer - number of seconds to delay between retrying to recover from order processing failure
      • setStartTime

        void setStartTime(java.lang.String astrStartTime)
        The time at which the first execution of this order should occur in the format YYYY:MM:DD:hh:mm:ss. Only hh:mm:ss is mandatory.
        astrStartTime - java.lang.String - start time for order processing