remove unused property path
[cdmlib.git] / cdmlib-services / src / main / java / eu / etaxonomy / cdm / api / service / IClassificationService.java
index 117e3be6d59d6b6e6857208646a5649ac4747997..2ce702aee90d59e357362bba55892ed7b36fc28c 100644 (file)
@@ -19,17 +19,16 @@ import eu.etaxonomy.cdm.api.service.config.TaxonDeletionConfigurator;
 import eu.etaxonomy.cdm.api.service.dto.GroupedTaxonDTO;
 import eu.etaxonomy.cdm.api.service.dto.TaxonInContextDTO;
 import eu.etaxonomy.cdm.api.service.pager.Pager;
+import eu.etaxonomy.cdm.compare.taxon.TaxonNodeSortMode;
 import eu.etaxonomy.cdm.exception.FilterException;
 import eu.etaxonomy.cdm.exception.UnpublishedException;
 import eu.etaxonomy.cdm.model.common.MarkerType;
 import eu.etaxonomy.cdm.model.media.MediaRepresentation;
 import eu.etaxonomy.cdm.model.name.Rank;
-import eu.etaxonomy.cdm.model.reference.Reference;
 import eu.etaxonomy.cdm.model.taxon.Classification;
 import eu.etaxonomy.cdm.model.taxon.ITaxonTreeNode;
 import eu.etaxonomy.cdm.model.taxon.Taxon;
 import eu.etaxonomy.cdm.model.taxon.TaxonNode;
-import eu.etaxonomy.cdm.model.taxon.TaxonRelationshipType;
 import eu.etaxonomy.cdm.persistence.dto.ClassificationLookupDTO;
 import eu.etaxonomy.cdm.persistence.dto.TaxonNodeDto;
 import eu.etaxonomy.cdm.persistence.dto.UuidAndTitleCache;
@@ -42,15 +41,9 @@ import eu.etaxonomy.cdm.persistence.query.OrderHint;
  */
 public interface IClassificationService extends IIdentifiableEntityService<Classification> {
 
-    /**
-     *
-     * @param uuid
-     * @return
-     */
     public ITaxonTreeNode getTreeNodeByUuid(UUID uuid);
 
     /**
-     *
      * Returns the root node of the the given classification (specified by its UUID)
      * @param classificationUuid the uuid of the classification
      * @return the root node of the classification
@@ -59,23 +52,6 @@ public interface IClassificationService extends IIdentifiableEntityService<Class
 
     public UUID getTaxonNodeUuidByTaxonUuid(UUID classificationUuid, UUID taxonUuid);
 
-    /**
-     * Clones an existing classification including all taxa and taxon nodes.
-     * @param name
-     * @param sec
-     * @param relationshipType
-     * @return
-     */
-    public UpdateResult cloneClassification(UUID classificationUuid, String name, Reference sec, TaxonRelationshipType relationshipType);
-
-    /**
-     *
-     * @param limit
-     * @param start
-     * @param orderHints
-     * @param propertyPaths
-     * @return
-     */
     public List<Classification> listClassifications(Integer limit, Integer start, List<OrderHint> orderHints, List<String> propertyPaths);
 
     /**
@@ -259,7 +235,7 @@ public interface IClassificationService extends IIdentifiableEntityService<Class
             Integer pageSize, Integer pageIndex, List<String> propertyPaths) throws FilterException;
 
     public List<TaxonNodeDto> listChildNodeDtosOfTaxon(UUID taxonUuid, UUID classificationUuid, UUID subtreeUuid, boolean includeUnpublished,
-            Integer pageSize, Integer pageIndex, TaxonNodeDtoSortMode comparator, List<String> propertyPaths) throws FilterException;
+            Integer pageSize, Integer pageIndex, TaxonNodeDtoSortMode comparator) throws FilterException;
 
     /**
      * @param taxonNode
@@ -270,35 +246,12 @@ public interface IClassificationService extends IIdentifiableEntityService<Class
     @Deprecated
     public List<TaxonNode> loadChildNodesOfTaxonNode(TaxonNode taxonNode, List<String> propertyPaths);
 
-    /**
-     *
-     * @param classification
-     * @return
-     */
     public List<UuidAndTitleCache<TaxonNode>> getTaxonNodeUuidAndTitleCacheOfAcceptedTaxaByClassification(Classification classification);
 
+    //FIXME seems not to be used anymore
     public Map<UUID, List<MediaRepresentation>> getAllMediaForChildNodes(TaxonNode taxonNode, List<String> propertyPaths, int size, int height, int widthOrDuration, String[] mimeTypes);
 
     /**
-     *
-     * @param taxonNode
-     * @return
-     * @deprecated use TaxonNodeService instead
-     */
-    @Deprecated
-    public UUID removeTaxonNode(TaxonNode taxonNode);
-
-    /**
-     *
-     * @param taxonNode
-     * @return
-     * @deprecated use TaxonNodeService instead
-     */
-    @Deprecated
-    public UUID saveTaxonNode(TaxonNode taxonNode);
-
-    /**
-     *
      * @param taxonNodeCollection
      * @return
      * @deprecated use TaxonNodeService instead
@@ -337,79 +290,36 @@ public interface IClassificationService extends IIdentifiableEntityService<Class
      * The highter taxon is defined by rank where the lowest rank equal or above minRank
      * is taken. If maxRank <> null and no taxon exists with minRank <= rank <= maxRank
      * no higher taxon is returned for this taxon.
-     *
-     * @param taxonUuids
-     * @param minRank
-     * @param maxRank
-     * @return
      */
     public List<GroupedTaxonDTO> groupTaxaByHigherTaxon(List<UUID> taxonUuids, UUID classificationUuid, Rank minRank, Rank maxRank);
 
-    /**
-     * @param taxonUuids
-     * @param classificationUuid
-     * @param markerType
-     * @param value
-     * @return
-     */
     public List<GroupedTaxonDTO> groupTaxaByMarkedParents(List<UUID> taxonUuids, UUID classificationUuid,
             MarkerType markerType, Boolean value);
 
-
     /**
      * Returns the most relevant data of a taxon/taxon node, including children, synonyms
      * and certain ancestors if required.
-     * @param classificationUuid
-     * @param taxonUuid
-     * @param doSynonyms
-     * @param includeUnpublished
-     * @param ancestorMarkers
-     * @return
      */
     public TaxonInContextDTO getTaxonInContext(UUID classificationUuid, UUID taxonUuid,
             Boolean doChildren, Boolean doSynonyms, boolean includeUnpublished, List<UUID> ancestorMarkers,
             TaxonNodeSortMode sortMode);
 
-    /**
-     * @param classification
-     * @return
-     */
     public UUID saveClassification(Classification classification);
 
-    /**
-     * @param classificationUuid
-     * @param limit
-     * @param pattern
-     * @param searchForClassifications
-     * @return
-     */
     public List<UuidAndTitleCache<TaxonNode>> getTaxonNodeUuidAndTitleCacheOfAcceptedTaxaByClassification(
             UUID classificationUuid, Integer limit, String pattern, boolean searchForClassifications);
 
-    /**
-     * @param classification
-     * @param limit
-     * @param pattern
-     * @param searchForClassifications
-     * @return
-     */
     public List<UuidAndTitleCache<TaxonNode>> getTaxonNodeUuidAndTitleCacheOfAcceptedTaxaByClassification(
             Classification classification, Integer limit, String pattern, boolean searchForClassifications);
 
-    /**
-     * @param classificationUuid
-     * @param searchForClassifications
-     * @return
-     */
     public List<UuidAndTitleCache<TaxonNode>> getTaxonNodeUuidAndTitleCacheOfAcceptedTaxaByClassification(
             UUID classificationUuid, boolean searchForClassifications);
 
-    /**
-     * @param classification
-     * @param searchForClassifications
-     * @return
-     */
     public List<UuidAndTitleCache<TaxonNode>> getTaxonNodeUuidAndTitleCacheOfAcceptedTaxaByClassification(
             Classification classification, boolean searchForClassifications);
 
+    List<UuidAndTitleCache<TaxonNode>> getTaxonNodeUuidAndTitleCacheOfAcceptedTaxaByClassification(
+            UUID classificationUuid, Integer limit, String pattern, boolean searchForClassifications,
+            boolean includeDoubtful);
+
 }