Package io.jmix.core

Interface FetchPlanRepository

All Known Implementing Classes:
FetchPlanRepositoryImpl
public interface FetchPlanRepository
Represents a repository of shared FetchPlan objects, accessible by names.
Repository contains all fetch plans defined in XML and deployed at runtime.

  • Method Details

    • getFetchPlan

      FetchPlan getFetchPlan(Class<?> entityClass, String name)
      Get fetch plan for an entity.
      Parameters:
      entityClass - entity class
      name - fetch plan name
      Returns:
      fetch plan instance. Throws FetchPlanNotFoundException if not found.

    • getFetchPlan

      FetchPlan getFetchPlan(MetaClass metaClass, String name)
      Get FetchPlan for an entity.
      Parameters:
      metaClass - entity class
      name - fetch plan name
      Returns:
      fetch plan instance. Throws FetchPlanNotFoundException if not found.

    • findFetchPlan

      @Nullable FetchPlan findFetchPlan(MetaClass metaClass, String name)
      Searches for a FetchPlan for an entity.
      Parameters:
      metaClass - entity class
      name - fetch plan name
      Returns:
      fetch plan instance or null if no fetch plan found

    • getFetchPlanNames

      Collection<String> getFetchPlanNames(MetaClass metaClass)
      Returns names of fetch plans defined for the metaClass
      Parameters:
      metaClass - entity class
      Returns:
      names of fetch plans

    • getFetchPlanNames

      Collection<String> getFetchPlanNames(Class<?> entityClass)
      Returns names of fetch plans defined for the entityClass
      Parameters:
      entityClass - entity class
      Returns:
      names of fetch plans