Package de.hybris.platform.processengine.spring

Interface Action<T extends BusinessProcessModel>

All Known Implementing Classes:
AbstractAction, AbstractB2BApproveOrderDecisionAction, 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, CalculateCartAction, CalculatePayment, CalculatePersonalizationForUserAction, CancelConsignment, CancelConsignmentAction, CancelOrderAction, CancelReturnAction, CancelReturnAction, CancelWholeOrderAuthorization, CancelWholeOrderAuthorizationAction, CaptureRefundAction, CaptureRefundAction, CheckAuthorizeOrderPayment, CheckAuthorizeOrderPaymentAction, CheckCreditCardOrderAction, CheckCreditLimitResults, CheckForApproval, CheckForQuoteAutoApprovalAction, CheckOrder, CheckOrderAction, CheckOrderAction, CheckOrderEntryCostCentersActive, CheckSellerApproverResponseOnQuoteAction, CheckTransactionReviewStatus, CheckTransactionReviewStatusAction, CheckWorkflowResults, ChineseCheckAuthorizeOrderPaymentAction, ChineseFraudCheckOrderInternalAction, ChineseTakePaymentAction, CleanUpClonedCartAction, CloneCartAction, CompleteOrderAction, CompleteReturnAction, ConfirmationAction, ConfirmConsignmentPickup, ConfirmConsignmentPickupAction, ConfirmPickupConsignmentAction, ConfirmShipConsignmentAction, ConsignmentProcessEndAction, CreateBuyerOfferAction, CreateConsignmentMovedToCSTicketAction, CreateOrderHistory, DynamicProcessEventAction, Find2POEApprovers, FindApprovers, ForgottenPasswordAction, FraudCheckOrder, FraudCheckOrderAction, FraudCheckOrderAction, FraudCheckOrderInternal, FraudCheckOrderInternalAction, GenerateEmailAction, GenerateEmailWithAttachmentAction, GeocodeShippingAddressAction, GetPaymentDetailsAction, InformAdmin, InformOfOrderApproval, InformOfOrderRejection, InitialReturnAction, InitialReturnAction, InventoryUpdateAction, InventoryUpdateAction, MarkQuoteNotificationAsSentAction, MessageSendingAction, NoAction, NotifyCustomerAboutFraud, NotifyCustomerAboutFraudAction, NotifyCustomerAboutFraudAction, 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, RemoveSentEmailAction, ReserveOrderAmount, ReserveOrderAmountAction, RestartBusinessProcessTest.PostWaitAction, RestartBusinessProcessTest.PreWaitAction, SavedCartFromUploadFileAction, ScheduleForCleanUp, ScheduleForCleanUpAction, SendAuthorizationFailedNotification, SendAuthorizationFailedNotificationAction, SendCancelMessage, SendCancelMessageAction, SendConsignmentToExternalFulfillmentSystemAction, SendConsignmentToWarehouse, SendConsignmentToWarehouseAction, SendDeliveryMessage, SendDeliveryMessageAction, SendEmailAction, SendFraudErrorNotification, SendFraudErrorNotificationAction, SendOrderApprovalRejectionNotification, SendOrderCancelledNotificationAction, SendOrderCompletedNotification, SendOrderCompletedNotificationAction, SendOrderPendingApprovalNotification, SendOrderPlacedNotification, SendOrderPlacedNotificationAction, SendOrderPlacedNotificationAction, SendOrderPlacedNotificationAction, SendOrderRefundNotificationAction, SendPaymentFailedMessage, SendPaymentFailedNotification, SendPaymentFailedNotificationAction, SendPaymentFailedNotificationAction, SendPickedUpMessage, SendPickedUpMessageAction, SendReadyForPickupMessage, SendReadyForPickupMessageAction, SetBookingLineEntries, 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 Details

    • RETRY_RETURN_CODE

      static final String RETRY_RETURN_CODE
      Special return code to be interpreted by the Process Engine. If an Action's execute method returns RETRY_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:

    • ERROR_RETURN_CODE

      static final String ERROR_RETURN_CODE
      Special return code to be interpreted by the Process Engine. If an Action's execute method returns ERROR_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 an onError node to continue with and/or on action level by specifying a transition for return code error.
      See Also:

  • Method Details

    • execute

      String execute(T process) throws RetryLaterException, Exception
      Executes this Action's business logic working on the given BusinessProcessModel.
      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:
      Exception
      RetryLaterException

    • getCurrentActionDefinitionContext

      default ActionDefinitionContext getCurrentActionDefinitionContext()
      Retrieves additional information about the executed action
      Returns:
      ActionDefinitionContext containing additional information

    • getTransitions

      Set<String> getTransitions()
      Accesses all possible return codes of this Action. 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