atg.commerce.fulfillment.processor
Class ProcDeliverElectronicGoodByTemplate

java.lang.Object
  atg.commerce.fulfillment.processor.ProcDeliverElectronicGoodByTemplate

All Implemented Interfaces:

PipelineProcessor

public class ProcDeliverElectronicGoodByTemplate
extends java.lang.Object
implements PipelineProcessor

This processor delivers an electronic item by the email template

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Fields inherited from interface atg.service.pipeline.PipelineProcessor

STOP_CHAIN_EXECUTION, STOP_CHAIN_EXECUTION_AND_COMMIT, STOP_CHAIN_EXECUTION_AND_ROLLBACK

Constructor Summary

ProcDeliverElectronicGoodByTemplate()

Method Summary

protected TemplateEmailInfo	createTemplateEmailInfo(ElectronicFulfiller of, RepositoryItem pPurchaser, RepositoryItem pGiftCertificate, long pQuantity, java.lang.String pRecipientEmail) Creates and returns the TemplateEmailInfo to use for sending email within this action.
protected RepositoryItem	getProfileForOrder(ElectronicFulfiller of, Order pOrder) Uses the profile repository to get the profile RepositoryItem for the profileId in the order.
int[]	getRetCodes() Returns the valid return codes 1 - The processor completed
int	runProcess(java.lang.Object pParam, PipelineResult pResult) This processor delivers an electronic item by the email template This method requires that an Order and OrderFulfiller object be supplied in pParam in a HashMap.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Constructor Detail

ProcDeliverElectronicGoodByTemplate

public ProcDeliverElectronicGoodByTemplate()

Method Detail

getRetCodes

public int[] getRetCodes()

Returns the valid return codes 1 - The processor completed

Specified by:

getRetCodes in interface PipelineProcessor

Returns:

an integer array of the valid return codes.

runProcess

public int runProcess(java.lang.Object pParam,
                      PipelineResult pResult)
               throws java.lang.Exception

This processor delivers an electronic item by the email template This method requires that an Order and OrderFulfiller object be supplied in pParam in a HashMap. Use the PipelineConstants class' static members to key the objects in the HashMap.

Specified by:

runProcess in interface PipelineProcessor

Parameters:

pParam - a HashMap which must contain an Order and OrderFulfiller object

pResult - a PipelineResult object which stores any information which must be returned from this method invokation

Returns:

an integer specifying the processor's return code

Throws:

java.lang.Exception - throws any exception back to the caller

See Also:

PipelineProcessor.runProcess(Object, PipelineResult)

createTemplateEmailInfo

protected TemplateEmailInfo createTemplateEmailInfo(ElectronicFulfiller of,
                                                    RepositoryItem pPurchaser,
                                                    RepositoryItem pGiftCertificate,
                                                    long pQuantity,
                                                    java.lang.String pRecipientEmail)

Creates and returns the TemplateEmailInfo to use for sending email within this action.

Parameters:

pGiftCertificate - The gift certificate being emailed

pQuantity - The number of gift certificates

getProfileForOrder

protected RepositoryItem getProfileForOrder(ElectronicFulfiller of,
                                            Order pOrder)
                                     throws RepositoryException

Uses the profile repository to get the profile RepositoryItem for the profileId in the order.

Throws:

RepositoryException