Package com.broadleafcommerce.metadata.dsl.core.extension.views.details

Interface UpdateEntityView<V extends UpdateEntityView<V>>

All Superinterfaces:
ActionView<V>, AugmentableView<V>, Comparable<V>, Component<V>, Copyable<V>, EntityView<V>, FetchEntity<V>, PreviewableView<V>, Serializable, Trackable<V>, View<V>
All Known Subinterfaces:
UpdateModalFormView<V>
All Known Implementing Classes:
DefaultCreateModalFormView, DefaultUpdateEntityLongFormView, DefaultUpdateEntityView, DefaultUpdateModalFormView
public interface UpdateEntityView<V extends UpdateEntityView<V>> extends EntityView<V>, FetchEntity<V>, PreviewableView<V>
Author:
Nick Crum (ncrum)

  • Method Details

    • displayNameKey

      default V displayNameKey(String displayNameKey)

    • addSubmitAction

      default V addSubmitAction(Action<?> action)

    • submitAction

      default V submitAction(Action<?> action)

    • submitAction

      default V submitAction(UnaryOperator<Action<?>> fn)

    • getSubmitAction

      default Action<?> getSubmitAction()

    • findSubmitAction

      default Optional<Action<?>> findSubmitAction()

    • submitLabel

      default V submitLabel(InternationalizedMessage label)

    • submitLabel

      default V submitLabel(String label)

    • addSubmitEndpoint

      default V addSubmitEndpoint(Endpoint<?> endpoint)

    • submitEndpoint

      default V submitEndpoint(UnaryOperator<Endpoint<?>> fn)

    • submitUrl

      default V submitUrl(String url)

    • submitScope

      default V submitScope(String scope)

    • submitUrl

      default V submitUrl(String url, String scope)

    • getSubmitEndpoint

      default Endpoint<?> getSubmitEndpoint()

    • addDeleteAction

      default V addDeleteAction(Action<?> action)

    • deleteAction

      default V deleteAction(Action<?> action)

    • deleteAction

      default V deleteAction(UnaryOperator<Action<?>> fn)

    • getDeleteAction

      default Action<?> getDeleteAction()

    • findDeleteAction

      default Optional<Action<?>> findDeleteAction()

    • deleteLabel

      default V deleteLabel(InternationalizedMessage label)

    • deleteLabel

      default V deleteLabel(String label)

    • addDeleteEndpoint

      default V addDeleteEndpoint(Endpoint<?> endpoint)

    • deleteEndpoint

      default V deleteEndpoint(UnaryOperator<Endpoint<?>> fn)

    • getDeleteEndpoint

      default Endpoint<?> getDeleteEndpoint()

    • deleteUrl

      default V deleteUrl(String url)

    • deleteScope

      default V deleteScope(String scope)

    • deleteUrl

      default V deleteUrl(String url, String scope)

    • addCloneAction

      default V addCloneAction(CloneModalFormAction<?> action)

    • cloneAction

      default V cloneAction(UnaryOperator<CloneModalFormAction<?>> fn)

    • getCloneAction

      default CloneModalFormAction<?> getCloneAction()

    • findCloneAction

      default Optional<CloneModalFormAction<?>> findCloneAction()

    • addAddAdjustmentAction

      default V addAddAdjustmentAction(AddAdjustmentModalFormAction<?> action)

    • addAdjustmentAction

      default V addAdjustmentAction(UnaryOperator<AddAdjustmentModalFormAction<?>> fn)

    • getAddAdjustmentAction

      default AddAdjustmentModalFormAction<?> getAddAdjustmentAction()

    • findAddAdjustmentAction

      default Optional<AddAdjustmentModalFormAction<?>> findAddAdjustmentAction()

    • addSubmitTranslationsEndpoint

      default V addSubmitTranslationsEndpoint(Endpoint<?> endpoint)

    • submitTranslationsEndpoint

      default V submitTranslationsEndpoint(UnaryOperator<Endpoint<?>> fn)

    • getUpdateTranslationsEndpoint

      default Endpoint<?> getUpdateTranslationsEndpoint()

    • submitTranslationsUrl

      default V submitTranslationsUrl(String url)

    • submitTranslationsScope

      default V submitTranslationsScope(String scope)

    • submitTranslationsUrl

      default V submitTranslationsUrl(String url, String scope)

    • exportHistoryGrid

      default V exportHistoryGrid(UnaryOperator<ExportHistoryGridExternal<?>> fn)
      Adds the export history grid.
      Parameters:
      fn - the added ExportHistoryGrid for further customization
      Returns:
      this view for further customization

    • removeExportHistoryGrid

      default V removeExportHistoryGrid()
      Removes the export history grid.
      Returns:
      this view for further customization

    • findExportHistoryGrid

      default Optional<ExportHistoryGridExternal<?>> findExportHistoryGrid()
      Search the export history grid view.
      Returns:
      the found ExportHistoryGridExternal

    • getExportHistoryGrid

      default ExportHistoryGridExternal<?> getExportHistoryGrid()
      Returns the ExportHistoryGridExternal if it exists.
      Returns:
      the found ExportHistoryGridExternal
      Throws:
      IllegalArgumentException - if there is no grid for export history

    • confirmationDialog

      default V confirmationDialog(String title, String message, String buttonLabel, String confirmedKey)
      Enables the display of a confirmation dialog upon submission of the entity form. The confirmation dialog's title, message text, and confirmation/submit button label can all be configured as well.

      The confirmedKey parameter represents the key string that will be set on the context parameters for the submission request to the configured submission endpoint for this entity view. The value of the confirmedKey parameter is expected to match a parameter on the configured submission endpoint so that it can be received by the corresponding service endpoint for validation or processing purposes.

      For example: 

           Views.entityLongFormViewUpdate()
          ...
          .submitEndpoint(endpoint -> endpoint
                         .uri(Paths.URI)
                         .scope(Scopes.SCOPE)
                         .param("acceptedConfirmationDialog", "${$confirmationDialogConfirmed}"))
          .confirmationDialog("entity.update.confirm-dialog.title",
                         "entity.update.confirm-dialog.message",
                         "entity.update.confirm-dialog.button-label",
                         "$confirmationDialogConfirmed")
      Parameters:
      title - the preferred title of the confirmation dialog
      message - the preferred message text of the confirmation dialog
      buttonLabel - the preferred label of the confirmation dialog submit/confirm button
      confirmedKey - the key of the value that will be set on the submission request context parameters to indicate that the confirmation dialog was accepted
      Returns:
      this view with the confirmation dialog attributes added

    • dependentEntity

      default <T extends Endpoint<?>> V dependentEntity(String entityType, T readEndpoint)
      Adds an attribute to the UpdateEntityView that is a map containing a singular entity type (e.g. PRODUCT) and its endpoint that will be used to fetch the details of existing dependent entities that match the given type.
      Type Parameters:
      T - the type of endpoint that will fetch the details of existing dependent entities
      Parameters:
      entityType - the entity type that this UpdateEntityView has dependent entities of
      readEndpoint - the endpoint that will fetch the details of existing dependent entities matching the given entity type
      Returns:
      the updated view with attribute added to it
      Since:
      Metadata 2.0.7, Release Train 2.3.0

    • dependentEntities

      default <T extends Endpoint<?>> V dependentEntities(Map<String,T> dependentEntities)
      Adds an attribute to the UpdateEntityView that is a map of entity types (e.g. PRODUCT, CONTENT_ITEM) that are mapped to their respective endpoints that will be used to fetch the details of existing dependent entities that match the given types.
      Type Parameters:
      T - the type of endpoint that will fetch the details of existing dependent entities
      Parameters:
      dependentEntities - the map of entity types to the endpoints that will fetch their details
      Returns:
      the updated view with attribute added to it
      Since:
      Metadata 2.0.7, Release Train 2.3.0

    • addDependentEntitiesAction

      default V addDependentEntitiesAction(Action<?> action)
      Since:
      Metadata 2.0.7, Release Train 2.3.0

    • dependentEntitiesAction

      default V dependentEntitiesAction(Action<?> action)
      Since:
      Metadata 2.0.7, Release Train 2.3.0

    • dependentEntitiesAction

      default V dependentEntitiesAction(UnaryOperator<Action<?>> fn)
      Since:
      Metadata 2.0.7, Release Train 2.3.0

    • getDependentEntitiesAction

      default Action<?> getDependentEntitiesAction()
      Since:
      Metadata 2.0.7, Release Train 2.3.0

    • findDependentEntitiesAction

      default Optional<Action<?>> findDependentEntitiesAction()
      Since:
      Metadata 2.0.7, Release Train 2.3.0

    • dependentEntitiesLabel

      default V dependentEntitiesLabel(InternationalizedMessage label)
      Since:
      Metadata 2.0.7, Release Train 2.3.0

    • dependentEntitiesLabel

      default V dependentEntitiesLabel(String label)
      Since:
      Metadata 2.0.7, Release Train 2.3.0