Package com.broadleafcommerce.sandbox.provider

Interface BatchIndexable

All Known Implementing Classes:
JpaChangeSummary
public interface BatchIndexable
Summary entity that is aware of state related to index status and index target. Related to the processing of Indexable entities.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    TRANSITION_MARKER
     

  • Method Summary

    Modifier and Type
    Method
    Description
    com.broadleafcommerce.data.tracking.core.filtering.domain.Tracking
    getChangeTracking()
    The change tracking information for the indexable item.
    String
    getIndexableTargetId()
    The id of the item being targeted for indexing.
    String
    getIndexableType()
    Retrieve the type that is being indexed.
    String
    getSandbox()
    The sandbox for the indexable item.
    String
    getTransitionMarker()
    A marker id that identifies a change summary as part of a transition batch.
    boolean
    isIndexableProcessed()
    Whether or not the system has acknowledged that indexing has been requested for this item.

  • Field Details

  • Method Details

    • getIndexableType

      String getIndexableType()
      Retrieve the type that is being indexed. String representation of BatchIndexableType.
      Returns:
      The type that is being indexed

    • getIndexableTargetId

      String getIndexableTargetId()
      The id of the item being targeted for indexing.
      Returns:
      The id of the item being targeted for indexing.

    • isIndexableProcessed

      boolean isIndexableProcessed()
      Whether or not the system has acknowledged that indexing has been requested for this item.
      Returns:
      Whether or not indexing has been requested.

    • getTransitionMarker

      String getTransitionMarker()
      A marker id that identifies a change summary as part of a transition batch.
      Returns:
      A marker id that identifies a change summary as part of a transition batch.

    • getChangeTracking

      com.broadleafcommerce.data.tracking.core.filtering.domain.Tracking getChangeTracking()
      The change tracking information for the indexable item. See ChangeSummary.getChangeTracking().
      Returns:
      The change tracking information for the indexable item

    • getSandbox

      String getSandbox()
      The sandbox for the indexable item. See ChangeSummary.getSandbox().
      Returns:
      The sandbox for the indexable item