Package org.broadleafcommerce.openadmin.server.dao.provider.metadata

Interface EntityMetadataProvider

All Superinterfaces:
org.springframework.core.Ordered
All Known Implementing Classes:
AbstractEntityMetadataProvider, BasicEntityMetadataProvider, EntityMetadataProviderAdapter
public interface EntityMetadataProvider extends org.springframework.core.Ordered
Classes implementing this interface are capable of manipulating metadata from the inspection phase for the admin. Providers are typically added in response to new admin presentation annotation support. Implementers should generally extend FieldMetadataProviderAdapter.
Author:
Chris Kittrell

  • Method Details

    • addTabAndGroupMetadata

      MetadataProviderResponse addTabAndGroupMetadata(AddMetadataRequest addMetadataRequest, Map<String,TabMetadata> metadata)
      Contribute to metadata inspection for the Field instance in the request. Implementations should add values to the metadata parameter.
      Parameters:
      addMetadataRequest - contains the requested field and support classes.
      metadata - implementations should add metadata for the requested field here
      Returns:
      whether or not this implementation adjusted metadata

    • overrideMetadataViaAnnotation

      MetadataProviderResponse overrideMetadataViaAnnotation(OverrideViaAnnotationRequest overrideViaAnnotationRequest, Map<String,TabMetadata> metadata)
      Contribute to metadata inspection for the entity in the request. Implementations should override values in the metadata parameter.
      Parameters:
      overrideViaAnnotationRequest - contains the requested entity and support classes.
      metadata - implementations should override metadata here
      Returns:
      whether or not this implementation adjusted metadata

    • overrideMetadataViaXml

      MetadataProviderResponse overrideMetadataViaXml(OverrideViaXmlRequest overrideViaXmlRequest, Map<String,TabMetadata> metadata)
      Contribute to metadata inspection for the ceiling entity and config key. Implementations should override values in the metadata parameter.
      Parameters:
      overrideViaXmlRequest - contains the requested config key, ceiling entity and support classes.
      metadata - implementations should override metadata here
      Returns:
      whether or not this implementation adjusted metadata

    • addTabAndGroupMetadataFromCmdProperties

      MetadataProviderResponse addTabAndGroupMetadataFromCmdProperties(ClassMetadata cmd, Map<String,TabMetadata> metadata)
      Parameters:
      cmd -
      metadata -
      Returns:
      whether or not this implementation adjusted metadata

    • lateStageAddEntityMetadata

      MetadataProviderResponse lateStageAddEntityMetadata(LateStageAddMetadataRequest lateStageAddMetadataRequest, Map<String,TabMetadata> metadata)
      Contribute to metadata inspection for the Field instance in the request. Implementations should add values to the metadata parameter.

      This method differs from addTabAndGroupMetadata(AddMetadataRequest, Map) in that it will be invoked after the cacheable properties are assembled. It is therefore useful in scenarios where you may want to contribute properties to metadata that are dynamic and should not be cached normally.

      Parameters:
      lateStageAddMetadataRequest - contains the requested field name and support classes.
      metadata - implementations should add metadata for the requested field here
      Returns:
      whether or not this implementation adjusted metadata

    • addEntityMetadataFromMappingData

      MetadataProviderResponse addEntityMetadataFromMappingData(AddMetadataFromMappingDataRequest addMetadataFromMappingDataRequest, TabMetadata metadata)
      Contribute to metadata inspection using Hibernate column information. Implementations should impact values in the metadata parameter.
      Parameters:
      addMetadataFromMappingDataRequest - contains the requested Hibernate type and support classes.
      metadata - implementations should impact values for the metadata for the field here
      Returns:
      whether or not this implementation adjusted metadata