atg.projects.store.fulfillment.processor
Class ProcDeliverGiftCertificate

java.lang.Object
  atg.commerce.fulfillment.processor.ProcDeliverElectronicGoodByTemplate
      atg.projects.store.fulfillment.processor.ProcDeliverGiftCertificate

All Implemented Interfaces:

atg.service.pipeline.PipelineProcessor

public class ProcDeliverGiftCertificate
extends atg.commerce.fulfillment.processor.ProcDeliverElectronicGoodByTemplate

This processor delivers a gift certificate by an email template.

Field Summary

static java.lang.String	CLASS_VERSION Class version string.
static java.lang.String	MSG_INVALID_ORDER_FULFILLER_PARAMETER
static java.lang.String	MSG_INVALID_ORDER_PARAMETER
protected static java.lang.String	MY_RESOURCE_NAME Resourse bundle name.
protected static java.util.ResourceBundle	sResourceBundle Resource Bundle.
protected int	SUCCESS Success constant.

Fields inherited from interface atg.service.pipeline.PipelineProcessor

STOP_CHAIN_EXECUTION, STOP_CHAIN_EXECUTION_AND_COMMIT, STOP_CHAIN_EXECUTION_AND_ROLLBACK

Constructor Summary

ProcDeliverGiftCertificate()

Method Summary

protected atg.userprofiling.email.TemplateEmailInfo	createTemplateEmailInfo(StoreElectronicFulfiller of, atg.repository.RepositoryItem pGiftCertificate, long pQuantity, atg.commerce.order.ShippingGroup pShippingGroup) Creates and returns the TemplateEmailInfo to use for sending email within this action.
int	runProcess(java.lang.Object pParam, atg.service.pipeline.PipelineResult pResult) This processor delivers an electronic item by the email template.

Methods inherited from class atg.commerce.fulfillment.processor.ProcDeliverElectronicGoodByTemplate

createTemplateEmailInfo, getProfileForOrder, getRetCodes

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string.

MSG_INVALID_ORDER_PARAMETER

public static final java.lang.String MSG_INVALID_ORDER_PARAMETER

See Also:

Constant Field Values

MSG_INVALID_ORDER_FULFILLER_PARAMETER

public static final java.lang.String MSG_INVALID_ORDER_FULFILLER_PARAMETER

See Also:

Constant Field Values

MY_RESOURCE_NAME

protected static final java.lang.String MY_RESOURCE_NAME

Resourse bundle name.

See Also:

Constant Field Values

sResourceBundle

protected static java.util.ResourceBundle sResourceBundle

Resource Bundle.

SUCCESS

protected final int SUCCESS

Success constant.

See Also:

Constant Field Values

Constructor Detail

ProcDeliverGiftCertificate

public ProcDeliverGiftCertificate()

Method Detail

runProcess

public int runProcess(java.lang.Object pParam,
                      atg.service.pipeline.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 atg.service.pipeline.PipelineProcessor

Overrides:

runProcess in class atg.commerce.fulfillment.processor.ProcDeliverElectronicGoodByTemplate

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 atg.userprofiling.email.TemplateEmailInfo createTemplateEmailInfo(StoreElectronicFulfiller of,
                                                                            atg.repository.RepositoryItem pGiftCertificate,
                                                                            long pQuantity,
                                                                            atg.commerce.order.ShippingGroup pShippingGroup)

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

Parameters:

of - - electronic fulfiller

pGiftCertificate - The gift certificate being emailed

pQuantity - The number of gift certificates

pShippingGroup - - shipping group

Returns:

template e-mail information