Package org.cxbox.core.dto.rowmeta

Class PostAction.WaitUntilBuilder<T extends org.cxbox.api.data.dto.DataResponseDTO,V>

java.lang.Object
org.cxbox.core.dto.rowmeta.PostAction.WaitUntilBuilder<T,V>
Enclosing class:
PostAction
public static class PostAction.WaitUntilBuilder<T extends org.cxbox.api.data.dto.DataResponseDTO,V> extends Object
Creates a post-action that waits until a specified condition is met.

Must be created only from PostAction.waitUntil(DtoField, Object) or PostAction.drillDownAndWaitUntil(String, BcIdentifier, DtoField, Object))

  • Method Details

    • inProgressMessage

      public PostAction.WaitUntilBuilder<T,V> inProgressMessage(@NonNull @NonNull String message)
      Sets the message displayed while waiting for the operation to complete. If not set - default configured in UI is displayed
      Parameters:
      message - The message to display.
      Returns:
      The builder instance.

    • successMessage

      public PostAction.WaitUntilBuilder<T,V> successMessage(@NonNull @NonNull String message)
      Sets the message to displayed when operation successfully completes before timeout and forces UI to wait user to close popup manually. If not set - wait popup will be autoclosed immediately
      Parameters:
      message - message displayed when operation complete before timeout (e.g. successConditionField achieved successConditionValue)
      Returns:
      The builder instance.

    • timeout

      public PostAction.WaitUntilBuilder<T,V> timeout(@NonNull @NonNull Duration timeout)
      timeout (default and recommended value is 5 seconds).

    • timeoutMaxRequests

      public PostAction.WaitUntilBuilder<T,V> timeoutMaxRequests(int maxRequests)
      number of intermediate requests to check if successConditionField achieved successConditionValue before timeout is reached

    • timeoutMessage

      public PostAction.WaitUntilBuilder<T,V> timeoutMessage(@NonNull @NonNull String message)
      Sets the message to displayed when operation completes because of timeout and forces UI to wait user to close popup manually. If not set - wait popup will be autoclosed immediately
      Parameters:
      message - The message to display if operation completed because timeout reached
      Returns:
      The builder instance.

    • build

      public PostAction build()