atg.service.pipeline

Interface PipelineProcessor

All Known Implementing Classes:

atg.adc.pipeline.ADCEventPipelineProcessor, ADCPipelineProcessor, AppendStringProcessor, AssignmentProcessor, CanPurgeProcessor, CheckForNoInsertProcessor, CopyInvoiceRequestProperties, EmptyProcessor, EventSender, ExtraTagsProcessor, GenerateInvoiceMessage, atg.adc.pipeline.PageNameProcessor, atg.adc.pipeline.PatternMappingProcessor, PriceOrderTotal, ProcAddApprovalSystemMessagesToOrder, ProcAddApproverIdsToOrder, ProcAddApproverIdToOrder, ProcAddApproverMessagesToOrder, ProcAddMessageMapperErrorToOrder, ProcAddOrderToRepository, ProcAddProductViewed, ProcAdjustSuggestedAmountsForNonReturnItems, ProcAllocateElectronicGood, ProcAllocateItemRelationship, ProcAllocateShippingGroup, ProcApplyChanges, ProcApprovalCompleteAnalyzer, ProcAuthorizePayment, ProcAuthorizePaymentGroups, ProcCalculateNewAmounts, ProcCalculateReturnFee, ProcCalculateSuggestedRefunds, ProcCancelRemoveOrder, ProcChangeOrderState, ProcCheckForDiscontinuedProducts, ProcCheckForErrors, ProcCheckForExpiredPromotions, ProcCheckOrderState, ProcCheckRequisitionNumbers, ProcCloneOrderForEdit, ProcCompleteQuoteRequest, ProcCreateCreditCardInfo, ProcCreateElectronicGood, ProcCreateGiftCertificateInfo, ProcCreateImplicitRelationships, ProcCreateInStorePaymentInfo, ProcCreateInvoiceRequestInfo, ProcCreateReplacementOrderPaymentGroups, ProcCreateReplacementOrderShippingGroups, ProcCreateReturnItemList, ProcCreateStoreCreditInfo, ProcCreditCardModCheck, ProcCreditOrder, ProcDeliverElectronicGoodByListener, ProcDeliverElectronicGoodByTemplate, ProcDispatchOnOrderState, ProcDispatchOnProperty, ProcExecuteChain, ProcExecuteFulfillOrderFragment, ProcExecuteSubmitReplacementOrder, ProcExtractOrderId, ProcExtractShippingGroupIds, ProcFailOrder, ProcFinishOrder, ProcFinishRemoveOrder, ProcFinishShippingGroup, ProcGenerateItemCostAdjustments, ProcGenerateReplacementOrder, ProcHandleElectronicSenderType, ProcHandleItemRelationshipState, ProcHandleMessageType, ProcHandleModificationClassType, ProcHandleModificationTargetType, ProcHandleModificationType, ProcHandleNewType, ProcHandleOrderPendingShipMap, ProcHandleOrderWaitingShipMap, ProcHandleRelationshipState, ProcHandleRetrievingOrder, ProcHandleShippingGroupState, ProcHandleShippingGroupUpdateModification, ProcInitializeCloneEditState, ProcInitializePEOProperties, ProcInitializeRAOProperties, ProcInitializeRCOProperties, ProcInitializeReconciliation, ProcInitializeRefundMethods, atg.commerce.csr.returns.ProcInitializeReturnRequestProperties, ProcInitPreReturnPromotionValues, ProcInitReturnAdjustedOrder, ProcInitReturnCalculationOrder, ProcInitShippingCostShares, ProcInstantiateReplacementOrder, ProcItemRemovedFromOrder, ProcLoadCommerceItemObjects, ProcLoadCostCenterObjects, ProcLoadHandlingInstructionObjects, ProcLoadOrderObject, ProcLoadOrderRepository, ProcLoadPaymentGroupObjects, ProcLoadPaymentStatusObjects, ProcLoadPriceInfoObjects, ProcLoadRelationshipObjects, ProcLoadReplacementOrders, ProcLoadSaveOrderRepository, ProcLoadShippingGroupObjects, ProcLockMessage, ProcMarkReturnRequestAsProcessed, ProcModificationUnsupported, ProcMoveUsedPromotions, ProcNoOpProcessPaymentGroup, ProcPerformRelationshipModification, ProcPerformShippingGroupModification, ProcPopulatePipelineParams, ProcPrepareForQuoteCheckout, ProcPrepareForQuoteRequest, ProcPrepareReplacementOrderToSubmit, ProcProcessCreditCard, ProcProcessGiftCertificate, ProcProcessInStorePayment, ProcProcessInvoiceRequest, ProcProcessPaymentGroup, ProcProcessShippingGroups, ProcProcessStoreCredit, ProcPropertyRestriction, ProcPurchaseBackOrder, ProcPurchaseConfigurableItem, ProcPurchaseItem, ProcPurchasePreOrder, ProcReconcileGiftlistRepository, ProcRemoveEmptyPaymentGroups, ProcRemoveEmptyShippingGroups, ProcRemoveExpiredCommerceItems, ProcRemoveOrder, ProcRemoveShipItemRelationship, ProcRemoveShipItemRelFromItem, ProcRemoveShipItemRelsFromShippingGroup, ProcRemoveUnallocatedRefundMethods, ProcResetGWPMetaData, ProcResetRefundAmounts, ProcRetrieveItemRelQuantity, ProcRetrieveOrderPendingShipMap, ProcRetrieveOrderWaitingShipMap, ProcRetrieveShippingGroupsToBeSplit, ProcReturnCommerceItems, ProcSaveCommerceItemObjects, ProcSaveCostCenterObjects, ProcSaveHandlingInstructionObjects, ProcSaveOrderObject, ProcSavePaymentGroupObjects, ProcSavePaymentStatusObjects, ProcSavePriceInfoObjects, ProcSaveQuoteInfo, ProcSaveRelationshipObjects, ProcSaveReturnRequestToRepository, ProcSaveShippingGroupObjects, ProcScenarioAddedItemToOrder, ProcSendApprovalCompleteMessage, ProcSendApprovalMessage, ProcSendApprovalRequiredMessage, ProcSendFulfillmentMessage, ProcSendFulfillmentNotifications, ProcSendFulfillOrderFragment, ProcSendGiftPurchasedMessage, ProcSendModifyOrderForRemoval, ProcSendModifyOrderNotification, ProcSendPromotionUsedMessage, ProcSendScenarioEvent, ProcSendScheduledOrderMessage, ProcSetActualRefundsFromSuggestedRefunds, ProcSetCatalogRefs, ProcSetCategory, ProcSetCostCenterAmount, ProcSetItemPriceSources, ProcSetLastModifiedTime, ProcSetOriginatingOrder, ProcSetOriginOfReplacementOrder, ProcSetPageName, ProcSetPaymentGroupAmount, ProcSetPricelists, ProcSetProduct, ProcSetProductRefs, ProcSetPromotions, ProcSetReturnShipmentRequired, ProcSettleCredits, ProcSettleOrder, ProcSettleReturnRequest, ProcShipAsItemsAreAvailable, ProcShippingGroupHasShipped, ProcSplitShippingGroupForAvailableItems, ProcSplitShippingGroupsForFulfillment, ProcSubmitReplacementOrder, ProcSwitchOnCommerceItemType, ProcUpdateCatalogRefOfProfile, ProcUpdateGiftRepository, ProcUpdateInventoryOnReceive, ProcUpdateOrder, ProcUpdateOrderRepository, ProcUpdateReplacementOrderStateOnConfirm, ProcUpdateReturnItemOnReceive, ProcUpdateReturnRequestState, ProcUpdateStateOfReturnItems, ProcUpdateStoreCreditAllocations, ProcValidateCloneOrder, ProcValidateCostCenter, ProcValidateCostCentersForCheckout, ProcValidateCreditCard, ProcValidateCurrencyCodes, ProcValidateElectronicShippingGroup, ProcValidateGiftCertificate, ProcValidateHandlingInstructionsForCheckout, ProcValidateHardgoodShippingGroup, ProcValidateInvoiceRequest, ProcValidateOrderCostsForCheckout, ProcValidateOrderForCheckout, ProcValidatePaymentGroupsForCheckout, ProcValidateQuoteForCheckout, ProcValidateRefundMethodAllocations, ProcValidateSelectedItems, ProcValidateShippingCostsForCheckout, ProcValidateShippingGroupsForCheckout, ProcValidateStoreCredit, ProcVerifyApproval, ProcVerifyItemRelationshipForRemoval, ProcVerifyOrderAddresses, ProcVerifyOrderForFulfillment, ProcVerifyOrderForRemoval, ProcVerifyShippingGroupForCompletion, ProcVerifyShippingGroupForFulfillment, ProcVerifyShippingGroupForRemoval, ProcVerifyShippingGroupsForFulfillers, RepositoryItemPurgeProcessor, atg.adc.pipeline.SetCategoryProcessor, SetPaymentDueDate, SimulationProcessor

public interface PipelineProcessor

An interface which the components that the PipelineChain executes implement. Its main method is runProcess()

See Also:

PipelineChain, PipelineLink

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION
static int	STOP_CHAIN_EXECUTION
static int	STOP_CHAIN_EXECUTION_AND_COMMIT This constant is a reserved return value which notifies the PipelineManager to stop chain execution.
static int	STOP_CHAIN_EXECUTION_AND_ROLLBACK This constant is a reserved return value which notifies the PipelineManager to stop chain execution and cause the transaction to be rolled back.

Method Summary

Modifier and Type	Method and Description
int[]	getRetCodes() Returns an array of all the return codes that could be returned by this PipelineProcessor.
int	runProcess(java.lang.Object pParam, PipelineResult pResult) This method runs the actual processor and does the work.

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

See Also:

Constant Field Values

STOP_CHAIN_EXECUTION_AND_COMMIT

static final int STOP_CHAIN_EXECUTION_AND_COMMIT

This constant is a reserved return value which notifies the PipelineManager to stop chain execution. By returning this value an exception is NOT thrown, but rather execution is stopped, any transactions are committed (or rolled back if marked as such), and the PipelineResult object is returned. The transaction is only committed if the transaction was started by the PipelineManager. If the processor was executed from within a transaction that was not started by the PipelineManager, then the chain will merely stop and no operation will be performed on the transaction.

See Also:

Constant Field Values

STOP_CHAIN_EXECUTION

static final int STOP_CHAIN_EXECUTION

See Also:

Constant Field Values

STOP_CHAIN_EXECUTION_AND_ROLLBACK

static final int STOP_CHAIN_EXECUTION_AND_ROLLBACK

This constant is a reserved return value which notifies the PipelineManager to stop chain execution and cause the transaction to be rolled back. By returning this value an exception is NOT thrown, but rather execution is stopped, any transactions are rolled back, and the PipelineResult object is returned.

See Also:

Constant Field Values

Method Detail

runProcess

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

This method runs the actual processor and does the work. pParam is user data and pResult is an object which contains result data. The return value of the method is what determines what the next link to be executed is.

Parameters:

pParam - an optional user parameter

pResult - the PipelineResult object which is used to return errors or other data

Returns:

an integer value which is mapped to the next processor to execute. STOP_CHAIN_EXECUTION will notify the PipelineManager to stop execution. An unmapped value will throw a RunProcessException.

Throws:

java.lang.Exception

getRetCodes

int[] getRetCodes()

Returns an array of all the return codes that could be returned by this PipelineProcessor.

Returns:

an array of all the return codes that could be returned by this PipelineProcessor.