cdmlib-services/src/main/java/eu/etaxonomy/cdm/api/service/IWorkingSetService.java

   1 package eu.etaxonomy.cdm.api.service;
   2
   3 import java.util.List;
   4 import java.util.Map;
   5 import java.util.Set;
   6
   7 import eu.etaxonomy.cdm.model.description.DescriptionBase;
   8 import eu.etaxonomy.cdm.model.description.DescriptionElementBase;
   9 import eu.etaxonomy.cdm.model.description.Feature;
  10 import eu.etaxonomy.cdm.model.description.WorkingSet;
  11 import eu.etaxonomy.cdm.persistence.query.OrderHint;
  12
  13 public interface IWorkingSetService extends IAnnotatableService<WorkingSet> {
  14         /**
  15          * Returns a Map of descriptions each with the descriptionelements that match the supplied features (or all description elements if no features are supplied)
  16          *
  17          * @param workingSet the working set which the descriptions belong to
  18          * @param features restrict the returned description elements to those which have features in this set
  19          * @param pageSize The maximum number of descriptions returned (can be null for all descriptions that belong to the working set)
  20          * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based,
  21          *                   can be null, equivalent of starting at the beginning of the recordset). Descriptions are sorted by titleCache
  22          * @param propertyPaths properties to be initialized (applied to the descriptionElements)
  23          * @return
  24          */
  25         public Map<DescriptionBase, Set<DescriptionElementBase>> getDescriptionElements(WorkingSet workingSet, Set<Feature> features, Integer pageSize, Integer pageNumber,     List<String> propertyPaths);
  26
  27 }