atg.commerce.payment.processor

Class ProcCreateStoreCreditInfo

    • Field Detail

      • CLASS_VERSION

        public static java.lang.String CLASS_VERSION
      • SUCCESS

        public static final int SUCCESS
        The possible return value for this processor.
        See Also:
        Constant Field Values
    • Constructor Detail

      • ProcCreateStoreCreditInfo

        public ProcCreateStoreCreditInfo()
    • Method Detail

      • getStoreCreditInfoClass

        public java.lang.String getStoreCreditInfoClass()
        Return the class to instantiate when creating a new StoreCreditInfo object.
      • setStoreCreditInfoClass

        public void setStoreCreditInfoClass(java.lang.String pStoreCreditInfoClass)
        Specify the class to instantiate when creating a new StoreCreditInfo object. If the GenericStoreCreditInfo class is extended to include more information, this property can be changed to reflect the new class.
      • addDataToStoreCreditInfo

        protected void addDataToStoreCreditInfo(Order pOrder,
                                    StoreCredit pPaymentGroup,
                                    double pAmount,
                                    PaymentManagerPipelineArgs pParams,
                                    GenericStoreCreditInfo pStoreCreditInfo)
        This method populates the StoreCreditInfo object with data. If the additional data is required, a subclass of StoreCreditInfo can be created with additional properties, the storeCreditInfoClass property can be changed to specify the new class, and this method can be overridden to add data for the new properties (or another pipeline processor could be added after this processor to populate the additional properties).
        Parameters:
        pOrder - The order being paid for.
        pPaymentGroup - The payment group being processed.
        pAmount - The amount being authorized, debited, or credited
        pParams - The parameter dictionary passed to this pipeline processor
        pStoreCreditInfo - An object that holds information understood by the store credit payment processor.
      • getStoreCreditInfo

        protected GenericStoreCreditInfo getStoreCreditInfo()
                                                     throws java.lang.Exception
        Factory method to create a new StoreCreditInfo object. The class that is created is that specified by the storeCreditInfoClass property, and must be a subclass of atg.payment.storecredit.GenericStoreCreditInfo.
        Returns:
        An object of the class specified by storeCreditInfoClass
        Throws:
        java.lang.Exception - if any instantiation error occurs when creating the info object
      • runProcess

        public int runProcess(java.lang.Object pParam,
                     PipelineResult pResult)
                       throws java.lang.Exception
        Generate a StoreCreditInfo object of the class specified by storeCreditInfoClass, populate it with data from a StoreCredit payment group by calling addDataToStoreCreditInfo, and add it to the pipeline argument dictionary so that downstream pipeline processors can access it.
        Specified by:
        runProcess in interface PipelineProcessor
        Parameters:
        pParam - Parameter dictionary of type PaymentManagerPipelineArgs.
        pResult - Pipeline result object, not used by this method.
        Returns:
        An integer value used to determine which pipeline processor is called next.
        Throws:
        java.lang.Exception - If any error occurs creating or populating the store credit card info object.
      • getRetCodes

        public int[] getRetCodes()
        Return the possible return values for this processor. This processor always returns a success code.
        Specified by:
        getRetCodes in interface PipelineProcessor
        Returns:
        an array of all the return codes that could be returned by this PipelineProcessor.