Fix checkstyle

kitodo · Apr 23, 2024 · 2cb18f1 · 2cb18f1
1 parent ececb2a
commit 2cb18f1
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 19 deletions.
diff --git a/.../java/org/kitodo/production/services/data/interfaces/DatabaseProcessServiceInterface.java b/.../java/org/kitodo/production/services/data/interfaces/DatabaseProcessServiceInterface.java
@@ -85,16 +85,15 @@ Long countResults(Map<?, String> filters, boolean showClosedProcesses, boolean s
      * If <i>batchMaxSize</i> is configured, at most the configured number of
      * processes will be returned.
      * 
+     * <!-- To replace the existing search functionality in
+     * BatchForm.filterProcesses(). -->
+     * 
      * @param processfilter
      *            substring to search
      * @return all processes whose names contain the comparison string
      * @throws DAOException
      *             in the event of a database connection error
      */
-    /*
-     * To replace the existing search functionality in
-     * BatchForm.filterProcesses().
-     */
     default List<Process> filterProcesses(String processfilter) throws DAOException {
         int batchMaxSize = ConfigCore.getIntParameter(ParameterCore.BATCH_DISPLAY_LIMIT, -1);
         String query = "FROM Process WHERE title LIKE '%" + processfilter + "%'"
@@ -260,14 +259,13 @@ List<ProcessInterface> findLinkableParentProcesses(String searchInput, int proje
      * <b>Implementation Requirements:</b><br>
      * This function requires that the thread is assigned to a logged-in user.
      *
+     * <!-- Used to check whether a process identifier is already in use. In
+     * both places, the result is only checked for > 0. -->
+     *
      * @param title
      *            process name to be searched for
      * @return number of processes with this title
      */
-    /*
-     * Used to check whether a process identifier is already in use. In both
-     * cases, the result is only checked for > 0.
-     */
     default Long findNumberOfProcessesWithTitle(String title) throws DataException {
         int sessionClientId = ServiceManager.getUserService().getSessionClientId();
         String query = "FROM Process process WHERE process.title = '" + title + "' "
@@ -399,6 +397,9 @@ default String getProcessDataDirectory(ProcessInterface process) {
     /**
      * Sets the record number of the process into the processBaseUri field. Can
      * also save the process.
+     * 
+     * <!-- Since the moment this was introduced, I've never understood why this
+     * exists. Nor why property processBaseUri exists at all. See #5856 -->
      *
      * @param process
      *            process for which the data record number should be placed in
@@ -407,10 +408,6 @@ default String getProcessDataDirectory(ProcessInterface process) {
      *            whether the process should <b>not</b> be saved
      * @return the record number in a URI object
      */
-    /*
-     * Since the moment this was introduced, I've never understood why this
-     * exists. Nor why property processBaseUri exists at all. See #5856
-     */
     default URI getProcessDataDirectory(Process process, boolean forIndexingAll) {
         try {
             Integer id = process.getId();
@@ -488,8 +485,7 @@ default List<Process> getTemplateProcesses() throws DataException, DAOException
      *            maximum number of objects to return
      * @param sortField
      *            by which column the data should be sorted. Must not be
-     *            {@code null} or empty.
-     *            <p>
+     *            {@code null} or empty.<br>
      *            One of:<br>
      *            <ul>
      *            <li>"id": ID</li>

diff --git a/...ain/java/org/kitodo/production/services/data/interfaces/DatabaseTaskServiceInterface.java b/...ain/java/org/kitodo/production/services/data/interfaces/DatabaseTaskServiceInterface.java
@@ -227,8 +227,7 @@ Long countResults(Map<?, String> filters, boolean onlyOwnTasks, boolean hideCorr
      *            maximum number of objects to return
      * @param sortField
      *            by which column the data should be sorted. Must not be
-     *            {@code null} or empty.
-     *            <p>
+     *            {@code null} or empty.<br>
      *            One of:<br>
      *            <ul>
      *            <li>"title.keyword": Title</li>

diff --git a/...n/java/org/kitodo/production/services/data/interfaces/SearchDatabaseServiceInterface.java b/...n/java/org/kitodo/production/services/data/interfaces/SearchDatabaseServiceInterface.java
@@ -23,7 +23,7 @@
 import org.primefaces.model.SortOrder;
 
 /**
- * Specifies the functions of the Search Database Service
+ * Specifies the functions of the Search Database Service.
  * 
  * @param <T>
  *            type of database objects
@@ -162,8 +162,20 @@ public interface SearchDatabaseServiceInterface<T extends BaseBean> {
      * @param limit
      *            maximum number of objects to return
      * @param sortField
-     *            by which column the data should be sorted
-     *            <!-- TODO: clarify what is passed here, what if no sorting is selected -->
+     *            by which column the data should be sorted. Must not be
+     *            {@code null} or empty.<br>
+     *            One of:<br>
+     *            <ul>
+     *            <li>"title.keyword": Title [docket, ruleset, process template,
+     *            and workflow]</li>
+     *            <li>"file.keyword": File [docket, and ruleset]</li>
+     *            <li>"orderMetadataByRuleset": Order metadata as in ruleset
+     *            (otherwise alphabetically) [only ruleset]</li>
+     *            <li>"ruleset.title.keyword": Ruleset [only process
+     *            template]</li>
+     *            <li>"active": Active [only process template]</li>
+     *            <li>"status": Status [only workflow]</li>
+     *            </ul>
      * @param sortOrder
      *            sort ascending or descending?
      * @param filters