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.admin.elevateword;
17
18 import org.lastaflute.web.validation.Required;
19 import org.lastaflute.web.validation.theme.conversion.ValidateTypeFailure;
20
21 import jakarta.validation.constraints.Size;
22
23 /**
24 * Form class for editing elevate word configurations in the admin interface.
25 * This form extends CreateForm to include fields necessary for updating existing elevate word entries,
26 * including tracking information for optimistic locking and audit trails.
27 * Elevate words are used to boost specific documents in search results when certain keywords are matched.
28 *
29 */
30 public class EditForm extends CreateForm {
31
32 /**
33 * Creates a new EditForm instance.
34 */
35 public EditForm() {
36 super();
37 }
38
39 /**
40 * The unique identifier of the elevate word configuration being edited.
41 * This is a required field for identifying which elevate word entry to update.
42 */
43 @Required
44 @Size(max = 1000)
45 public String id;
46
47 /**
48 * The username of the user who last updated this elevate word configuration.
49 * Used for audit trail purposes to track who made changes.
50 */
51 @Size(max = 1000)
52 public String updatedBy;
53
54 /**
55 * The timestamp when this elevate word configuration was last updated.
56 * Stored as a long value representing milliseconds since epoch.
57 * Used for audit trail and concurrency control.
58 */
59 @ValidateTypeFailure
60 public Long updatedTime;
61
62 /**
63 * The version number of the elevate word configuration for optimistic locking.
64 * This field is required to prevent concurrent modification conflicts
65 * by ensuring the configuration hasn't been modified by another process.
66 */
67 @Required
68 @ValidateTypeFailure
69 public Long versionNo;
70
71 }