Package de.hybris.platform.regioncache.region

Interface CacheRegionProvider

  • All Known Implementing Classes:
    DefaultCacheRegionProvider
    public interface CacheRegionProvider
    Class keeps region lists and provides region list access methods.

    • Method Detail

      • getAllRegions

        java.util.List<CacheRegion> getAllRegions()
        Returns immutable collections of ALL regions (manual and regular)

      • getRegions

        java.util.List<CacheRegion> getRegions()
        Returns all non-manual regions.

      • getRegionsForType

        java.util.List<CacheRegion> getRegionsForType​(java.lang.Object typeCode)
        returns collection of regions handling type given.

      • getRegionForAllTypes

        CacheRegion getRegionForAllTypes()
        Get single region able to handle all types.
        It is necessary to resolve specific type first. If it cannot be done all-type-region shall be used.
        Multiple all-type regions is configuration error.

      • getRegionByName

        java.util.List<CacheRegion> getRegionByName​(java.lang.String name)
        returns singleton collection for region of name given.
        It is convenience method not to create collection by a region resolver.

      • getQueryRegions

        java.util.List<CacheRegion> getQueryRegions()
        returns regions handling __QUERY_CACHE__

      • getManualRegion

        CacheRegion getManualRegion​(java.lang.String name)
        Returns manual region of name given or NULL.

      • getManualRegions

        java.util.Collection<CacheRegion> getManualRegions()
        Returns all manual regions.