Interface Action<T extends BusinessProcessModel>
-
- All Known Implementing Classes:
AbstractAction
,AbstractB2BApproveOrderDecisionAction
,AbstractCMSVersionGCProcessAction
,AbstractConsignmentAction
,AbstractFraudCheckAction
,AbstractFraudCheckAction
,AbstractOrderAction
,AbstractOrderAction
,AbstractProceduralAction
,AbstractProceduralB2BOrderApproveAction
,AbstractProceduralB2BOrderApproveAuditAction
,AbstractProceduralB2BOrderAproveAction
,AbstractQuoteDecisionAction
,AbstractSimpleB2BApproveOrderDecisionAction
,AbstractSimpleDecisionAction
,AbstractTestConsActionTemp
,AcceleratorBookingLineEntries
,AcceptGoodsAction
,AcceptGoodsAction
,AllowShipment
,AllowShipmentAction
,ApprovalProcessCompleteAction
,ApprovalProcessStartAction
,ApproveReturnAction
,ApproveReturnAction
,AuthorizePaymentAction
,B2BAcceleratorInformOfOrderApproval
,B2BAcceleratorInformOfOrderApprovalRejection
,C4CCheckQuoteAction
,CalculateCartAction
,CalculatePayment
,CalculatePersonalizationForUserAction
,CancelConsignment
,CancelConsignmentAction
,CancelOrderAction
,CancelReturnAction
,CancelReturnAction
,CancelReturnRequestToSAPAction
,CancelReturnRequestToSAPSCPIAction
,CancelWholeOrderAuthorization
,CancelWholeOrderAuthorizationAction
,CaptureRefundAction
,CaptureRefundAction
,CheckAuthorizeOrderPayment
,CheckAuthorizeOrderPaymentAction
,CheckC4CQuoteIDAction
,CheckCreditCardOrderAction
,CheckCreditLimitResults
,CheckCustomerIsReplicatedAction
,CheckCustomerReplicationAction
,CheckForApproval
,CheckForQuoteAutoApprovalAction
,CheckOrder
,CheckOrderAction
,CheckOrderAction
,CheckOrderEntryCostCentersActive
,CheckOrderSendStatusAction
,CheckSAPOrderAction
,CheckSellerApproverResponseOnQuoteAction
,CheckTransactionReviewStatus
,CheckTransactionReviewStatusAction
,CheckWorkflowResults
,ChineseCheckAuthorizeOrderPaymentAction
,ChineseFraudCheckOrderInternalAction
,ChineseTakePaymentAction
,CleanUpClonedCartAction
,CloneCartAction
,CollectRelatedCMSVersionsGCProcessAction
,CollectRetainableCMSVersionsGCProcessAction
,CompleteOrderAction
,CompleteReturnAction
,CompleteReturnAction
,ConfirmationAction
,ConfirmConsignmentPickup
,ConfirmConsignmentPickupAction
,ConfirmPickupConsignmentAction
,ConfirmShipConsignmentAction
,ConsignmentProcessEndAction
,CreateBuyerOfferAction
,CreateConsignmentMovedToCSTicketAction
,CreateOrderHistory
,CustomerPublishAction
,DynamicProcessEventAction
,Find2POEApprovers
,FindApprovers
,FraudCheckOrder
,FraudCheckOrderAction
,FraudCheckOrderAction
,FraudCheckOrderInternal
,FraudCheckOrderInternalAction
,GenerateEmailAction
,GenerateEmailWithAttachmentAction
,GeocodeShippingAddressAction
,GetPaymentDetailsAction
,InformAdmin
,InformOfOrderApproval
,InformOfOrderRejection
,InitialReturnAction
,InitialReturnAction
,InventoryUpdateAction
,InventoryUpdateAction
,MarkQuoteNotificationAsSentAction
,MessageSendingAction
,NoAction
,NotifyCustomerAboutFraud
,NotifyCustomerAboutFraudAction
,NotifyCustomerAboutFraudAction
,OmsInventoryUpdateAction
,OrderManualChecked
,OrderManualCheckedAction
,OrderManualCheckedAction
,PerformMerchantCheck
,PlaceOrderAction
,PostTaxesAction
,PrepareOrderForManualCheck
,PrepareOrderForManualCheckAction
,PrepareOrderForManualCheckAction
,PrintPackingLabelAction
,PrintPackingLabelAction
,PrintReturnLabelAction
,PrintReturnLabelAction
,ProcessConsignmentPreFulfillmentAction
,ProcessEngineIntegrationTest.TestCustomUserAction
,ProcessOrderCancellationAction
,PutOrderOnHoldAction
,QuoteApprovalRejectedAction
,QuoteBuyerSubmitAction
,ReAllocateConsignmentAction
,ReceiveConsignmentStatus
,ReceiveConsignmentStatusAction
,RedirectConsignmentByDeliveryModeAction
,RedirectConsignmentFulfillmentProcessAction
,RegistrationCleanupAction
,RegistrationPendingApprovalGenerateEmailAction
,RemoveCMSVersionsGCProcessAction
,RemoveSentEmailAction
,ReserveOrderAmount
,ReserveOrderAmountAction
,RestartBusinessProcessTest.PostWaitAction
,RestartBusinessProcessTest.PreWaitAction
,SapC4cCustomerPublishAction
,SapCancelConsignmentAction
,SapCancelConsignmentAction
,SapCancelOrderAction
,SapCancelOrderAction
,SapCheckCompletionStatusAction
,SapCheckCompletionStatusAction
,SapCheckCustomerReplicationAction
,SapCheckCustomerReplicationAction
,SapCheckOrderAction
,SapCheckOrderAction
,SapCheckOrderSendStatusAction
,SapCheckOrderSendStatusAction
,SapConsignmentProcessEndAction
,SapConsignmentProcessEndAction
,SapCpiCheckQuoteStateAction
,SapCpiOmmOrderOutboundAction
,SapCpiOmmReturnOrderOutboundAction
,SapCpiOmsOrderOutboundAction
,SapCpiSendQuoteAction
,SapCpiSendQuoteStatusAction
,SapCpiSendRevenueCloudOrderOutboundAction
,SapDigitalPayCheckSessionAction
,SapDigitalPaymentCaptureRefundAction
,SapDigitalPaymentTakePaymentAction
,SapDigitalPaySavePollCardResultAction
,SapGeocodeShippingAddressAction
,SapGeocodeShippingAddressAction
,SapGoodsReceiptStatusChecker
,SapOmsAbstractAction
,SapOmsAbstractAction
,SapOmsSendOrderToDataHubAction
,SapOrderexchangeDefaultOmsSendReturnOrderToSCPIAction
,SapRedirectConsignmentByDeliveryModeAction
,SapRedirectConsignmentByDeliveryModeAction
,SapReturnOrderBackendConfimationChecker
,SapReturnOrderBackendConfimationForCancelChecker
,SapRevenueCloudCustomerPublishAction
,SapRevenueCloudOrderConfirmationAction
,SapSendOrderToDataHubAction
,SapSetConfirmationStatusAction
,SapSetConfirmationStatusAction
,SapSourceOrderAction
,SapSourceOrderAction
,SapVerifyConsignmentCompletionAction
,SapVerifyConsignmentCompletionAction
,SavedCartFromUploadFileAction
,ScheduleForCleanUp
,ScheduleForCleanUpAction
,SendAuthorizationFailedNotification
,SendAuthorizationFailedNotificationAction
,SendCancelMessage
,SendCancelMessageAction
,SendConsignmentToExternalFulfillmentSystemAction
,SendConsignmentToWarehouse
,SendConsignmentToWarehouseAction
,SendDeliveryMessage
,SendDeliveryMessageAction
,SendEmailAction
,SendFraudErrorNotification
,SendFraudErrorNotificationAction
,SendOmsReturnOrderToDataHubAction
,SendOrderApprovalRejectionNotification
,SendOrderCancelledNotificationAction
,SendOrderCompletedNotification
,SendOrderCompletedNotificationAction
,SendOrderPendingApprovalNotification
,SendOrderPlacedNotification
,SendOrderPlacedNotificationAction
,SendOrderPlacedNotificationAction
,SendOrderPlacedNotificationAction
,SendOrderRefundNotificationAction
,SendPaymentFailedMessage
,SendPaymentFailedNotification
,SendPaymentFailedNotificationAction
,SendPaymentFailedNotificationAction
,SendPickedUpMessage
,SendPickedUpMessageAction
,SendQuoteToDatahubAction
,SendReadyForPickupMessage
,SendReadyForPickupMessageAction
,SendReturnOrderToDataHubAction
,SendSubscriptionOrderAction
,SetBookingLineEntries
,SetCancelAction
,SetCompletionStatusAction
,SetConfirmationStatusAction
,SetOrderExpirationTimeAction
,SourceOrderAction
,SplitOrder
,SplitOrderAction
,StartFulfilmentProcessAction
,StartingWorkflowAction
,StartWorkflow
,StartWorkFlowForAdmin
,SubprocessEnd
,SubprocessEndAction
,SubprocessesCompleted
,SubprocessesCompletedAction
,SuccessCaptureAction
,SuccessCaptureAction
,SuccessTaxReverseAction
,SuccessTaxReverseAction
,SynchRetryProcessEngineIntegrationTest.RetryActionBean
,SynchRetryProcessEngineIntegrationTest.TestCustomUserAction
,SynchRollbackProcessEngineIntegrationTest.ExceptionActionBean
,SynchRollbackProcessEngineIntegrationTest.TestCustomUserAction
,SystemAuditAction
,TakePayment
,TakePaymentAction
,TakePaymentAction
,TaxReverseAction
,TaxReverseAction
,TestAction
,TestActionNode
,TestActionTemp
,ThrowErrorAction
,UpdateConsignmentAction
,UpdateUserSegmentsAction
,VerifyConsignmentCompletionAction
,VerifyOrderCompletionAction
,WaitBeforeTransmission
,WaitBeforeTransmissionAction
public interface Action<T extends BusinessProcessModel>
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ERROR_RETURN_CODE
Special return code to be interpreted by the Process Engine.static java.lang.String
RETRY_RETURN_CODE
Special return code to be interpreted by the Process Engine.
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description java.lang.String
execute(T process)
Executes thisAction
's business logic working on the givenBusinessProcessModel
.default ActionDefinitionContext
getCurrentActionDefinitionContext()
Retrieves additional information about the executed actionjava.util.Set<java.lang.String>
getTransitions()
Accesses all possible return codes of thisAction
.
-
-
-
Field Detail
-
RETRY_RETURN_CODE
static final java.lang.String RETRY_RETURN_CODE
Special return code to be interpreted by the Process Engine. If anAction
'sexecute
method returnsRETRY_RETURN_CODE
it tells the process engine, that it currently is unable to fulfill it's logic and that execution should be scheduled for a later time. The retry return code can not be overridden by any transition mapping.- See Also:
- Constant Field Values
-
ERROR_RETURN_CODE
static final java.lang.String ERROR_RETURN_CODE
Special return code to be interpreted by the Process Engine. If anAction
'sexecute
method returnsERROR_RETURN_CODE
it tells the process engine, that an internal error occurred. The process will be marked accordingly. The default behavior (ending process with error), can be overridden on process definition level by specifying anonError
node to continue with and/or on action level by specifying a transition for return codeerror
.- See Also:
- Constant Field Values
-
-
Method Detail
-
execute
java.lang.String execute(T process) throws RetryLaterException, java.lang.Exception
Executes thisAction
's business logic working on the givenBusinessProcessModel
.- Parameters:
process
- The process context to work on.- Returns:
- the return code as stated in the process definition. This code is used by the process engine to determine the next actions.
- Throws:
java.lang.Exception
RetryLaterException
-
getCurrentActionDefinitionContext
default ActionDefinitionContext getCurrentActionDefinitionContext()
Retrieves additional information about the executed action- Returns:
- ActionDefinitionContext containing additional information
-
getTransitions
java.util.Set<java.lang.String> getTransitions()
Accesses all possible return codes of thisAction
. This method is used by the process engine to validate a process definition. Furthermore it can be used by (graphical) editors to access all return codes which have to mapped in transitions.- Returns:
- all possible return codes of this
Action
-
-