View Javadoc
1   /*
2    * Copyright 2012-2025 CodeLibs Project and the Others.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
13   * either express or implied. See the License for the specific language
14   * governing permissions and limitations under the License.
15   */
16  package org.codelibs.fess.app.web.thumbnail;
17  
18  import java.util.HashMap;
19  import java.util.Map;
20  
21  import org.lastaflute.web.validation.Required;
22  
23  import jakarta.validation.constraints.Size;
24  
25  /**
26   * Form class for thumbnail request parameters.
27   * Contains the document ID and query parameters needed to retrieve thumbnail images.
28   */
29  public class ThumbnailForm {
30  
31      /**
32       * The document ID for which to retrieve the thumbnail.
33       */
34      @Required
35      @Size(max = 100)
36      public String docId;
37  
38      /**
39       * The query ID associated with the search request.
40       */
41      @Required
42      public String queryId;
43  
44      /**
45       * The search query string for error page display.
46       */
47      public String q;
48  
49      /**
50       * The number of search results per page for error page display.
51       */
52      public String num;
53  
54      /**
55       * The sort criteria for search results for error page display.
56       */
57      public String sort;
58  
59      /**
60       * The language setting for error page display.
61       */
62      public String lang;
63  
64      /**
65       * Additional search fields for error page display.
66       */
67      public Map<String, String[]> fields = new HashMap<>();
68  
69      /**
70       * Default constructor for ThumbnailForm.
71       */
72      public ThumbnailForm() {
73          // Default constructor
74      }
75  }