atg.service.pipeline
Interface PipelineProcessor
- All Known Implementing Classes:
- ADCPipelineProcessor, AppendStringProcessor, AssignmentProcessor, B2BProcLoadRelationshipObjects, CheckForNoInsertProcessor, CopyInvoiceRequestProperties, CopyInvoiceRequestProperties, EmptyProcessor, EventSender, ExtraTagsProcessor, GenerateInvoiceMessage, GenerateInvoiceMessage, PriceOrderTotal, ProcAddApprovalSystemMessagesToOrder, ProcAddApprovalSystemMessagesToOrder, ProcAddApproverIdsToOrder, ProcAddApproverIdsToOrder, ProcAddApproverIdToOrder, ProcAddApproverIdToOrder, ProcAddApproverMessagesToOrder, ProcAddApproverMessagesToOrder, ProcAddMessageMapperErrorToOrder, ProcAddMessageMapperErrorToOrder, ProcAddOrderToRepository, ProcAllocateElectronicGood, ProcAllocateItemRelationship, ProcAllocateShippingGroup, ProcApprovalCompleteAnalyzer, ProcApprovalCompleteAnalyzer, ProcAuthorizePayment, ProcCancelRemoveOrder, ProcChangeOrderState, ProcCheckForDiscontinuedProducts, ProcCheckForErrors, ProcCheckForExpiredPromotions, ProcCheckOrderState, ProcCheckRequisitionNumbers, ProcCreateCreditCardInfo, ProcCreateElectronicGood, ProcCreateGiftCertificateInfo, ProcCreateImplicitRelationships, ProcCreateInvoiceRequestInfo, ProcCreateInvoiceRequestInfo, ProcCreateStoreCreditInfo, ProcCreditCardModCheck, ProcCreditOrder, ProcDeliverElectronicGoodByListener, ProcDeliverElectronicGoodByTemplate, ProcDispatchOnOrderState, ProcDispatchOnProperty, ProcExecuteChain, ProcExecuteFulfillOrderFragment, ProcExtractOrderId, ProcExtractShippingGroupIds, ProcFailOrder, ProcFinishOrder, ProcFinishRemoveOrder, ProcFinishShippingGroup, ProcHandleElectronicSenderType, ProcHandleItemRelationshipState, ProcHandleMessageType, ProcHandleModificationClassType, ProcHandleModificationTargetType, ProcHandleModificationType, ProcHandleNewType, ProcHandleOrderPendingShipMap, ProcHandleOrderWaitingShipMap, ProcHandleRelationshipState, ProcHandleRetrievingOrder, ProcHandleShippingGroupState, ProcHandleShippingGroupUpdateModification, ProcLoadCommerceItemObjects, ProcLoadCostCenterObjects, ProcLoadCostCenterObjects, ProcLoadHandlingInstructionObjects, ProcLoadOrderObject, ProcLoadOrderRepository, ProcLoadPaymentGroupObjects, ProcLoadPaymentStatusObjects, ProcLoadPriceInfoObjects, ProcLoadRelationshipObjects, ProcLoadSaveOrderRepository, ProcLoadShippingGroupObjects, ProcLockMessage, ProcModificationUnsupported, ProcMoveUsedPromotions, ProcPerformRelationshipModification, ProcPerformShippingGroupModification, ProcPopulatePipelineParams, ProcPopulatePipelineParams, ProcProcessCreditCard, ProcProcessGiftCertificate, ProcProcessInvoiceRequest, ProcProcessInvoiceRequest, ProcProcessPaymentGroup, ProcProcessShippingGroups, ProcProcessStoreCredit, ProcPropertyRestriction, ProcPurchaseBackOrder, ProcPurchaseConfigurableItem, ProcPurchaseItem, ProcPurchasePreOrder, ProcRemoveEmptyPaymentGroups, ProcRemoveEmptyShippingGroups, ProcRemoveExpiredCommerceItems, ProcRemoveOrder, ProcRemoveShipItemRelationship, ProcRemoveShipItemRelFromItem, ProcRemoveShipItemRelsFromShippingGroup, ProcRetrieveItemRelQuantity, ProcRetrieveOrderPendingShipMap, ProcRetrieveOrderWaitingShipMap, ProcRetrieveShippingGroupsToBeSplit, ProcSaveCommerceItemObjects, ProcSaveCostCenterObjects, ProcSaveCostCenterObjects, ProcSaveHandlingInstructionObjects, ProcSaveOrderObject, ProcSavePaymentGroupObjects, ProcSavePaymentStatusObjects, ProcSavePriceInfoObjects, ProcSaveRelationshipObjects, ProcSaveShippingGroupObjects, ProcSendApprovalCompleteMessage, ProcSendApprovalCompleteMessage, ProcSendApprovalMessage, ProcSendApprovalMessage, ProcSendApprovalRequiredMessage, ProcSendApprovalRequiredMessage, ProcSendFulfillmentMessage, ProcSendFulfillOrderFragment, ProcSendGiftPurchasedMessage, ProcSendModifyOrderForRemoval, ProcSendModifyOrderNotification, ProcSendPromotionUsedMessage, ProcSendScenarioEvent, ProcSendScheduledOrderMessage, ProcSendScheduledOrderMessage, ProcSetCatalogRefs, ProcSetCostCenterAmount, ProcSetCostCenterAmount, ProcSetLastModifiedTime, ProcSetPaymentGroupAmount, ProcSetProductRefs, ProcSettleOrder, ProcShipAsItemsAreAvailable, ProcShippingGroupHasShipped, ProcSplitShippingGroupForAvailableItems, ProcSplitShippingGroupsForFulfillment, ProcSwitchOnCommerceItemType, ProcUpdateCatalogRefOfProfile, ProcUpdateGiftRepository, ProcUpdateOrder, ProcUpdateOrderRepository, ProcValidateCostCenter, ProcValidateCostCenter, ProcValidateCostCentersForCheckout, ProcValidateCostCentersForCheckout, ProcValidateCreditCard, ProcValidateCurrencyCodes, ProcValidateElectronicShippingGroup, ProcValidateGiftCertificate, ProcValidateHandlingInstructionsForCheckout, ProcValidateHardgoodShippingGroup, ProcValidateInvoiceRequest, ProcValidateInvoiceRequest, ProcValidateOrderCostsForCheckout, ProcValidateOrderForCheckout, ProcValidatePaymentGroupsForCheckout, ProcValidateShippingCostsForCheckout, ProcValidateShippingGroupsForCheckout, ProcValidateStoreCredit, ProcVerifyApproval, ProcVerifyApproval, ProcVerifyItemRelationshipForRemoval, ProcVerifyOrderAddresses, ProcVerifyOrderForFulfillment, ProcVerifyOrderForRemoval, ProcVerifyShippingGroupForCompletion, ProcVerifyShippingGroupForFulfillment, ProcVerifyShippingGroupForRemoval, ProcVerifyShippingGroupsForFulfillers, SetPaymentDueDate, SetPaymentDueDate, SimulationProcessor
public interface PipelineProcessor
An interface which the components that the PipelineChain executes
implement. Its main method is runProcess()
- See Also:
PipelineChain
,
PipelineLink
Method Summary |
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. |
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
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 parameterpResult
- 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.