com.ibm.commerce.edp.tickler

Interface IEDPTickler

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      IBM copyright notice field.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      void addComments(java.lang.String comment)
      This method adds the tickler comment.
      CommandContext getCommandContext()
      This method returns the command context of the command where the tickler is sent.
      java.lang.String[] getComments()
      This method returns the tickler comments.
      javax.swing.AbstractAction getEDPAction()
      This method returns the action that created this tickler.
      java.lang.Long getEDPOrderId()
      This method returns the EDPOrder ID the tickler refered to.
      java.lang.Long getEDPPaymentInstructionId()
      This method returns the Payment Rules Payment Instruction ID the tickler refered to.
      java.lang.Long getOrderId()
      This method returns the order identifier in order system, Note that it is different from EDPOrderId.
      java.lang.String getReason()
      This method returns the short representation of the reason.
      java.lang.String getReasonCode()
      This method returns the reason code, and this is optional field.
      java.lang.Integer getStoreId()
      This method returns the identifier of store this order belongs to in order system.
      void sendTickler()
      This method asks this tickler to send itself to the tickler queue
      void setCommandContext(CommandContext context)
      This method sets the command context of the command where the tickler is sent.
      void setComments(java.lang.String[] comments)
      This method sets the tickler comments.
      void setEDPAction(javax.swing.AbstractAction edpAction)
      This method sets the action that created this tickler.
      void setEDPOrderId(java.lang.Long orderId)
      This method sets the EDPOrder ID the tickler refered to.
      void setEDPPaymentInstructionId(java.lang.Long piId)
      This method sets the Payment Rules Payment Instruction ID the tickler refered to.
      void setOrderId(java.lang.Long orderId)
      This method sets the order identifier in order system.
      void setReason(java.lang.String reason)
      This method sets the tickler reason using the string representation.
      void setReasonCode(java.lang.String reasonCode)
      This method sets the string representation of the reason code.
      void setStoreId(java.lang.Integer storeId)
      This method sets the identifier of store this order belongs to in order system.

    • Field Detail

      • COPYRIGHT

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

    • Method Detail

      • getComments

        java.lang.String[] getComments()
        This method returns the tickler comments.
        Returns:
        The list to tickler comments

      • setComments

        void setComments(java.lang.String[] comments)
        This method sets the tickler comments.
        Parameters:
        comments - Comments array of String

      • setEDPAction

        void setEDPAction(javax.swing.AbstractAction edpAction)
        This method sets the action that created this tickler.
        Parameters:
        edpAction - The action that created this tickler

      • getEDPAction

        javax.swing.AbstractAction getEDPAction()
        This method returns the action that created this tickler.
        Returns:
        The Payment Rules action, which created this tickler

      • setEDPOrderId

        void setEDPOrderId(java.lang.Long orderId)
        This method sets the EDPOrder ID the tickler refered to.
        Parameters:
        orderId - The EDPOrder ID

      • getEDPOrderId

        java.lang.Long getEDPOrderId()
        This method returns the EDPOrder ID the tickler refered to.
        Returns:
        The EDPOrder ID

      • setEDPPaymentInstructionId

        void setEDPPaymentInstructionId(java.lang.Long piId)
        This method sets the Payment Rules Payment Instruction ID the tickler refered to.
        Parameters:
        piId - The Payment Rules Payment Instruction ID

      • getEDPPaymentInstructionId

        java.lang.Long getEDPPaymentInstructionId()
        This method returns the Payment Rules Payment Instruction ID the tickler refered to.
        Returns:
        The Payment Rules Payment Instruction ID

      • setReason

        void setReason(java.lang.String reason)
        This method sets the tickler reason using the string representation.
        Parameters:
        reason - The reason of the tickler

      • getReason

        java.lang.String getReason()
        This method returns the short representation of the reason.
        Returns:
        Short description of this tickler

      • setReasonCode

        void setReasonCode(java.lang.String reasonCode)
        This method sets the string representation of the reason code.
        Parameters:
        reasonCode - The string representation of the reason code

      • getReasonCode

        java.lang.String getReasonCode()
        This method returns the reason code, and this is optional field.
        Returns:
        The tickler reason code

      • setOrderId

        void setOrderId(java.lang.Long orderId)
        This method sets the order identifier in order system. Note that it is different from EDPOrderId.
        Parameters:
        orderId - The order ID in order system

      • getOrderId

        java.lang.Long getOrderId()
        This method returns the order identifier in order system, Note that it is different from EDPOrderId.
        Returns:
        A Long object represents the order identifier in order system

      • setStoreId

        void setStoreId(java.lang.Integer storeId)
        This method sets the identifier of store this order belongs to in order system.
        Parameters:
        storeId - The store ID this order belongs to in order system

      • getStoreId

        java.lang.Integer getStoreId()
        This method returns the identifier of store this order belongs to in order system.
        Returns:
        An Integer Object ID of a store

      • addComments

        void addComments(java.lang.String comment)
        This method adds the tickler comment.
        Parameters:
        comment - The comment to be added to the tickler

      • sendTickler

        void sendTickler()
          throws EDPException
        This method asks this tickler to send itself to the tickler queue
        Throws:
        EDPException - If the tickler cannot be sent

      • getCommandContext

        CommandContext getCommandContext()
        This method returns the command context of the command where the tickler is sent.
        Returns:
        The command context of the command where the tickler is sent

      • setCommandContext

        void setCommandContext(CommandContext context)
        This method sets the command context of the command where the tickler is sent.
        Parameters:
        context - The command context of the command where the tickler is sent
Skip navigation links